Pular para o conteúdo principal

Boleto

info

Pagamento de Boleto

📘Siga este link para informações sobre pagamento de boletos: Pagamento de Boletos

Tipos de cobrança

A lista abaixo apresenta os Tipos de Cobrança no Delfinance

BANKSLIP: Boleto bancário convencional

BANKSLIP_PIX: Boleto bancário que contém um QR Code e também pode ser pago usando um método de pagamento Pix

IMPORTANTE: Antes de criar Cobranças do tipo BANKSLIP e BANKSLIP_PIX, será necessário configurar a conta bancária como Emissora de Boleto Bancário Autorizada ou em pt-BR “Cedente”. Observe também que é recomendado usar GUID como correlationId

Você pode solicitar esse ajuste falando com nossa Equipe Operacional pelo e-mail: [email protected].

Especificações Técnicas Gerais

Esta seção tem como objetivo destacar e explicar elementos técnicos comuns a todas as operações/processos.

Além do processo de Autenticação explicado acima, para requisições HTTP, alguns campos que envolvem regras de negócio ou especificações gerais do Delfinance BaaS se destacam.

Below are some fields present in the body of requests and deserve an additional explanation.

  • type - Tipo de Cobrança, anteriormente apresentado, que neste caso deve ser atribuído o valor BANKSLIP;
  • correlationId - corresponde a um identificador que garante a exclusividade daquele Cobrança internamente a um sistema. Este campo reflete o controle interno usado no sistema da entidade que consome esta API, que é, o cliente.
  • ourNumber - você corresponde a um identificador ** para Delfinance ** que permite o monitoramento ou rastreamento de um Cobrança. Este valor será exibido/registrado no Faturamento, e normalmente é apresentado como “Nosso Número”/ “Seu Número”;
  • yourNumber - corresponde a um identificador para o issuer da cobrança, que permite o monitoramento ou rastreamento da cobrança. Este valor também será exibido/registrado na cobrança e será apresentado como “Número do Documento”/ “N° do Documento”.

Delfinance entende que os outros campos não apresentam grandes complexidades ou regras específicas a serem seguidas.

Criação

Criando uma cobrança convencional

Método POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

A Cobrança Normal tem como foco o Título Simplificado que irá refletir na Carteira 112.

The Normal charge focuses on the simplified title that will be reflected in "Wallet 112"*.

Note*: Wallet is the way you choose to issue your bank slip. There are two types of wallets available: wallet 112 and wallet 121.

Given the current Billing category, it is not necessary to send the "outNumber" field, since its creation is the responsibility of Delfinance.

Header da requisição e corpo (body)

Content-Type: application/json
x-delbank-api-key: API Key
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}

Header da resposta e corpo (body)

Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO",
"ourNumber": "00000215634",
"correlationId": "68757f64-486c-41dc-b036-4e8cb5e62576",
"dueDate": "2023-04-01",
"barCode": "43596930700000000100001112000000600000215634",
"digitableLine": "43590001161200000060900002156347693070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T18:16:47.347Z",
"createdAt": "2022-12-07T18:16:47.347Z"
}

Obs.: Solicitações malsucedidas responderão com seu respectivo código HTTP e o seguinte Corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-fa5995742bd8906dfbaf6315d1d57d9e-e8c2cf5c14f5099f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}

Criar uma cobrança expressa

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

A cobrança expressa tem como foco o título gerado pelo cliente, que será refletido em "Carteira 121"*.

OBS.*: A carteira é a forma que você escolher para emitir seu boleto bancário. Existem dois tipos de carteiras disponíveis: carteira 112 e carteira 121.

Diferentemente das** cobranças convencionais**, neste tipo de cobrança é necessário o envio do campo "ourNumber".

Abaixo seguem instruções e um modelo para realização desta operação.

Header da requisição e corpo (body)

Content-Type: application/json
x-delbank-api-key: API Key
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"ourNumber": "00160860733",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}

