Criar cobrança

Esse endpoint permite criar cobranças de Cartão de Crédito, Pix e Boleto Bancário.

ℹ️

Antes de usar este endpoint, recomendamos fortemente que você leia:

Elas trazem detalhes essenciais sobre o ciclo de vida da transação, tipos de cobrança, campos obrigatórios, regras de expiração, devoluções (estornos), configurações de webhook e muito mais.

Entender esses pontos evita erros comuns na integração e garante que você aproveite todo o potencial da API com segurança e conformidade.


ℹ️

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.

🚧

As transações de PIX não possuem ambiente de Sandbox.


Exemplos de Payload

{
    "IsSandbox": true,
    "Application": "Aplicação de teste",
    "Vendor": "João da Silva",
    "CallbackUrl": "https://callbacks.exemplo.com.br/api/Notify",
    "PaymentMethod": "1",
    "Reference": "TESTE",
    "Customer": {
        "Name": "TECIDOS FARIA DUARTE",
        "Identity": "74910037000193",
        "Phone": "51999999999",
        "Email": "[email protected]",
        "Address": {
            "ZipCode": "90670090",
            "Street": "Logradouro",
            "Number": "123",
            "Complement": "Complemento",
            "District": "Higienopolis",
            "CityName": "Porto Alegre",
            "StateInitials": "RS",
            "CountryName": "Brasil"
        }
    },
    "Products": [
        {
            "Code": "001",
            "Description": "Produto ou serviço 1",
            "UnitPrice": 100.00,
            "Quantity": 1
        },
        {
            "Code": "002",
            "Description": "Produto ou serviço 2",
            "UnitPrice": 99.99,
            "Quantity": 1
        }
    ],
    "PaymentObject": {
        "DueDate": "30/12/2025",
        "Instruction": "Instrução de Exemplo",
        "CancelAfterDue": false,
        "DaysBeforeCancel": 10,
        "Message": [
            "Mensagem 1",
            "Mensagem 2",
            "Mensagem 3"
        ],
        "PenaltyRate": 2,
        "InterestRate": 1,
        "IsEnablePartialPayment": false,
        "DiscountType": "1",
        "DiscountAmount": 10,
        "DiscountDue": "29/12/2025"
    }
}
{
    "IsSandbox": true,
    "Application": "Aplicação de teste",
    "Vendor": "João da Silva",
    "CallbackUrl": "https://callbacks.exemplo.com.br/api/Notify",
    "PaymentMethod": "2",
    "Reference": "TESTE",
    "Customer": {
        "Name": "TECIDOS FARIA DUARTE",
        "Identity": "74910037000193",
        "Phone": "51999999999",
        "Email": "[email protected]",
        "Address": {
            "ZipCode": "90670090",
            "Street": "Logradouro",
            "Number": "123",
            "Complement": "Complemento",
            "District": "Higienopolis",
            "CityName": "Porto Alegre",
            "StateInitials": "RS",
            "CountryName": "Brasil"
        }
    },
    "Products": [
        {
            "Code": "001",
            "Description": "Produto ou serviço 1",
            "UnitPrice": 100,
            "Quantity": 1
        }
    ],
    "PaymentObject": {
        "Token": "812fbe6e044f4d0286e2b297736043eb",
        "InstallmentQuantity": 5
        /*"ExternalAuthentication": {
            "Cavv": "",
            "Xid": "",
            "Eci": "",
            "Version": "",
            "ReferenceId": ""
        },
        "Holder": "João da Silva",
        "CardNumber": "5105105105105100",
        "ExpirationDate": "12/2026",
        "SecurityCode": "241",*/
    }
}
{
    "IsSandbox": false,
    "Application": "Aplicação de teste",
    "Vendor": "João da Silva",
    "CallbackUrl": "https://callbacks.exemplo.com.br/api/Notify",
    "PaymentMethod": "6",
    "Reference": "TESTE",
    "Customer": {
        "Name": "TECIDOS FARIA DUARTE",
        "Identity": "74910037000193",
        "Phone": "51999999999",
        "Email": "[email protected]",
        "Address": {
            "ZipCode": "90670090",
            "Street": "Logradouro",
            "Number": "123",
            "Complement": "Complemento",
            "District": "Higienopolis",
            "CityName": "Porto Alegre",
            "StateInitials": "RS",
            "CountryName": "Brasil"
        }
    },
    "PaymentObject": {
        "Expiration": 600 // prazo de expiração em segundos
    },
    "Products": [
        {
            "Code": "001",
            "Description": "Produto ou serviço 1",
            "UnitPrice": 150.00,
            "Quantity": 1
        },
        {
            "Code": "002",
            "Description": "Produto ou serviço 2",
            "UnitPrice": 50.00,
            "Quantity": 1
        }
    ]
}



Body Params
string
required

Informar o código do método de pagamento. Clique aqui para conferir os métodos disponíveis.

boolean
required

Identifica se a transação vai ser realizada em ambiente sandbox ou não.

string
required

Use para identificar suas aplicações nas transações.

Customer
object
required

Dados do comprador.

Products
array of objects
required

Lista dos produtos nessa transação.

Products*
PaymentObject
object
required

Configuração específica dos métodos de pagamento (Boleto, Carão de Crédito e Pix)

string

URL de notificações de mudança de status da transação.

string

Use para enviar o IP (v4 ou v6) do cliente. Ex: 200.200.200.200

string

Nome do vendedor que será vinculado a essa transação. Ex: João da Silva

string

Use para identificar suas transações. Ex: REFERENCIA_TESTE_V1

Splits
array of objects
Splits
string

Use para informar o identificador gerado pelo script antifraude. (Esse atributo pode ser utilizado quando o método de pagamento for Cartão de Crédito - PaymentMethod = 2)

boolean

Use para identificar se a transação deve ou não passar pela análise do antifraude. No seu painel deve estar sinalizado que a análise será "por transação". Ao enviar como falso, você está assumindo o risco de chargeback. (Esse atributo pode ser utilizado quando o método de pagamento for Cartão de Crédito - PaymentMethod = 2) Para utilizar o script antifraude em seu site clique aqui.

Responses

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