Skip to main content
POST
Cadastrar conta de saque
Creates and activates a PIX cashout account immediately. Unlike the dashboard flow, this operation does not send a confirmation code.
The endpoint requires both the cashoutAccounts.write credential scope and the API cashout accounts feature to be enabled for the merchant by an administrator. The API returns 403 when either is missing.
The returned PIX key is masked. Keep the id for future references.

Authorizations

Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Body

application/json
pixKeyType
enum<string>
required

Tipo da chave PIX.

Available options:
Cpf,
Cnpj,
Email,
Phone,
Random
Example:

"Email"

pixKey
string
required

Chave PIX a cadastrar.

Maximum string length: 100
Example:

"financeiro@empresa.com"

holderName
string
required

Nome do titular da conta.

Maximum string length: 100
Example:

"Empresa Exemplo LTDA"

bankName
string | null

Nome do banco, quando disponível.

Maximum string length: 100
isDefault
boolean
default:false

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

Response

Conta de saque criada e ativada

data
object
message
string | null
error
object | null