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).

CampoTipoObrigatórioDescrição
typestringsimTipo da chave: cpf, cnpj, email, phone (celular com DDD) ou evp (chave aleatória).
keystringsimA chave Pix.

Resposta

A API responde 201 com a chave.

CampoTipoDescrição
idstringId da chave.
typestringTipo da chave.
keystringA chave, mascarada.
statusstringactive (vale para saques) ou pending_review (em análise).
created_atstring (ISO 8601)Quando a chave foi cadastrada.

Erros

HTTPCódigoQuando aconteceO que fazer
409payout_key_pendingJá existe uma troca de chave em análise.Espere a análise terminar.
409payout_key_conflictOutra chave foi cadastrada ao mesmo tempo.Consulte suas chaves e tente de novo.
422validation_failedA chave não é válida para o tipo informado.Veja o campo fields.