Github

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.

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",
    "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
        }
    ]
}



Language
Credentials
Header
Click Try It! to start a request and see the response here!