Formatos de chave Pix
Formatos aceitos em requester.key ao solicitar um saque, de
acordo com o key_type informado.
key_type |
Formato | Exemplo | Erro quando não bate |
|---|---|---|---|
cpf |
Exatamente 11 dígitos, sem pontuação | 95876150096 |
cpf key must be 11 digits |
cnpj |
Exatamente 14 dígitos, sem pontuação | 33400689000109 |
cnpj key must be 14 digits |
phone |
E.164, com + e código do país |
+5511999999999 |
phone key must be E.164 (e.g. +5511999999999) |
email |
Endereço de e-mail válido | financeiro@example.com |
invalid email key |
evp |
UUID (chave aleatória) | 17ce9060-b29d-4ab5-89cd-20550ce6e7ac |
evp key must be a UUID |
Um key_type fora dessa lista responde unknown key_type "…". Todos esses erros
voltam com status 400.
Exemplo
Seção intitulada “Exemplo”curl --request POST \ --url https://api.avexus.app/api/withdrawals \ --header 'Content-Type: application/json' \ --header 'x-api-key: <API_KEY>' \ --header 'x-token: <TOKEN>' \ --header 'x-timezone: America/Sao_Paulo' \ --header 'idempotency-key: <UNIQUE_KEY>' \ --data '{ "amount": 500.00, "requester": { "name": "Maria Souza", "key": "17ce9060-b29d-4ab5-89cd-20550ce6e7ac", "key_type": "evp" }, "transfer_method": "Pix" }'Veja também
Seção intitulada “Veja também”- Saques — exemplos completos para cada
key_type. - Códigos de erro — o que fazer com cada resposta.
