API Reference
Log In
API Reference

Consulta de transferência

Consulta de transferência/pagamento

Este endpoint, retorna as informações de uma transferência/pagamento. É possível consultar as informações, utilizando a IdempotencyKey (esta é utilizada com Id da transação internamente no Sistema Delbank) ou EndToEndId.

Requisição

GET 'https://apisandbox.delbank.com.br/baas/api/v2/transfers/{transferIdentifier}'

curl --request GET \
     --url https://apisandbox.delbank.com.br/baas/api/v1/transfers/{transferIdentifier} \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' 
'

Cabeçalhos (Headers)

NomeDescrição
x-delbank-api-keyObrigatório. Chave de API

Parâmetros da rota (Path)

NomeTipoDescrição
transferIdentifierstringObrigatório. Identificação da transferência.
Podendo ser a ID da transação, que é a IdempotencyKey utilizada ou
a EndToEndId em caso de Transferência Pix

Resposta (Response)

O status code 200 indicará sucesso na transação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

🚧

Essas informações serão retornadas após a criação da transferência e consulta da transferência.

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