Criar boleto

curl --location 'https://apisandbox.delbank.com.br/baas/v1/charges' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "BANKSLIP_PIX",
    "correlationId": "{{$guid}}",
    "yourNumber": "PED-2024-001",
    "dueDate": "2025-12-30",
    "Amount": 150.00,
    "payer": {
        "name": "João Alves",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    }
}'

{
    "type": "BANKSLIP_PIX",
    "correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
    "amount": 150.00,
    "walletNumber": "112",
    "yourNumber": "PED-2024-001",
    "ourNumber": "00000532665",
    "dueDate": "2025-12-30T23:59:59.999Z",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6007ARACAJU62070503***63045ED1",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "barCode": "43599110300000000100001112000001700000532665",
    "digitableLine": "43590001161200000170600005326657911030000000010",
    "payer": {
        "name": "JOÃO ALVES",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    },
    "status": "Pending",
    "payments": [],
    "createdAt": "2025-02-05T20:59:24.019Z",
    "updatedAt": "2025-02-05T20:59:25.016Z"
}

POST

baas

charges

curl --location 'https://apisandbox.delbank.com.br/baas/v1/charges' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "BANKSLIP_PIX",
    "correlationId": "{{$guid}}",
    "yourNumber": "PED-2024-001",
    "dueDate": "2025-12-30",
    "Amount": 150.00,
    "payer": {
        "name": "João Alves",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    }
}'

{
    "type": "BANKSLIP_PIX",
    "correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
    "amount": 150.00,
    "walletNumber": "112",
    "yourNumber": "PED-2024-001",
    "ourNumber": "00000532665",
    "dueDate": "2025-12-30T23:59:59.999Z",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6007ARACAJU62070503***63045ED1",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "barCode": "43599110300000000100001112000001700000532665",
    "digitableLine": "43590001161200000170600005326657911030000000010",
    "payer": {
        "name": "JOÃO ALVES",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    },
    "status": "Pending",
    "payments": [],
    "createdAt": "2025-02-05T20:59:24.019Z",
    "updatedAt": "2025-02-05T20:59:25.016Z"
}

Para o passo a passo completo, veja o guia Emitir Boleto.

Headers

string

required

Sua API key.

string

required

Número da conta Delfinance.

Body

string

required

Tipo do boleto. Valores aceitos: BANKSLIP (convencional) ou BANKSLIP_PIX (com QR Code Pix integrado).

string

required

GUID único para identificação e conciliação do boleto no seu sistema. Deve ser único por boleto.

string

required

Número do documento — identificador do boleto para você. Exibido no documento como referência.

string

Nosso número — identificador do boleto para a Delfinance. Obrigatório apenas para a carteira 121. Não envie para a carteira 112 (gerado automaticamente).

string

required

Data de vencimento no formato YYYY-MM-DD.

number

required

Valor do boleto em reais (ex: 150.00).

object

required

Dados do pagador (sacado).

Show propriedades

string

required

Nome completo ou Razão Social do pagador.

string

required

CPF ou CNPJ do pagador (apenas números).

string

E-mail do pagador.

object

Telefone do pagador.

Show propriedades

string

DDD (ex: "79").

string

Número (ex: "988669383").

object

required

Endereço do pagador.

Show propriedades

string

required

CEP (apenas números).

string

required

Logradouro.

string

required

Bairro.

string

required

Número.

string

Complemento.

string

required

Cidade.

string

required

UF (ex: "SE").

object

Desconto por antecipação (opcional). Até 3 faixas de datas.

Show propriedades

string

required

Tipo: Fixed (valor fixo) ou PERCENTAGE (percentual).

array

required

Array de faixas de desconto (máximo 3 itens).

Show propriedades do item

string

required

Data limite para aplicação do desconto (YYYY-MM-DD). Deve ser anterior ao dueDate.

number

required

Valor ou percentual do desconto.

object

Multa aplicada após o vencimento (opcional).

Show propriedades

string

required

Tipo: Fixed ou Percentage.

string

required

Data a partir da qual a multa é aplicada (YYYY-MM-DD).

number

required

Valor ou percentual da multa.

object

Juros por período após o vencimento (opcional).

Show propriedades

string

required

Tipo: Fixed ou PERCENTAGE.

string

required

Data a partir da qual os juros são aplicados (YYYY-MM-DD).

number

required

Valor ou percentual dos juros.

object

Beneficiário final da cobrança (para gateways e plataformas que emitem em nome de terceiros).

Show propriedades

string

required

Nome ou Razão Social.

string

required

CPF ou CNPJ (apenas números).

object

required

Endereço do beneficiário final.

Show propriedades

string

required

CEP.

string

required

Logradouro.

string

required

Bairro.

string

required

Número.

string

required

Cidade.

string

required

UF.

Response

string

Tipo do boleto: BANKSLIP ou BANKSLIP_PIX.

string

GUID de conciliação.

number

Valor do boleto.

string

Carteira utilizada: "112" ou "121".

string

Número do documento informado.

string

Nosso número (gerado ou informado).

string

Data de vencimento em ISO 8601.

string

Código de barras do boleto.

string

Linha digitável para pagamento.

string

Payload do QR Code Pix. Presente apenas para BANKSLIP_PIX.

string

Imagem do QR Code em base64 (data:image/png;base64,...). Presente apenas para BANKSLIP_PIX.

string

Status inicial: Pending.

array

Lista de pagamentos registrados (vazia na criação).

string

Data/hora de criação em ISO 8601.

string

Data/hora da última atualização em ISO 8601.

curl --location 'https://apisandbox.delbank.com.br/baas/v1/charges' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "type": "BANKSLIP_PIX",
    "correlationId": "{{$guid}}",
    "yourNumber": "PED-2024-001",
    "dueDate": "2025-12-30",
    "Amount": 150.00,
    "payer": {
        "name": "João Alves",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    }
}'

{
    "type": "BANKSLIP_PIX",
    "correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
    "amount": 150.00,
    "walletNumber": "112",
    "yourNumber": "PED-2024-001",
    "ourNumber": "00000532665",
    "dueDate": "2025-12-30T23:59:59.999Z",
    "qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6007ARACAJU62070503***63045ED1",
    "qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "barCode": "43599110300000000100001112000001700000532665",
    "digitableLine": "43590001161200000170600005326657911030000000010",
    "payer": {
        "name": "JOÃO ALVES",
        "document": "07034346593",
        "email": "joao@email.com",
        "phone": { "prefix": "79", "number": "988669383" },
        "address": {
            "zipCode": "49010030",
            "publicPlace": "AV. RIO BRANCO",
            "neighborhood": "CENTRO",
            "number": "186",
            "city": "ARACAJU",
            "state": "SE"
        }
    },
    "status": "Pending",
    "payments": [],
    "createdAt": "2025-02-05T20:59:24.019Z",
    "updatedAt": "2025-02-05T20:59:25.016Z"
}

Introdução

Pix

Boleto

Split de Pagamentos

Webhooks

Headers

Body

Response

​Headers

​Body

​Response

Headers

Body

Response