API Reference
Log In
API Reference

Transferência Pix com Chave

Pix com chave

Para realizar um PIX com uma chave, é necessário _primeiramente _realizar a consulta das informações da chave a através do endpoint de inicialização de pagamento e por fim a efetivação da transferência.

Inicialização de pagamento

Este endpoint vai te fornecer dados básicos relativos à chave consultada, Além disso, ele fornecerá o atributo "endToEndId" que será cobrado pelo endpoint de transferência se você optar pelo Pix com Chave.

Segue abaixo o exemplo de request e response. Para mais detalhes do endpoint, clique aqui.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v2/pix/dict/payment-initialization'

curl --request POST \
     --url https://apisandbox.delbank.com.br/baas/api/v2/pix/dict/payment-initialization \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "key": "+5579111140958"
}
'

Cabeçalhos (Headers)

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

Corpo da requisição (Body)

NomeTipoDescrição
keystringObrigatório. Chave PIX registrada no DICT
holderDocumentstringOpcional Documento do titular para verificar se ele é o dono da chave que está sendo pesquisada.
Se este campo for fornecido, a resposta de pesquisa da chave Pix retornará um FLAG indicando (keyBelongsHolder) se a chave pertence a este titular.

Resposta (Response)

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

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

🚧

Utilizar o atributo endToEndId na requisição de transferência.

{
    "endToEndId": "E38224857202412201244TP05NXG36QK",
    "key": "30287697789",
    "beneficiary": {
        "number": "29823",
        "branch": "1",
        "type": "CURRENT",
        "participant": {
            "name": "DELCRED SCD S.A.",
            "ispb": "38224857"
        },
        "holder": {
            "name": "HOMOLOGACAO INTEGRACAO API",
            "document": "***876977**",
            "type": "NATURAL"
        }
    },
    "keyBelongsHolder": false
}

Caso seja passado holderDocument correto, a response será assim:

{
    "endToEndId": "E3822485720241220122418yWF7jWUKA",
    "key": "30287697789",
    "beneficiary": {
        "number": "29823",
        "branch": "1",
        "type": "CURRENT",
        "participant": {
            "name": "DELCRED SCD S.A.",
            "ispb": "38224857"
        },
        "holder": {
            "name": "HOMOLOGACAO INTEGRACAO API",
            "document": "***876977**",
            "type": "NATURAL"
        }
    },
    "keyBelongsHolder": true
}

Efetivação da transferência

Após realizar a inicialização de pagamento, conferir as informações da conta beneficiária e está com posse da endToEndId retornada, deve executar a chamada do endpoint de transferência.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v2/transfers

curl --request POST \
     --url https://apisandbox.delbank.com.br/baas/api/v2/transfers \
     --header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --data '
{
    "amount": 0.01,
    "description": "description",
    "endToEndId": "E3822485720230814223254707809687",
    "initiationType": "KEY"
}
'

Cabeçalhos (Headers)

NomeDescrição
x-delbank-api-keyObrigatório. Chave de API
IdempotencyKeyObrigatório. Chave idempotência da requisição. Informe um GUID, sendo um novo cada requisição.

Corpo da requisição (Body)

NomeTipoDescrição
amountnumberObrigatório. Valor da transferência
descriptionstringDescrição sobre a transferência. Essa informação será mostrada a conta beneficiária
endToEndIdstringObrigatório. EndToEndId retornada na consulta da chave
initiationTypeenumObrigatório. Tipo de inicialização.
Utilizar o tipo 'KEY' para este caso

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": "0fc7821d-b488-4268-88c0-a2bc443d046e",
    "endToEndId": "E3822485720230808004731LMaDWkOcM",
    "transactionNsu": 722355,
    "status": "PIX_PROCESSING",
    "type": "PIX_KEY",
    "amount": 0.55,
    "createdAt": "2023-08-08T00:47:31.251Z",
    "description": "manual JD",
    "payer": {
        "number": "31712",
        "branch": "0001",
        "type": "CURRENT",
        "holder": {
            "document": "32752023000149",
            "name": "bxxdbde",
            "type": "LEGAL"
        },
        "participant": {
            "name": "DELBANK",
            "ispb": "38224857"
        }
    },
    "beneficiary": {
        "number": "46441",
        "branch": "0007",
        "type": "CURRENT",
        "holder": {
            "document": "01234567890",
            "name": "OTAVIO BARBOSA",
            "type": "NATURAL"
        },
        "participant": {
            "name": "BANCO DA AMAZONIA S.A.",
            "ispb": "04902979"
        }
    }
}

📘

Para mais informações

Para mais informações e simulações de requisição deste endpoint, acesse o API Reference.