You can create up to 5 Pix keys per account. There are 4 types of keys (email, phone, random key, CPF/CNPJ)
Request
POST 'https://apisandbox.delbank.com.br/baas//api/v1/pix/dict/entries'
Headers
| Name | Description |
|---|---|
| x-delbank-api-key | Required. API key |
| IdempotencyKey | RequiredGUIDgenerated in the request |
| x-auth-code | code sent by SMS or email for this type of key (phone or email) |
| x-auth-id | id returned in the endpoint of sending the auth code |
Body
| Name | Type | |
|---|---|---|
| entryType | enum | Required DOCUMENT, EVP, PHONE, EMAILFor phone and email type pix keys, a confirmation code is required that is generated using the auth code endpoint below. |
| key | string | Optional For phone and email types, this field can be used to specify the key that you want to use |
Endpoint auth code
This endpoint is used to confirm the authenticity of email and phone keys. A code is sent by email or SMS and the id is returned to the endpoint. Both must be passed to the key creation endpoint as headers: x-auth-id and x-auth-code, respectively.
Request
POST'https://apisandbox.delbank.com.br/baas/api/v1/pix/dict/auth-code'
Body
| Name | Type | Description |
|---|---|---|
| sender | enum | EMAIL or SMS |
| receiver | string | Phone number or email (for phone numbers you must also add the country code: +5579901010202) |
| payload | string | SMS message or email HTML. The code will be inserted in the placeholder {{code}} |