Saldo e saques
Cadastrar a chave Pix de saque
Cadastra a chave Pix que recebe os seus saques. Pela API, toda chave passa por análise antes de valer.
POST
/v1/payout-keys Requer o escopo WITHDRAWAL:CREATE
Você tem uma chave de saque ativa por vez. Toda chave cadastrada pela API fica em pending_review até a aprovação, inclusive a primeira: assim uma chave de API vazada não consegue mudar o destino dos seus saques. Ao trocar de chave, a chave atual continua valendo até a nova ser aprovada.
Requisição
Cabeçalhos: Authorization, Content-Type: application/json e Idempotency-Key (obrigatório).
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | sim | Tipo da chave: cpf, cnpj, email, phone (celular com DDD) ou evp (chave aleatória). |
key | string | sim | A chave Pix. |
Resposta
A API responde 201 com a chave.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Id da chave. |
type | string | Tipo da chave. |
key | string | A chave, mascarada. |
status | string | active (vale para saques) ou pending_review (em análise). |
created_at | string (ISO 8601) | Quando a chave foi cadastrada. |
Erros
| HTTP | Código | Quando acontece | O que fazer |
|---|---|---|---|
| 409 | payout_key_pending | Já existe uma troca de chave em análise. | Espere a análise terminar. |
| 409 | payout_key_conflict | Outra chave foi cadastrada ao mesmo tempo. | Consulte suas chaves e tente de novo. |
| 422 | validation_failed | A chave não é válida para o tipo informado. | Veja o campo fields. |