Inicializar Pagamento por Chave

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/dict/payment-initialization' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "key": "+5511999975734",
    "holderDocument": "30287697789"
}'

{
    "endToEndId": "E38224857202412201244TP05NXG36QK",
    "key": "+5511999975734",
    "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
}

POST

pix

dict

payment-initialization

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/dict/payment-initialization' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "key": "+5511999975734",
    "holderDocument": "30287697789"
}'

{
    "endToEndId": "E38224857202412201244TP05NXG36QK",
    "key": "+5511999975734",
    "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
}

Para o passo a passo completo, veja o guia Pagar via Chave Pix.

Consulta a chave informada no DICT (Diretório de Identificadores de Contas Transacionais) do Banco Central e retorna os dados da conta vinculada, incluindo o endToEndId de uso único que deve ser enviado no POST /transfers para efetivar o pagamento.

Headers

string

required

Sua API key.

string

required

Número da conta Delfinance.

Body

string

required

Chave Pix do recebedor. Aceita: CPF, CNPJ, e-mail, número de telefone com DDD e código de país (+55...), ou chave aleatória (EVP).

string

CPF ou CNPJ do titular esperado. Quando informado, a resposta inclui o campo keyBelongsHolder indicando se a chave pertence a esse documento — útil para validar que o pagamento vai para a pessoa certa.

Response

string

Identificador único de uso único. Deve ser enviado no corpo do POST /transfers para efetivar o pagamento. Expira após um curto período.

string

Chave Pix consultada.

object

Dados da conta vinculada à chave.

Show beneficiary

string

Número da conta.

string

Agência.

string

Tipo de conta (CURRENT, PAYMENT, SAVING, SALARY).

string

Nome da instituição financeira.

string

Código ISPB da instituição.

string

Nome do titular (pode vir mascarado por privacidade).

string

Documento do titular (mascarado).

string

NATURAL (pessoa física) ou LEGAL (pessoa jurídica).

boolean

Presente apenas quando holderDocument foi informado. true se a chave pertence ao documento informado, false caso contrário.

curl --location 'https://apisandbox.delbank.com.br/baas/api/v2/pix/dict/payment-initialization' \
--header 'Content-Type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--header 'x-delfinance-account-id: {{accountId}}' \
--data '{
    "key": "+5511999975734",
    "holderDocument": "30287697789"
}'

{
    "endToEndId": "E38224857202412201244TP05NXG36QK",
    "key": "+5511999975734",
    "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
}

Introdução

Pix

Boleto

Split de Pagamentos

Webhooks

Inicializar Pagamento por Chave

Headers

Body

Response

​Headers

​Body

​Response

Headers

Body

Response