Header da resposta e corpo (body)

Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO2",
"ourNumber": "00160860733",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",
"dueDate": "2023-04-01",
"barCode": "43591930700000000100001121000000600160860733",
"digitableLine": "43590001162100000060001608607337193070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T21:28:39.663Z",
"createdAt": "2022-12-07T21:28:39.663Z"
}

Obs.: Requisições com falha terão o seguinte HTTP e corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-5d3f8bf7082b9428d8461b504dae9fc0-84ffab015d792b9f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 5 | BytePositionInLine: 25."
]
}
}

Criando um Título com Fiador/Sacador

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

Este endpoint é usado para criar um Título, "Boleto bancário" (BANKSLIP) ou "Boleto bancário pix" (BANKSLIP_PIX) com um Fiador/Sacador (Beneficiário Final).

Header da requisição e corpo (body)

Content-Type: application/json
x-delbank-api-key: API Key
    
{
"type": "BANKSLIP",
"correlationId": "CORRELATIONID",
"yourNumber": "SEUNUMERO",
"ourNumber": "00160860733",
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"finalBeneficiary": {
"name": "fullname",
"document": "document",
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
}
}

Header da resposta e corpo (body)

Content-Type: application/json
{
"type": "BANKSLIP",
"amount": 0.1,
"yourNumber": "SEUNUMERO2",
"ourNumber": "00160860733",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",
"dueDate": "2023-04-01",
"barCode": "43591930700000000100001121000000600160860733",
"digitableLine": "43590001162100000060001608607337193070000000010",
"payer": {
"name": "FULANO CICLANO DA SILVA BELTRANO",
"document": "9999999999",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"status": "Pending",
"updatedAt": "2022-12-07T21:28:39.663Z",
"createdAt": "2022-12-07T21:28:39.663Z"
}

Obs.: Requisições com falha terão o seguinte HTTP e corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-3d4d68882c19524d921cc791e2a5e7ee-166c8e241265c3d3-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 6 | BytePositionInLine: 25."
]
}
}

Criando um Título com Fiador/Sacador

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

Este endpoint é utilizado para criar uma Cobrança do tipo "Boleto Bancário Pix". Nesta modalidade, o **Título **será emitido na Carteira 112

Header da requisição e corpo (body)

Content-Type: application/json
x-delbank-api-key: API Key
{
"type": "BANKSLIP_PIX",
"yourNumber": "SEUNUMERO",
"correlationId": "72b8e755-f620-4667-872f-529a87098d07",//uid único para cada request
"dueDate": "yyyy-mm-dd",
"Amount": 0.1,
"payer": {
"name": "fullname",
"document": "document",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "yyyy-mm-dd",
"amount": 0.01
},
{
"date": "yyyy-mm-dd",
"amount": 0.01
},
{
"date": "yyyy-mm-dd",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "yyyy-mm-dd",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "yyyy-mm-dd",
"amount": 2.5
}
}

Header da resposta e corpo (body)

Content-Type: application/json
{
"type": "BANKSLIP_PIX",
"correlationId": "69577abe-3867-4e0b-85ee-21aa6bc9db9b",
"amount": 0.1,
"walletNumber": "112",
"yourNumber": "SEUNUMERO",
"ourNumber": "00000532665",
"dueDate": "2025-06-05T23:59:59.999Z",
"qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246005204000053039865802BR5907DELBANK6004CITY62070503***63045ED1",
"qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSU",
"barCode": "43599110300000000100001112000001700000532665",
"digitableLine": "43590001161200000170600005326657911030000000010",
"payer": {
"name": "fullname",
"document": "12345678910",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "49000000",
"publicPlace": "public place",
"neighborhood": "neightborhood",
"number": "000",
"complement": "complement",
"city": "city",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-01T00:00:00Z",
"amount": 0.01
},
{
"date": "2025-03-02T00:00:00Z",
"amount": 0.01
},
{
"date": "2025-03-03T00:00:00Z",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-07-03T00:00:00Z",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "2025-07-01T00:00:00Z",
"amount": 2.5
},
"status": "Pending",
"payments": [],
"additionalInfo": [
{
"key": "YourNumber",
"value": "SEUNUMERO"
},
{
"key": "OurNumber",
"value": "00000532665"
},
{
"key": "DigitableLine",
"value": "43590001161200000170600005326657911030000000010"
}
],
"updatedAt": "2025-02-05T20:59:25.0161344Z",
"createdAt": "2025-02-05T20:59:24.0194394Z"
}

