API Reference
Log In
API Reference

Bankslip Query

The Bankslip querying will be in a synchronous format

Bankslip Query by Correlation Id [GET]

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

The consultation will provide charge data with already consolidated information.

Request Headers and Body

Content-Type:application/json
x-delbank-api-key:Api Key

Response Headers and Body

Content-Type:application/json
{
    "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"
}

Obs.: Failed requisistions will have the following HTTP and body:

{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "traceId": "00-72c40340fe67d8caed8275ee6e37a7a6-52bb2d57c1652859-00"
}

Paginated Bankslip Query by date range [GET]

https://apisandbox.delbank.com.br/baas/v1/charges?startDate=&endDate=&page=&limit=

The paginated query is limited to 100 items per page, and a maximum range of 1 year.

Note: Delbank currently do not provide a variety of filters as a way of encouraging the receipt of notifications and individual handling of charges. If necessary, a specific report can be requested and exported.

Request Headers

Content-Type:application/json
x-delbank-api-key:Api Key

Response Headers and Body

Content-Type:application/json
[
    {
        "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"
    }
]

Obs.: Failed requisistions will have the following HTTP and body:

{
    "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."
        ]
    }
}