Esse objeto representa um destinatário que receberá parte de um pagamento dividido. Ele representa a conta de um vendedor em seu marketplace. A divisão permite que você distribua o dinheiro de uma compra em seu marketplace diretamente para a conta do vendedor, enquanto sua comissão vai para sua conta do marketplace.
Atributos
id string
O identificador exclusivo do destinatário (MAX 64; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b.
account_id string
O identificador exclusivo da conta (MAX 64; MIN 36).
Exemplo: 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.
merchant_recipient_id string
O identificador exclusivo do destinatário para o proprietário do marketplace (MAX 255; MIN 3).
Exemplo: AAAA01.
national_entity string
Categoria de entidade nacional do beneficiário. Pode ser INDIVIDUAL ou ENTIDADE.
Exemplo: INDIVIDUAL.
entity_type string
Tipo de entidade nacional do beneficiário. Pode ser PÚBLICA, GOVERNAMENTAL, SEM FINS LUCRATIVOS ou PRIVADA.
Exemplo: PRIVATE.
first_name string
O primeiro nome do destinatário (MAX 255; MIN 3).
Exemplo: John.
last_name string
O sobrenome do destinatário (MAX 255; MIN 3).
Exemplo: Doe.
legal_name string
Nome do beneficiário. (Máx: 80) Necessário somente quando a entidade nacional for ENTITY (MAX 64; MIN 36).
Exemplo: Arcos dorados S.A.
email string
O e-mail do destinatário (MAX 255; MIN 3).
Exemplo: [email protected].
date_of_birth string
A data de nascimento do destinatário no formato AAAA-MM-DD (MAX 10; MIN 10).
Exemplo: 1990-02-28.
country enum
O país do destinatário (MAX 2; MIN 2; ISO 3166-1).
Possíveis valores de enum: Verifique a Lista de códigos de país.
website string
URL do site do destinatário (MAX 255; MIN 3).
Exemplo: https://www.my-site.com
industry string
O setor do destinatário (MAX 235; MIN 1) Para obter mais informações, acesse a página de referência da categoria Setor.
Exemplo: VIRTUAL_GOODS
merchant_category_code string
O código da categoria do comerciante (MAX 235; MIN 1).
Exemplo: TTR
document objeto
Especifica o objeto de documento do destinatário, incluindo seu número e tipo.
document_number string
O número do documento do destinatário (MAX 40; MIN 3).
Exemplo: 1093333333.
document_type enum
O tipo de documento do destinatário (MAX 6, MIN 2).
Possíveis valores de enum: Verificar a referência do país.
phone objeto
Especifica o objeto de número de telefone do destinatário.
country_code string
O código do país do telefone do destinatário (MAX 3; MIN 2).
Exemplo: 57.
number string
O número de telefone do destinatário, sem o código do país (MAX 32; MIN 1).
Exemplo: 3132450765.
address objeto
Especifica o objeto de endereço de cobrança do destinatário.
address_line_1 string
A linha do endereço de cobrança principal do destinatário (MAX 255; MIN 3).
Exemplo: Calle 34 # 56 - 78.
address_line_2 string
A linha de endereço de faturamento secundário do destinatário (MAX 255; MIN 3).
Exemplo: Apartamento 502, Torre I.
city string
A cidade considerada para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Bogotá.
country enum
O país considerado para o endereço de cobrança (MAX 2; MIN 2); ISO 3166-1).
Possíveis valores de enum: Verifique a Lista de códigos de país.
state string
O estado considerado para o endereço de cobrança (MAX 255; MIN 3).
Exemplo: Cundinamarca.
zip_code string
O código postal considerado para o endereço de cobrança (MAX 11; MIN 4).
Exemplo: 111111.
withdrawal_methods matriz de objetos
Uma lista de objetos de método de saque; cada item contém um objeto de banco
bank estrutura
Dados bancários para esse método de saque.
code string
Código do banco (MAX 3; MIN 3).
Exemplo: 246
branch string
Agência do banco (MAX 3; MIN 3).
Exemplo: 123
branch_digit string
Dígito da agência do banco (MAX 1; MIN 1).
Exemplo: 5
account string
Número da conta bancária do beneficiário (MAX 250; MIN 3).
Exemplo: 1093333333
account_digit string
Dígito da conta bancária do beneficiário (MAX 1; MIN 1).
Exemplo: 7
account_type enum
Tipo de conta bancária do beneficiário: CHECKINGS ou SAVINGS.
Exemplo: POUPANÇA
routing string
Número de roteamento da conta bancária do beneficiário.
Exemplo: 021000021
country string
O país da conta bancária (ISO 3166-1 alfa-2).
Exemplo: CO
currency string
A moeda da conta bancária (ISO 4217).
Exemplo: COP
documentation matriz de objetos
Uma matriz de objetos de documentação fornecidos pelo comerciante.
file_name string
O nome da documentação enviada (MAX 255; MIN 3).
Exemplo: receipt.pdf
Exemplo: receipt.pdf
content_type enum
O tipo de documentação enviada pelo comerciante.
Exemplo: RECIBO
Exemplo: RECIBO
content_category string
A categoria da documentação enviada pelo comerciante (por exemplo, INVOICE, ID_PROOF).
content string
O conteúdo da documentação codificado em base64 (tamanho máximo: 1 MB).
Exemplo:JVBERi0xLjQKJcfs...
Exemplo:JVBERi0xLjQKJcfs...
onboardings matriz de objetos
Lista de registros de integração para cada conexão de provedor.
id enum
O identificador exclusivo da integração.
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
type enum
Tipo de integração. Se feito anteriormente ou via Yuno.
PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDER
workflow enum
Fluxo de trabalho da integração.
HOSTED_BY_PROVIDER, HOSTED_BY_YUNO, DIRECT
status enum
Status da vinculação com o comerciante.
PENDING, SUCCEEDED, DECLINED, BLOQUEADO, CANCELADO, REJECTED, ERROR
provider_response_code string
Código de resposta do provedor retornado pelo provedor durante a integração.
Exemplo: 00
provider_response_message string
Mensagem descritiva do provedor associada à resposta de integração.
Exemplo: Aprovado
provider_raw_response string
Referência à resposta completa do provedor. Use este identificador para recuperar a carga útil completa quando necessário.
Exemplo: 64b3f8cba12e3c7d9f0a1234
callback_url string
URL para redirecionar seu cliente após o processo de integração, se necessário.
Exemplo: https://www.google.com
provider objeto
Informações sobre a conexão do provedor de pagamento.
id string
Identificador do provedor.
Exemplo: ADYEN
connection_id string
O ID de conexão específico do Yuno associado a essa integração.
Exemplo: 322d48b6-f423-4438-8ffb-0b9b5059a2e9
recipient_id string
O identificador exclusivo do destinatário do provedor.
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
redirect_url string
URL de redirecionamento para onde o usuário final será redirecionado assim que a integração for concluída.
Exemplo: https://www.example.com/callback
onboarding_url string
URL para redirecionar seu destinatário para finalizar a integração.
Exemplo: https://www.provider.com/onboarding
legal_entity string
O identificador da entidade jurídica associado ao provedor.
recipient_additional_id string
Informações adicionais sobre o destinatário. Normalmente, o número de identificação da pessoa jurídica.
balance_account_id string
O identificador único da conta de saldo do provedor.
documentation matriz de objetos
Uma matriz de objetos de documentação fornecidos pelo comerciante.
file_name string
O nome da documentação enviada (MAX 255; MIN 3).
Exemplo: receipt.pdf
content_type enum
O tipo de documentação enviada pelo comerciante.
Exemplo: RECEITA
content_category string
A categoria da documentação enviada pelo comerciante.
content string
O conteúdo da documentação codificado em base64 (tamanho máximo: 1 MB).
Exemplo: JVBERi0xLjQKJcfs...
withdrawal_methods matriz de objetos
Uma lista de objetos de método de retirada; cada um contém um bank estrutura.
bank estrutura.
bank estrutura
Dados bancários para esse método de saque.
code string
Código do banco (MAX 3; MIN 3).
Exemplo: 246
branch string
Agência do banco (MAX 3; MIN 3).
Exemplo: 123
branch_digit string
Dígito da agência do banco (MAX 3; MIN 3).
Exemplo: 5
account string
Número da conta bancária do beneficiário (MAX 250; MIN 3).
Exemplo: 1093333333
account_digit string
Dígito da conta bancária do beneficiário (MAX 250; MIN 1).
Exemplo: 7
account_type enum
Tipo de conta bancária do beneficiário: CHECKINGS, SAVINGS
Exemplo: POUPANÇA
created_at carimbo de data/hora
Data de criação da integração (ISO 8601).
Example: 2022-05-09T20:46:54.786342Z
updated_at carimbo de data/hora
Data de atualização da última integração (ISO 8601).
Example: 2022-07-09T20:43:54.786342Z
created_at carimbo de data/hora
Data e hora de criação do destinatário (MAX 27; MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.
updated_at carimbo de data/hora
Data e hora da última atualização do destinatário (MAX 27; MIN 27); ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.