Obs.: Requisições com falha terão o seguinte HTTP e corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-61a3e8c33796e9a3ff0af8052db87afc-ea172db465a74b7f-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}

Criando um Título com desconto, multa e atraso no pagamento

HTTP POST

<https://apisandbox.delbank.com.br/baas/v1/charges>

Este endpoint é utilizado para criar uma Cobrança do tipo "Boleto Bancário Pix". Nesta modalidade, o **Título **será emitido na Carteira 112

Request Headers and Body

Content-Type:application/json
x-delbank-api-key:Api Key
{
"type": "BANKSLIP_PIX",
"correlationId": "SEUIDSEUIDSEUID",
"yourNumber": "SEUNUMEROSEU",
"dueDate": "2023-04-01",
"Amount": 0.1,
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2023-03-26",
"amount": 0.01
},
{
"date": "2023-03-27",
"amount": 0.01
},
{
"date": "2023-03-28",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2023-04-02",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "2023-04-02",
"amount": 2.5
}
}

Header da requisição e corpo (body)

Content-Type:application/json
{
"type": "BANKSLIP_PIX",
"correlationId": "f20868e7-1cda-4a61-92fc-b076133123d9",
"amount": 0.1,
"walletNumber": "112",
"yourNumber": "SEUNUMEROSEU",
"ourNumber": "00000532673",
"dueDate": "2026-04-01T23:59:59.999Z",
"qrCode": "00020101021226770014br.gov.bcb.pix2555pix-h.delbank.com.br/v2/cobv/vcharge00000000000003246015204000053039865802BR5907DELBANK6007ARACAJU62070503***63042FAD",
"qrCodeImageBase64": "data:image/png;base64,iVBORw0KGgoAAAAN",
"barCode": "43591140300000000100001112000001700000532673",
"digitableLine": "43590001161200000170600005326731114030000000010",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV. RIO BRANCO",
"neighborhood": "CENTRO",
"number": "186",
"complement": "SALA 602",
"city": "ARACAJU",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2026-03-26T00:00:00Z",
"amount": 0.01
},
{
"date": "2026-03-27T00:00:00Z",
"amount": 0.01
},
{
"date": "2026-03-28T00:00:00Z",
"amount": 0.01
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2026-04-02T00:00:00Z",
"amount": 2.5
},
"latePayment": {
"type": "Fixed",
"date": "2026-04-02T00:00:00Z",
"amount": 2.5
},
"status": "Pending",
"payments": [],
"additionalInfo": [
{
"key": "YourNumber",
"value": "SEUNUMEROSEU"
},
{
"key": "OurNumber",
"value": "00000532673"
},
{
"key": "DigitableLine",
"value": "43590001161200000170600005326731114030000000010"
}
],
"updatedAt": "2025-02-05T21:00:50.9660452Z",
"createdAt": "2025-02-05T21:00:50.9630728Z"
}

Requisições malsucedidas responderão com seu respectivo código HTTP e o seguinte corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-7a12cadb81f68cdb4dae6b62afadd36b-55605d5867652ca6-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}

Atributos

Aqui estão todos os atributos que podem ser passados ​​para a criação do boleto bancário:

