Reúne Endpoints destinados ao gerenciamento de Cobranças.
Tipos de Cobrança
A seguir, uma relação entre os tipos de cobrança.
BANKSLIP: Boleto convencional
BANKSLIP_PIX: Um boleto que além do código de barras convencional, contém um QR Code podendo assim ser pago usando um método de pagamento Pix
IMPORTANTE: Para criação de Cobranças do tipo BANKSLIP e BANKSLIP_PIX será necessário o enquadramento da conta bancária como Cedente. Importante também que é recomendado usar GUID como correlationId
Realize a solicitação por meio do e-mail: [email protected].
Especificações Técnicas Gerais
Esta seção tem como objetivo destacar e explicar elementos técnicos comuns a todas operações/processos.
Além do processo de Autenticação explicado anteriormente, para as requisições HTTP, se destacam alguns campos que envolvem regras de negócio ou especificações gerais do Delbank BaaS.
A seguir alguns campos presentes no body das requisições e sua explicação.
type- corresponde ao Tipo de Cobrança, que neste caso deve ser atribuído o valorBANKSLIP;correlationId- corresponde a um identificador que garanta unicidade à aquela Cobrança internamente a um sistema. Este campo reflete ao controle interno utilizado no sistema da entidade que consome esta API, ou seja, o cliente.ourNumber- corresponde a um identificador para o Delbank que permita realizar o acompanhamento ou rastreamento de uma Cobrança. Este valor estará exposto/gravado na Cobrança e normalmente será apresentado ao indivíduo final como "Nosso Número".yourNumber- corresponde a um identificador para o Emissor da Cobrança, que permita realizar o acompanhamento ou rastreamento da mesma. Este valor estará exposto/gravado na Cobrança e normalmente será apresentado ao indivíduo final como "Nº do Documento" ou nomenclatura similar.
Entende-se que os demais campos não apresentam grande complexidade ou regras específicas a serem seguidas.
Criação
Criando uma Cobrança Normal
Método POST
https://apisandbox.delbank.com.br/v1/charges
A Cobrança Normal tem como foco o Título Simplificado que irá refletir na Carteira 112.
Observação: Dada a categoria atual de Cobrança, não se faz necessário o envio do campo "Nosso Número" (ourNumber), uma vez que, sua criação fica a encargo do Delbank.
Segue abaixo, instruções e um template para execução desta operação.
- Configure os Headers básicos para o acesso:
Content-Type: application/json
x-delbank-api-key: API Key
- Utilize o seguinte Body como exemplo:
{
"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"
}
}
}
- O conteúdo da Response terá o seguinte tipo e valor:
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.: Requisições malsucedidas responderão com seu respectivo código HTTP e o seguinte Body:
{
"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."
]
}
}
Criando uma Cobrança Expressa
Método POST
https://apisandbox.delbank.com.br/v1/charges
A Cobrança Expressa tem como foco o Título gerado pelo Cliente, que irá refletir na Carteira 121.
Ao contrário da Cobrança Normal, neste tipo de operação é necessário o envio do campo "Nosso Número" (ourNumber).
Segue abaixo, instruções e um template para a execução desta operação.
- Configure os Headers básicos para o acesso:
Content-Type: application/json
x-delbank-api-key: API Key
- Utilize o seguinte Body como exemplo:
{
"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"
}
}
}
- O conteúdo da Response terá o seguinte tipo e valor:
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 malsucedidas responderão com seu respectivo código HTTP e o seguinte Body:
{
"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 Avalista/Sacador
Método POST
https://apisandbox.delbank.com.br/v1/charges
Este endpoint é utilizado para efetuar a criação de um Título, "Boleto" (BANKSLIP) ou Boleto Pix (BANKSLIP_PIX) com um Avalista/Sacador (Beneficiário Final).
- Configure os Headers básicos para o acesso:
Content-Type: application/json
x-delbank-api-key: API Key
- Utilize o seguinte Body como exemplo:
{
"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"
}
}
}
- O conteúdo da Response terá o seguinte tipo e valor:
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 malsucedidas responderão com seu respectivo código HTTP e o seguinte Body:
{
"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 vinculado com o Pix
Método POST
https://apisandbox.delbank.com.br/v1/charges
Este endpoint é utilizado para criar uma Cobrança do tipo "Boleto Pix". Nesta modalidade, o Título será emitido na Carteira 112.
- Configure os Headers básicos para o acesso:
Content-Type: application/json
x-delbank-api-key: API Key
- Utilize o seguinte Body como exemplo:
{
"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
}
}
- O conteúdo da Response terá o seguinte tipo e valor:
Content-Type: application/json
{
"type": "PIX_STATIC",
"correlationId": "e2590eaa-ca27-4d25-8170-48844785af75",
"amount": 1.99,
"description": "Serviço Realizado.",
"additionalInfo": [
{
"key": "Campo 1",
"value": "Informação Adicional1 do PSP-Recebedor"
}
],
"status": "Created",
"qrCode": "00020101021226790014br.gov.bcb.pix2557pix-h.delbank.com.br/v1/...",
"payments": [],
"createdAt": "2022-09-22T17:28:51.882Z",
"updatedAt": "2022-09-22T17:28:51.882Z"
}
Obs.: Requisições malsucedidas responderão com seu respectivo código HTTP e o seguinte Body:
{
"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 Mora
Método POST
https://apisandbox.delbank.com.br/v1/charges?2ad27621-b0b2-4a96-8302-838ce5c4cfeb
Este endpoint para criar uma Cobrança "Boleto PIX", nessa modalidade o título será emitido na carteira 112.
Utilizando o Headers:
Content-Type:application/json
x-delbank-api-key:Api Key
Os requisitos deverá ter o seguinte corpo:
{
"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
}
}
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
Body:
{
"type": "PIX_STATIC",
"correlationId": "e2590eaa-ca27-4d25-8170-48844785af75",
"amount": 1.99,
"description": "Serviço Realizado.",
"additionalInfo": [
{
"key": "Campo 1",
"value": "Informação Adicional1 do PSP-Recebedor"
}
],
"status": "Created",
"qrCode": "00020101021226790014br.gov.bcb.pix2557pix-h.delbank.com.br/v1/...",
"payments": [],
"createdAt": "2022-09-22T17:28:51.882Z",
"updatedAt": "2022-09-22T17:28:51.882Z"
}
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."
]
}
}
Consulta
A consulta de cobranças imediatas será no formato síncrono
Consulta por identificador de correlação [GET]
https://apisandbox.delbank.com.br/v1/charges/correlationId
A consulta fornecerá os dados da cobrança com informações já consolidadas.
Utilizando o Headers:
Content-Type:application/json
x-delbank-api-key:Api Key
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
Body:
{
"type": "BANKSLIP",
"correlationId": "304c439c-4b17-4a75-abb1-2526e356cdad",
"amount": 0.10,
"walletNumber": "112",
"yourNumber": "SEUNUMEROSEU",
"ourNumber": "00000520637",
"dueDate": "2025-06-13T00:00:00Z",
"barCode": "43595103800000000100001112000000600000520637",
"digitableLine": "43590001161200000060900005206370510380000000010",
"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"
}
},
"beneficiary": {
"branch": "00019",
"bankAccount": "29823",
"document": "30287697789",
"name": "HOMOLOGACAO INTEGRACAO API",
"address": {
"zipCode": "49000000",
"publicPlace": "Rua Verde Violeta",
"neighborhood": "Lamarão",
"number": "82",
"city": "ITABAIANA",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-26T00:00:00Z",
"amount": 0.01000
},
{
"date": "2025-03-27T00:00:00Z",
"amount": 0.01000
},
{
"date": "2025-03-28T00:00:00Z",
"amount": 0.01000
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-04-02T00:00:00Z",
"amount": 2.50000
},
"latePayment": {
"type": "Fixed",
"date": "2025-04-02T00:00:00Z",
"amount": 2.50000
},
"status": "Pending",
"payments": [],
"additionalInfo": [],
"updatedAt": "2024-12-05T18:00:55.56Z",
"createdAt": "2024-12-05T17:55:55.08Z"
}
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.4",
"title": "Not Found",
"status": 404,
"traceId": "00-72c40340fe67d8caed8275ee6e37a7a6-52bb2d57c1652859-00"
}
Consulta paginada por período [GET]
https://apisandbox.delbank.com.br/v1/charges?startDate=&endDate=&page=&limit=
A Consulta paginada é limitada a 100 itens por página, e um range máximo de 1 ano.
Nota: Atualmente não disponibilizamos uma variedade de filtros como forma de incentivo ao recebimento de notificações e ao tratamento individual de cobranças, Em caso de necessidade poderá ser efetuado a exportação de um relatório materializado.
Utilizando o Headers:
Content-Type:application/json
x-delbank-api-key:Api Key
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
Body:
[
{
"type": "BANKSLIP",
"amount": 0.10,
"walletNumber": "112",
"yourNumber": "SEUNUMEROSEU",
"ourNumber": "00000520637",
"dueDate": "2025-04-01T00:00:00",
"barCode": "43595103800000000100001112000000600000520637",
"digitableLine": "43590001161200000060900005206370510380000000010",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV RIO BRANCO 186 SALA 602",
"neighborhood": "CENTRO",
"city": "ARACAJU",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-26T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-27T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-28T00:00:00",
"amount": 0.01000
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-04-02T00:00:00",
"amount": 2.5000
},
"latePayment": {
"type": "Fixed",
"date": "2025-04-02T00:00:00",
"amount": 2.50000
},
"status": "Pending",
"createdAt": "2024-12-04T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 0.10,
"walletNumber": "112",
"yourNumber": "SEUNUMEROSEU",
"ourNumber": "00000520629",
"dueDate": "2025-04-01T00:00:00",
"barCode": "43594103800000000100001112000000600000520629",
"digitableLine": "43590001161200000060900005206297410380000000010",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV RIO BRANCO 186 SALA 602",
"neighborhood": "CENTRO",
"city": "ARACAJU",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-26T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-27T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-28T00:00:00",
"amount": 0.01000
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-04-02T00:00:00",
"amount": 2.5000
},
"latePayment": {
"type": "Fixed",
"date": "2025-04-02T00:00:00",
"amount": 2.50000
},
"status": "Pending",
"createdAt": "2024-12-04T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 0.10,
"walletNumber": "112",
"yourNumber": "SEUNUMEROSEU",
"ourNumber": "00000520611",
"dueDate": "2025-04-01T00:00:00",
"barCode": "43591103800000000100001112000000600000520611",
"digitableLine": "43590001161200000060900005206115110380000000010",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "988669383"
},
"address": {
"zipCode": "49010030",
"publicPlace": "AV RIO BRANCO 186 SALA 602",
"neighborhood": "CENTRO",
"city": "ARACAJU",
"state": "SE"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2025-03-26T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-27T00:00:00",
"amount": 0.01000
},
{
"date": "2025-03-28T00:00:00",
"amount": 0.01000
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2025-04-02T00:00:00",
"amount": 2.5000
},
"latePayment": {
"type": "Fixed",
"date": "2025-04-02T00:00:00",
"amount": 2.50000
},
"status": "Pending",
"createdAt": "2024-12-04T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 5000.00,
"walletNumber": "112",
"yourNumber": "453",
"ourNumber": "00000519910",
"dueDate": "2024-12-03T00:00:00",
"barCode": "43595991900005000000001112000000600000519910",
"digitableLine": "43590001161200000060900005199104599190000500000",
"payer": {
"name": "AYRTON SEGUNDOS",
"document": "01234567890",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "01020000",
"publicPlace": "RUA TABATINGUERA 171",
"neighborhood": "SE",
"city": "SÃO PAULO",
"state": "SP"
}
},
"status": "Expired",
"createdAt": "2024-11-26T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 4000.00,
"walletNumber": "112",
"yourNumber": "453",
"ourNumber": "00000519902",
"dueDate": "2024-12-03T00:00:00",
"barCode": "43591991900004000000001112000000600000519902",
"digitableLine": "43590001161200000060900005199021199190000400000",
"payer": {
"name": "AYRTON SEGUNDOS",
"document": "01234567890",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "01020000",
"publicPlace": "RUA TABATINGUERA 171",
"neighborhood": "SE",
"city": "SÃO PAULO",
"state": "SP"
}
},
"status": "Expired",
"createdAt": "2024-11-26T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 1000.00,
"walletNumber": "112",
"yourNumber": "453",
"ourNumber": "00000519894",
"dueDate": "2024-12-03T00:00:00",
"barCode": "43599991900001000000001112000000600000519894",
"digitableLine": "43590001161200000060900005198940999190000100000",
"payer": {
"name": "AYRTON SEGUNDOS",
"document": "01234567890",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "01020000",
"publicPlace": "RUA TABATINGUERA 171",
"neighborhood": "SE",
"city": "SÃO PAULO",
"state": "SP"
}
},
"status": "Expired",
"createdAt": "2024-11-26T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 100.00,
"walletNumber": "112",
"yourNumber": "453",
"ourNumber": "00000519886",
"dueDate": "2024-12-03T00:00:00",
"barCode": "43599991900000100000001112000000600000519886",
"digitableLine": "43590001161200000060900005198866999190000010000",
"payer": {
"name": "AYRTON SEGUNDOS",
"document": "01234567890",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "900000000"
},
"address": {
"zipCode": "01020000",
"publicPlace": "RUA TABATINGUERA 171",
"neighborhood": "SE",
"city": "SÃO PAULO",
"state": "SP"
}
},
"status": "Expired",
"createdAt": "2024-11-26T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 0.10,
"walletNumber": "112",
"yourNumber": "8594586687",
"ourNumber": "00000519514",
"dueDate": "2024-11-26T00:00:00",
"barCode": "43597991200000000100001112000000600000519514",
"digitableLine": "43590001161200000060900005195144799120000000010",
"payer": {
"name": "ANTHONY BORNER SANTANA",
"document": "83488667103",
"email": "[email protected]",
"phone": {
"prefix": "67",
"number": "969628243"
},
"address": {
"zipCode": "79103190",
"publicPlace": "RUA COSTA AGUIAR 000 COMPLEMENT",
"neighborhood": "NEIGHTBORHOOD",
"city": "CITY",
"state": "SE"
}
},
"status": "Expired",
"createdAt": "2024-11-25T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 20.00,
"walletNumber": "112",
"yourNumber": "4rf5t76",
"ourNumber": "00000518649",
"dueDate": "2024-11-30T00:00:00",
"barCode": "43595991600000020000001112000000600000518649",
"digitableLine": "43590001161200000060900005186499599160000002000",
"payer": {
"name": "JOSEPHTESTERSONPOGGERSON",
"document": "30030030030",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "999999999"
},
"address": {
"zipCode": "01030000",
"publicPlace": "RUAFLORENCIODEABREU SN",
"neighborhood": "CENTRO",
"city": "SÃOPAULO",
"state": "SP"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2024-11-22T00:00:00",
"amount": 2.00000
}
]
},
"status": "Expired",
"createdAt": "2024-11-19T00:00:00"
},
{
"type": "BANKSLIP",
"amount": 20.00,
"walletNumber": "112",
"yourNumber": "4rf5t76",
"ourNumber": "00000512592",
"dueDate": "2024-12-08T00:00:00",
"barCode": "43599992400000020000001112000000600000512592",
"digitableLine": "43590001161200000060900005125927999240000002000",
"payer": {
"name": "JOSEPHTESTERSONPOGGERSON",
"document": "30030030030",
"email": "[email protected]",
"phone": {
"prefix": "79",
"number": "999999999"
},
"address": {
"zipCode": "01030000",
"publicPlace": "RUAFLORÊNCIODEABREU SN",
"neighborhood": "CENTRO",
"city": "SÃOPAULO",
"state": "SP"
}
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "2024-12-01T00:00:00",
"amount": 2.00000
}
]
},
"lateFine": {
"type": "Percentage",
"date": "2024-12-10T00:00:00",
"amount": 2.0000
},
"latePayment": {
"type": "Percentage",
"date": "2024-12-10T00:00:00",
"amount": 0.3200
},
"status": "Pending",
"createdAt": "2024-11-04T00:00:00"
}
]
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-55c382b4ece012e01dc19131929cea5c-6d6bb173dab9f992-00",
"errors": {
"endDate": [
"The value 'yyyy-mm-dd' is not valid."
],
"startDate": [
"The value 'yyy-mm-dd' is not valid."
]
}
}
Manutenção
A baixa da cobrança não impossibilitará o recebimento pagamentos que já foram efetuados.
Exemplo de atualização parcial [PATCH]
https://apisandbox.delbank.com.br/v1/charges/correlationId
Atualmente disponibilizamos a atualização parcial do título, podendo assim, alterar o vencimento do mesmo.
Utilizando o Headers:
Content-Type:application/json
x-delbank-api-key:Api Key
Os requisitos deverá ter o seguinte corpo:
{
"walletNumber": "112",
"yourNumber": "SEUNUMERO",
"amount": 10,
"dueDate": "2022-06-13",
"payer": {
"name": "FULANO CICLANO",
"document": "16166823533",
"zipCode": "49010030",
"address": "AV. RIO BRANCO, 186",
"neighborhood": "CENTRO",
"state": "SE",
"city": "ARACAJU"
},
"discount": {
"type": "Fixed",
"items": [
{
"date": "yyyy-MM-dd",
"amount": 0
},
{
"date": "yyyy-MM-dd",
"amount": 0
},
{
"date": "yyyy-MM-dd",
"amount": 0
}
]
},
"lateFine": {
"type": "Percentage",
"date": "yyyy-MM-dd",
"amount": 0
},
"latePayment": {
"type": "Percentage",
"date": "yyyy-MM-dd",
"amount": 0
},
"allowPartialPayment": false
}
E responderá com o seguinte corpo:
Utilizando o Headers:
Content-Type:text/plain
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-d4f01e7c0b935601aa07789983ec6228-6fffc4c2b5f642dc-00",
"errors": {
"$.dueDate": [
"The JSON value could not be converted to System.Nullable`1[System.DateTime]. Path: $.dueDate | LineNumber: 4 | BytePositionInLine: 25."
]
}
}
Efetuando a baixa da cobrança [POST]
https://apisandbox.delbank.com.br/v1/charges/correlationId/void
Endpoint para efetuar a baixa e cancelamento do qr-code.
Utilizando o Headers:
x-delbank-api-key:Api Key
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
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.4",
"title": "Not Found",
"status": 404,
"traceId": "00-8a3919c1917bff4f84367110dcf0680a-e156f57e8851b5be-00"
}
Impressão
A seguir alguns endpoints com exemplos de impressão de PDFs e geração de QR Codes
Impressão do boleto bancário [GET]
https://apisandbox.delbank.com.br/v1/charges/correlationId/stream
Endpoint para efetuar a impressão do título
Utilizando o Headers:
x-delbank-api-key:Api Key
E responderá com o seguinte corpo:
Content-Type:application/pdf
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.4",
"title": "Not Found",
"status": 404,
"traceId": "00-f94523a9cff07f9f4b94a6f97837f657-e010fb53ce385f31-00"
}
Sandbox
A seguir alguns endpoints para facilitar os testes em ambiente sandbox.
Teste de pagamento da cobrança [POST]
https://apisandbox.delbank.com.br/v1/charges/correlationId/pay
A rota de pagamento da cobrança é uma rota homologatória para testes de integração e validação das notificações.
Utilizando o Headers:
x-delbank-api-key: API Key
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
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.4",
"title": "Not Found",
"status": 404,
"traceId": "00-9954e85487cfc65b8841f40c572d181b-d5bf166c3d9c1c1a-00"
}
Teste de expiração da cobrança [PUT]
https://apisandbox.delbank.com.br/v1/charges/correlationId/expire
A rota de expiração da cobrança é uma rota homologatória para testes de integração e validação das notificações.
NOTA: Irá afetar a data de expiração original da cobrança informada.
Utilizando o Headers:
x-delbank-api-key:Api Key
E responderá com o seguinte corpo:
Headers:
Content-Type:application/json
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.4",
"title": "Not Found",
"status": 404,
"traceId": "00-2229624b5844efe7720e367e25a6bbc8-dea6734e79cf24f8-00"
}