Querying a payment/transfer
This endpoint returns transfer/payments information. It is possible to consult the information using the Idempotency Key (Used with the transaction id internally in the Delbank System) or EndToEndId. Note that the information is received first by the webhook, therefore your system should prioritize webhooks for these updates.
Request
GET 'https://apisandbox.delbank.com.br/baas/api/v2/transfers/{transferIdentifier}'
curl --request GET \
--url https://apisandbox.delbank.com.br/baas/api/v2/transfers/{transferIdentifier} \
--header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}'
'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
Path parameters
| Name | Type | Description |
|---|---|---|
| transferIdentifier | string | Required. Transfer identification. This identification can be the IdempotencyKey or the EndToEndId in a Pix transaction. |
Response
The status code 200 will indicate success in the transaction
Being successful, the return body will present the following fields in Json format:
This information will be returned after transfer creation and transfer query.
{
"id": "e051e1db-1a90-47dc-9e37-3ef2b4fc9d35",
"endToEndId": "E3822485720231012010030530986185",
"transactionNsu": 998633,
"status": "PIX_EFFECTIVE",
"type": "PIX_QR_CODE_DYNAMIC",
"amount": 5.99,
"createdAt": "2023-10-12T01:00:34.022Z",
"description": "description",
"payer": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "bxxdbde",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
},
"beneficiary": {
"number": "31712",
"branch": "0001",
"type": "CURRENT",
"holder": {
"document": "32752023000149",
"name": "BXXDBDE",
"type": "LEGAL"
},
"participant": {
"name": "DELBANK",
"ispb": "38224857"
}
}
}