Skip to main content
POST
Cadastrar conta de saque
Cria e ativa imediatamente uma conta PIX para saques. Diferente do cadastro no painel, esta operação não envia código de confirmação.
O endpoint exige simultaneamente o escopo cashoutAccounts.write na credencial e a funcionalidade Contas de saque via API habilitada para a organização no painel administrativo. Sem qualquer um deles, a API retorna 403.
A chave PIX retornada é mascarada. Guarde o id para referências futuras.

Autorizações

Authorization
string
header
obrigatório

Token JWT obtido via /v1/auth/token

Corpo

application/json
pixKeyType
enum<string>
obrigatório

Tipo da chave PIX.

Opções disponíveis:
Cpf,
Cnpj,
Email,
Phone,
Random
Exemplo:

"Email"

pixKey
string
obrigatório

Chave PIX a cadastrar.

Maximum string length: 100
Exemplo:

"financeiro@empresa.com"

holderName
string
obrigatório

Nome do titular da conta.

Maximum string length: 100
Exemplo:

"Empresa Exemplo LTDA"

bankName
string | null

Nome do banco, quando disponível.

Maximum string length: 100
isDefault
boolean
padrão:false

Quando true, define esta como a conta padrão de saque.

Resposta

Conta de saque criada e ativada

data
object
message
string | null
error
object | null