NameTypeDescriptionMax caracteres
typeenumObrigatório. Indica o tipo de transação, BANKSLIP_PIX ou BANKSLIP.-
correlationIdstringObrigatório. Identificador único para conciliação com o sistema do cliente.36
ourNumberstringNosso número atribuído à cobrança.11
yourNumberstringObrigatório. Número de referência do cliente para a cobrança.15
voidDatedateData em que a cobrança se torna inválida (formato: YYYY-MM-DD).10
dueDatedateObrigatório. Data de vencimento da cobrança, após esta data as multas serão aplicadas (formato: YYYY-MM-DD).10
AmountnumberObrigatório. Valor da cobrança.18+2
payerobjectObrigatório. Informações do pagador, incluindo nome, documento, e-mail, telefone e endereço.-
payer.namestringNome completo do pagador.40
payer.documentstringNúmero do documento do pagador (ex: CPF ou CNPJ).14
payer.emailstringEndereço de e-mail do pagador.50
payer.phoneobjectNúmero de telefone do pagador, incluindo prefixo e número.-
payer.phone.prefixstringPrefixo do número de telefone (ex: código de área).2
payer.phone.numberstringNúmero de telefone do pagador.9
payer.addressobjectInformações de endereço do pagador.-
payer.address.zipCodestringCEP do endereço do pagador.8
payer.address.publicPlacestringLogradouro do endereço do pagador (ex: rua ou avenida).150
payer.address.neighborhoodstringBairro do endereço do pagador.15
payer.address.numberstringNúmero do endereço.15
payer.address.complementstringComplemento do endereço (ex: apartamento ou sala).30
payer.address.citystringCidade do endereço do pagador.50
payer.address.statestringEstado do endereço do pagador (ex: SP, RJ).2
discountobjectInformações de desconto aplicadas à cobrança.-
discount.typeenumTipo de desconto (ex: Fixed ou Percentage).-
discount.itemsarrayLista de itens de desconto, cada um com uma data e valor.-
discount.items.datedateData em que o desconto é aplicado (formato: YYYY-MM-DD).10
discount.items.amountnumberValor do desconto.18+2
lateFineobjectInformações de multa por atraso aplicadas à cobrança.-
lateFine.typeenumTipo de multa por atraso (ex: Fixed ou Percentage).-
lateFine.datedateData em que a multa por atraso é aplicada (formato: YYYY-MM-DD).10
lateFine.amountnumberValor ou percentual da multa por atraso.18+2
latePaymentobjectInformações de juros por atraso aplicadas à cobrança.-
latePayment.typeenumTipo de juros por atraso (ex: Fixed ou Percentage).-
latePayment.datedateData em que os juros por atraso são aplicados (formato: YYYY-MM-DD).10
latePayment.amountnumberValor dos juros por atraso.18+2

Ambiente de homologação

Seguindo os endpoints para facilitar os testes no ambiente de homologação

Charge Payment [POST]

<https://apisandbox.delbank.com.br/baas/v1/charges/correlationId/pay>

A rota de pagamento de cobrança é uma rota de aprovação para testes de integração e validação de notificações. Para pagar um boleto bancário, siga este link: <https://docs.delbank.com.br/pt/Payment%20and%20Transfers%20-%20Cash-out/Bank%20slip%20payment%20or%20Tax>

Header da Requisição

x-delbank-api-key: API Key

Header da resposta

Content-Type:application/json

Obs.: Requisições com falha terão o seguinte HTTP e corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"traceId": "00-9954e85487cfc65b8841f40c572d181b-d5bf166c3d9c1c1a-00"
}

Charge Expiration [PUT]

<https://apisandbox.delbank.com.br/baas/v1/charges/correlationId/expire>

A rota de expiração de cobrança também é uma rota de aprovação para testes de integração e validação de notificações.

NOTA: Isso afetará a data de expiração original da cobrança inserida.

Header da Requisição

x-delbank-api-key:Api Key

Header da Resposta

Content-Type:application/json

Obs.: Requisições com falha terão o seguinte HTTP e corpo:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"traceId": "00-2229624b5844efe7720e367e25a6bbc8-dea6734e79cf24f8-00"
}