O objeto Payout

Esse objeto representa o pagamento criado após a geração de uma transação para transferir fundos de sua conta para outra conta ou destinatário.

id string
O identificador exclusivo do pagamento (MAX 64; MIN 36).
Exemplo: 5404911d-5df9-429e-8488-ad41abea1a4b

account_id string
O identificador exclusivo da conta (MAX 64; MIN 36).
Example: 2404911d-5df9-429e-8488-ad41abea1a4b

status enum
O status do pagamento (MAX 255; MIN 3).
Exemplo: SUCCEEDED

merchant_reference string
O identificador exclusivo do pedido do cliente (MAX 255; MIN 3).
Exemplo: 4234

description string
A descrição do pagamento (MAX 255; MIN 3).
Exemplo: pagamento no mercado

purpose enum
Indica a finalidade do pagamento.
Valores de enum possíveis: Verifique a lista Finalidade.

country enum
País em que a transação deve ser processada (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.

amount objeto

Especifica o objeto de valor de pagamento, com o valor e a moeda.

value número
O valor do pagamento (múltiplo de 0,0001).
Exemplo: 10000

currency enum
A moeda usada para fazer o pagamento (MAX 3; MIN 3; ISO 4217).
Possíveis valores de enum: Verifique a referência do país.

beneficiary objeto

Especifica o objeto beneficiário com sua identificação.

merchant_beneficiary_id string
Identificador exclusivo do beneficiário definido pelo comerciante.
Exemplo: AAAA01

national_entity enum
Tipo de entidade nacional do beneficiário.
Valores de enum possíveis: INDIVIDUAL ou ENTITY

first_name string
O primeiro nome do beneficiário (MAX 80; MIN 1).
Exemplo: João

last_name string
O sobrenome do beneficiário (MAX 80; MIN 1).
Exemplo: Doe

legal_name string
O nome do beneficiário (Máx.: 80). Necessário somente quando national_entity é ENTITY.
Exemplo: Arcos dorados S.A.

email string
O email do beneficiário (MAX 255; MIN 3).
Exemplo: [email protected]

country enum
O país do beneficiário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.

date_of_birth data
A data de nascimento do beneficiário no formato AAAA-MM-DD (MAX 10; MIN 10).
Exemplo: 1990-02-28

document objeto

Especifica o objeto de documento do beneficiário, incluindo seu número e tipo.

document_number string
O número do documento do beneficiário (MAX 40; MIN 3).
Exemplo: 1093333333

document_type enum
O tipo de documento do beneficiário (MAX 6, MIN 2).
Possíveis valores de enum: Verifique a referência do país.

phone objeto

Especifica o objeto de número de telefone do beneficiário.

country_code string
O código de chamada do país do telefone do beneficiário (MAX 3; MIN 1). Valores possíveis: Verifique o Referência do país.
Exemplo: 57

number string
O número de telefone do beneficiário, sem o código de chamada do país (MAX 32; MIN 1).
Exemplo: 3132450765

address objeto

Especifica o objeto de endereço do beneficiário.

address_line_1 string
A linha de endereço principal do beneficiário (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78

address_line_2 string
A linha de endereço secundário do beneficiário (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I

city string
A cidade considerada para o endereço do beneficiário (MAX 255; MIN 3).
Exemplo: Bogotá

country enum
O país do endereço do beneficiário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.

state string
O endereço do estado ou da província do beneficiário (MAX 255; MIN 3).
Exemplo: Cundinamarca

zip_code string
O CEP considerado para o endereço do beneficiário (MAX 11; MIN 4).
Exemplo: 111111

withdrawal_method objeto

Especifica o objeto withdrawal_method do beneficiário.

type enum
O tipo withdrawal_method.
Exemplo: ASTROPAY_WALLET

provider_id enum
O provedor com o qual o pagamento será processado.
Exemplo: ASTROPAY

vaulted_token string
O vaulted_token representa um payment_method armazenado de forma segura. Principalmente para cartões de crédito/débito em Payouts.
Exemplo: 41032411d-5df9-429e-1238-ad41abea1cft

original_transaction_id string
Id da transação de pagamento referenciada. Somente para pagamentos ao CARD. (MÁXIMO 64; MÍNIMO 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

on_hold bool
Define se o comerciante deseja reter o pagamento e defini-lo para ser processado posteriormente usando o endpoint Release payout. Falso por padrão.
Exemplo: false

detail objeto

Especifica os detalhes do withdrawal_method.

bank_transfer objeto

Especifica o objeto withdrawal_method do beneficiário.

code string
O código da instituição financeira do beneficiário (MAX 3; MIN 3).
Exemplo: 246

branch string
A agência da instituição financeira específica do beneficiário (MAX 3; MIN 3).
Exemplo: XXX

branch_digit string
O dígito da agência da instituição financeira específica do beneficiário (MAX 3; MIN 3).
Exemplo: 123

account objeto

Especifica o objeto de conta bank_transfer do beneficiário.

number string
Número da conta da instituição financeira do beneficiário ou alias da conta da instituição financeira, como Clabe para MX (MAX 255; MIN 3).
Exemplo: 1093333333

digit string
Dígito da conta da instituição financeira do beneficiário (MAX 3; MIN 1).
Exemplo: 123

type enum
Tipo de conta do beneficiário (MAX 255; MIN 3).
Valores de enum possíveis: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL, PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT

address objeto

Especifica o objeto de endereço do beneficiário.

address_line_1 string
A linha de endereço principal do beneficiário (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78

address_line_2 string
A linha de endereço secundário do beneficiário (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I

city string
A cidade considerada para o endereço do beneficiário (MAX 255; MIN 3).
Exemplo: Bogotá

country enum
O país do endereço do beneficiário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.

state string
O endereço do estado ou da província do beneficiário (MAX 255; MIN 3).
Exemplo: Cundinamarca

zip_code string
O CEP considerado para o endereço do beneficiário (MAX 11; MIN 4).
Exemplo: 111111

wallet objeto

Especifica o objeto withdrawal_method do beneficiário.

code string
O código da carteira do beneficiário (MAX 3; MIN 3).
Exemplo: 246

email string
O email específico da carteira do beneficiário (MAX 3; MIN 3).
Exemplo: [email protected]

country enum
O país da carteira do beneficiário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a referência do país.

document objeto

Especifica o objeto de documento do beneficiário, incluindo seu número e tipo.

document_number string
O número do documento do beneficiário (MAX 40; MIN 3).
Exemplo: 1093333333

document_type enum
O tipo de documento do beneficiário (MAX 6, MIN 2).
Possíveis valores de enum: Verifique a referência do país.

phone objeto

Especifica o objeto de número de telefone do beneficiário.

country_code string
O código de chamada do país do telefone do beneficiário (MAX 3; MIN 1). Valores possíveis: Verifique o Referência do país.
Exemplo: 57

number string
O número de telefone do beneficiário, sem o código de chamada do país (MAX 32; MIN 1).
Exemplo: 3132450765

transactions matriz de objetos

Especifica uma lista de objetos de pagamentos.

id string
O identificador exclusivo da intenção de pagamento (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

type enum
O tipo de intenção de pagamento (MAX 255; MIN 3).

status enum
O status da intenção de pagamento (MAX 255; MIN 3).

response_code enum
O código de resposta indica o status da solicitação de intenção de pagamento (MAX 255; MIN 3).

merchant_reference string
A identificação da transação de pagamento definida pelo comerciante (MAX 255; MIN 3).
Exemplo: AAB01-432245

amount objeto

Especifica o objeto de valor de pagamento, com o valor e a moeda.

value número
O valor do pagamento (múltiplo de 0,0001).
Exemplo: 10000

currency enum
A moeda usada para fazer o pagamento (MAX 3; MIN 3; ISO 4217).
Possíveis valores de enum: Verifique a referência do país.

purpose enum
Especifica a finalidade do pagamento.

description string
Descrição do pagamento (MAX 255; MIN 3).
Exemplo: Salário

provider_data objeto

Especifica o provedor de dados.

id enum
A identificação do provedor de dados.
Valores possíveis: ADDI, MERCADO_PAGO, SPINPAY, WOMPI

transaction_id string
O identificador exclusivo do pagamento do provedor.
Exemplo: 12345678

account_id string
O ID da conta do provedor de pagamento do comerciante.
Exemplo: 9990128

status string
Status do provedor da transação (MAX 255; MIN 3).
Exemplo: credenciado

status_detail string
O status detalhado da transação do provedor de dados (MAX 255; MIN 3).
Exemplo: aprovado

raw_response string
A resposta bruta do provedor de dados. O formato depende da resposta do provedor.
A resposta varia de acordo com cada provedor de dados.

created_at carimbo de data/hora
Data de criação das transações (MAX 27; MIN 27, ISO 8601).
Example: 2022-05-09T20:46:54.786342Z

updated_at carimbo de data/hora
A data de atualização das últimas transações (MAX 27; MIN 27), ISO 8601).
Example: 2022-05-09T20:46:54.786342Z

metadata matriz de objetos

Especifica uma lista de pares de valores-chave personalizados associados ao pagamento (para referências internas, reconciliação ou tags de fluxo de trabalho). Você pode adicionar até 50 objetos de metadados.

metadata object objeto

Especifica uma chave de metadados e o respectivo valor.

Use para anexar o contexto definido pelo comerciante (por exemplo: batch_id, payout_reason). Evite enviar dados confidenciais ou pessoais.

key string
A chave de metadados (MAX 48; MIN 1).
Exemplo: order_id

value string
O valor da chave de metadados (MAX 512; MIN 1).
Exemplo: AA001

created_at carimbo de data/hora
Data de criação das transações (MAX 27; MIN 27, ISO 8601).
Example: 2022-05-09T20:46:54.786342Z

updated_at carimbo de data/hora
A data de atualização das últimas transações (MAX 27; MIN 27), ISO 8601).
Example: 2022-05-09T20:46:54.786342Z