Agendamento de Pix automático
Buscar todos os Pix automáticos agendados
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/scheduling'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| flow | enum | Qual jornada pesquisar, valores: 1, 2, 3, 4 |
| startDate | data | A data de início da consulta |
| endDate | data | A data de término da consulta |
| page | número | O número da página. Use isto para paginar os resultados dependendo do tamanho da página |
| pageSize | número | A quantidade de resultados retornados por página |
Resposta
O código de status 200 indica sucesso na consulta.
Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:
{
"scheduledPayments": [
{
"endToEndId":"E00038166202409171500y6j6mt9l0pi",
"correlationId":"{{guid}}",
"id":"RR0435879820240605njua7shf40o",
"dueDate":"2024-09-24",
"amount":550,
"beneficiary": {
"ispb":4358798,
"document":61695227000193,
"name":"Enel",
"branch":"1234",
"type":0,
"number":"12345678"
},
"payer": {
"ispb":99999004,
"type":0,
"document":11111111111
},
"devedor": {
"type":0,
"document":4623217035,
"name":"Ciclano da Silva"
},
"description":"Cobrança da Enel referente a conta de energia de outubro de 2024",
}
{
"endToEndId":"E00038166202409181500y6j6mt9l2pi",
"correlationId":"JDPI2024091800000000000000000000001",
"id":"RR0435879820240918njua7shf40o",
"dueDate":"2024-09-25",
"amount":122,
"beneficiary": {
"ispb":4358798,
"document":61695227000193,
"name":"Enel",
"branch":"1234",
"type":0,
"number":"12345678"
},
"payer": {
"ispb":99999004,
"type":0,
"document":11111111111
},
"devedor": {
"type":0,
"document":4623217035,
"name":"Ciclano da Silva"
},
"description":"Cobrança Enel referente a conta de energia de outubro de 2024",
"cancellingData": [
{
"id":"CA0435879820240918bcdb1fhn43a",
"ispbDebtor":4358798,
"ispbBeneficiary":11111111,
"debtorType":0,
"debtorDocument":77379362038,
"cancelReason":6,
"cancelDate":"2024-09-18T10:10:05.025Z",
"cancelStatus":0
}
{
"id":"CA0435879820240918bcdb1fhn43a",
"ispbDebtor":4358798,
"ispbBeneficiary":11111111,
"debtorType":0,
"debtorDocument":77379362038,
"cancelReason":6,
"cancelDate":"2024-09-18T10:10:05.025Z",
"cancelStatus":0
}
]
}
]
}
Cancelar Pix Automático agendado
Request
POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:endToEnd/cancel'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path Parameters:
| Name | Type | Description |
|---|---|---|
| endToEndId | string | Required. Authorization identifier |
Query Parameters:
| Name | Type | Description |
|---|---|---|
| startDate | date | A data de início da consulta |
| endDate | date | A data de término da consulta |
| page | number | O número da página. Use isto para paginar os resultados dependendo do pageSize |
| pageSize | number | A quantidade de resultados retornados por página |
Resposta
O código de status 200 indica sucesso na consulta.
Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:
{
"endToEndId":"E11111111202409181500y6j6mt9l1pi",
"correlationId":"JDPI2024091800000000000000000000002",
"id":"CA0435879820240918bcdb1fhn43a",
"cancelDate":"2024-09-18T10:10:05.025Z"
}