Skip to main content
Uma payout_account representa o destino configurado para os repasses de um cadastro financeiro. Ela não é uma conta bancária genérica: o objeto descreve especificamente a conta para saques usada na liquidação dos valores. Organizações conectadas a uma plataforma veem esse destino por vínculo: quando a organização atuante tem uma conta para saques conectada, ela aparece em organization.payout_account; antes disso, o campo vem null. A Chargefy nunca retorna o número completo da conta. Para identificação e conciliação visual, o objeto expõe apenas banco, agência, titular e os quatro últimos dígitos da conta. Para exibir a conta atual de uma organização conectada no admin da plataforma, prefira ler organization.payout_account. Use os endpoints de payout_accounts quando precisar listar contas conectadas, consultar um pa_* específico ou trocar/desconectar a conta principal.

Data Object

Este é o formato completo retornado em organization.payout_account, nos endpoints de payout_accounts e em data.object.payout_account dos webhooks que carregam uma organization.
is_active: true significa apenas que a conta é a principal cadastrada para recebimentos. Isso não garante que os repasses serão creditados: a organização deve conferir os recebimentos no extrato bancário e conciliá-los com as transactions.
string
Identificador público da conta para saques. Usa o prefixo pa_*.
string
Sempre "payout_account".
string
Últimos 4 dígitos da conta. O número completo nunca é retornado.
string
Código do banco.
string | null
Nome do banco. Vem null quando indisponível.
string | null
Data de criação em ISO 8601.
string
Nome do titular da conta.
boolean
true quando esta é a conta principal no cadastro financeiro. Não indica se os repasses serão efetivamente creditados.
boolean
Campo apenas informativo. Não representa elegibilidade para recebimentos e não deve ser usado para decidir se uma conta pode receber repasses.
boolean
true em produção; false em ambiente de teste.
object
Reservado para metadata pública do objeto. Atualmente retorna {}.
string
Agência ou identificador de roteamento.
string
Tipo da conta para saques.
string | null
Data da última atualização em ISO 8601.

Operações

Relações

O objeto payout_account também é retornado como campo aninhado em: