Tipos de chave Pix
Informe a chave Pix no formato que a API aceita e evite recusas por máscara, dígito verificador ou falta do código do país.
Tipos e formatos
No envio para uma chave em POST /withdraw, pixType diz o tipo da chave enviada em pixKey. A API limpa a chave antes de conferir o formato, e a transação guarda a chave já limpa em withdrawPixKey.
pixType | Chave | Formato aceito |
|---|---|---|
cpf | CPF | 11 dígitos com dígito verificador válido. Pontos e traço são removidos. |
cnpj | CNPJ | 14 dígitos com dígito verificador válido. Pontos, barra e traço são removidos. |
email | Endereço de e-mail válido, guardado em minúsculas. | |
phone | Celular | +55, DDD válido e número de celular com 9 dígitos, começando por 9, como +5511999999999. |
evp | Chave aleatória | UUID, como 123e4567-e89b-42d3-a456-426614174000, guardado em minúsculas. |
Espaços no começo e no fim são removidos em todos os tipos. Uma chave que não bate com o pixType informado retorna 400, e o motivo vem em details.
Celular
No envio, o celular aceita espaços, parênteses, pontos e hífen, e +55 (11) 99999-9999 vira +5511999999999. Um número antigo, com 8 dígitos depois do DDD, só ganha o 9 na frente quando começa por 6, 7, 8 ou 9; com outro primeiro dígito, a chave é recusada.
Na consulta ao DICT, o celular precisa do código do país, com ou sem o sinal de mais.
Sem o 55, a API não reconhece a chave como celular e trata 11999999999 como CPF; se não for um CPF válido, a resposta é 400.
Consulta ao DICT
GET /pix/key recebe só pixKey, com até 77 caracteres, e descobre o tipo pela forma da chave, nesta ordem:
- Com
@, é e-mail. - No formato UUID, é chave aleatória.
- Com 12 ou 13 dígitos começando por 55, com ou sem
+, é celular. - Com 11 dígitos e CPF válido, é CPF.
- Com 14 dígitos e CNPJ válido, é CNPJ.
A consulta usa a chave limpa, como no envio. Depois de mostrar o titular, envie o Pix com a mesma chave e o pixType correspondente. Veja Consultar uma chave Pix.