Criar link de cobrança

Esse endpoint permite a criação de um link de venda que possa ser enviado para o seu cliente.

⚠️

Este endpoint não possui ambiente em Sandbox.

ℹ️

Suporte a CNPJ alfanumérico

A Receita Federal iniciará a emissão de CNPJs alfanuméricos a partir de julho de 2026. Essa mudança se aplica exclusivamente a novas inscrições, não havendo alterações nos CNPJs já existentes.

A Safe2Pay estará apta a processar e receber CNPJs alfanuméricos a partir da entrada em vigor dessa mudança, incluindo integrações com adquirentes que suportam esse formato, como a Cielo.

Não serão necessárias alterações na integração da API da Safe2Pay.

Recomendamos, no entanto, que integradores e estabelecimentos revisem seus sistemas próprios (checkout, ERP, antifraude e validações cadastrais) para garantir compatibilidade com o novo padrão, especialmente para:

  • Aceitar caracteres alfanuméricos nos campos de CNPJ;
  • Evitar validações restritas apenas a números;
  • Revisar máscaras e expressões regulares utilizadas na validação do documento.
{
    "Customer": {
        "Address": {
            "Street": "Logradouro",
            "Number": "123",
            "District": "Higienopolis",
            "ZipCode": "90670090",
            "Complement": "Complemento",
            "CityName": "Porto Alegre",
            "StateInitials": "RS",
            "CountryName": "Brasil"
        },
        "Identity": "74910037000193",
        "Name": "TECIDOS FARIA DUARTE",
        "Email": "[email protected]",
        "Phone": "51999999999"
    },
    "Products": [
        {
            "Description": "Produto ou serviço 1",
            "Quantity": "1",
            "UnitPrice": "10.00"
        }
    ],
    "PaymentMethods": [
        {
            "CodePaymentMethod": "1" // Boleto
        },
        {
            "CodePaymentMethod": "2" // Crédito
        },
        {
            "CodePaymentMethod": "6" // Pix
        }
    ],
    "DueDate": "2025-12-31",
    "Instruction": "Instrução",
    "Messages": [
        "Mensagem 1",
        "Mensagem 2"
    ],
    "Reference": "TESTE",
    "PenaltyAmount": "2.00",
    "InterestAmount": "1.00",
    "Emails": [ // Emails que receberão a cobrança
        "[email protected]"
    ],
    "CallbackUrl": "https://webhook.site/8161f4bd-d850-4c53-9934-c86a50e6910b"
}

Body Params
PaymentMethods
array of objects
required

Grupo de dados com as informações de formas de pagamento permitidas.

PaymentMethods*
Customer
object
required

Dados do comprador.

Products
array of objects
required

Lista dos produtos nessa transação.

Products*
string
Defaults to 2025-12-31

Data de expiração da cobrança.

Emails
array of strings
required
Emails*
string
Defaults to ABC345

Referência da cobrança.

string

URL de notificação de mudança de status.

string

Data de vencimento para boleto. Ex: 2018-01-08 (válido somente para vendas com boleto)

string

Instruções que serão impressas no Boleto. Ex: Instrução de exemplo (válido somente para vendas com boleto)

Messages
array of strings

Mensagens que serão impressas no Boleto. Informar uma lista de até 9 Strings. (válido somente para vendas com boleto)

Messages
double

Multa em percentual cobrada após o vencimento. (válido somente para vendas com boleto)

double

Taxa de juros em percentual por mês cobrada após o vencimento. Ex: 2.00 (válido somente para vendas com boleto)

integer

Número de parcelas permitidas para o link de cobrança. Caso não seja enviado, o padrão será o que estiver definido para a conta. Ex: 03 (válido somente para vendas com cartão de crédito)

boolean

Aplicar juros na cobrança via cartão de crédito. Juros definidos no painel da Safe2Pay.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json