Requisição
POST 'https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/entries'
curl --request POST \
--url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
--header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '
{
"type": "DOCUMENT",
"account": {
"type": "CURRENT",
"number": "2000",
"branch": "0001",
"createdAt": "2023-05-07T16:36:08.111Z",
"holder": {
"document": "06130856555",
"name": "NATURAL PERSON LOREN IPSUN LOREN",
"type": "NATURAL"
}
}
}
'
curl --request POST \
--url https://apisandbox.delbank.com.br/indirect-pix/api/v1/dict/claims \
--header 'IdempotencyKey: 9d16ea35-8a85-49ea-a41e-bcf56c677129' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-delbank-api-key: {{apiKey}}' \
--data '
{
"key": "+5579999999999",
"type": "PHONE",
"account": {
"type": "CURRENT",
"number": "2000",
"branch": "0001",
"createdAt": "2023-05-07T16:36:08.111Z",
"holder": {
"document": "06130856555",
"name": "NATURAL PERSON LOREN IPSUN LOREN",
"type": "NATURAL"
}
}
}
'
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
x-delbank-api-key | Obrigatório. Chave de API |
IdempotencyKey | Obrigatório. Chave idempotência da requisição. Informe um GUID, sendo um novo cada requisição. |
x-auth-code | código enviado por SMS ou e-mail para este tipo de chave (telefone ou e-mail) |
x-auth-id | id retornado no endpoint de envio do código de autenticação |
Corpo da requisição (Body)
Name | Type | |
---|---|---|
entryType | enum | Obrigatório DOCUMENT , EVP , PHONE , EMAIL Para chaves pix do tipo telefone e e-mail, é necessário um código de confirmação gerado usando o ponto de extremidade do código de autenticação abaixo. |
Código de autenticação do endpoint
Este endpoint é usado para confirmar a autenticidade de chaves de e-mail e telefone. Um código é enviado por e-mail ou SMS e o id é retornado ao endpoint. Ambos devem ser passados para o endpoint de criação de chave como cabeçalhos: x-auth-id e x-auth-code, respectivamente.
Requisição
POST'https://apisandbox.delbank.com.br/baas/api/v1/pix/dict/auth-code'
Corpo da requisição (Body)
Name | Type | Description |
---|---|---|
sender | enum | EMAIL ou SMS |
receiver | string | Número de telefone ou e-mail (para números de telefone você também deve adicionar o código do país: +5579901010202) |
payload | string | Mensagem SMS ou e-mail HTML. O código será inserido no placeholder {{code}} |