This object represents a recipient who will receive part of a split payment . It represents a seller’s account within your marketplace. The split allows you to disperse the money of a purchase in your marketplace directly to the seller’s account while your commission goes to your marketplace account.
Attributes The unique identifier of the recipient (MAX 64 ; MIN 36). Example: 9104911d-5df9-429e-8488-ad41abea1a4b.
The unique identifier of the account (MAX 64; MIN 36). Example: 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.
The unique identifier of the recipient for the marketplace owner (MAX 255; MIN 3). Example: AAAA01.
Beneficiary’s national entity category. Could be INDIVIDUAL or ENTITY. Example: INDIVIDUAL.
Beneficiary’s national entity type. Could be PUBLIC, GOVERNMENTAL, NON_PROFIT or PRIVATE. Example: PRIVATE.
The recipient’s first name (MAX 255; MIN 3). Example: John.
The recipient’s last name (MAX 255; MIN 3). Example: Doe.
Beneficiary’s name. (Max: 80) Only necessary when national entity is ENTITY (MAX 64 ; MIN 36). Example: Arcos dorados S.A.
The recipient’s date of birth in the YYYY-MM-DD format (MAX 10; MIN 10). Example: 1990-02-28.
The recipient’s industry (MAX 235; MIN 1) For more information access the Industry category reference page. Example: VIRTUAL_GOODS
The merchant category code (MAX 235; MIN 1). Example: TTR
Specifies the recipient’s document object, including its number and type. The recipient’s document number (MAX 40; MIN 3). Example: 1093333333.
The recipient’s document type (MAX 6, MIN 2). Possible enum values: Check the Country Reference . Specifies the recipient’s phone number object. The country code of the recipient’s phone (MAX 3; MIN 2). Example: 57.
The recipient’s phone number, without the country code (MAX 32; MIN 1). Example: 3132450765.
Specifies the recipient’s billing address object. The primary billing address line of the recipient (MAX 255; MIN 3). Example: Calle 34 # 56 - 78.
The secondary billing address line of the recipient (MAX 255; MIN 3). Example: Apartamento 502, Torre I.
The city considered for the billing address (MAX 255; MIN 3). Example: Bogotá.
The state considered for the billing address (MAX 255; MIN 3). Example: Cundinamarca.
The zipcode considered for the billing address (MAX 11; MIN 4). Example: 111111.
A list of withdrawal method objects; each item contains a bank object Bank details for this withdrawal method. Bank’s code (MAX 3; MIN 3). Example: 246
Bank’s branch (MAX 3; MIN 3). Example: 123
Bank’s branch digit (MAX 1; MIN 1). Example: 5
Beneficiary’s bank account number (MAX 250; MIN 3). Example: 1093333333
Beneficiary’s bank account digit (MAX 1; MIN 1). Example: 7
Beneficiary’s bank account type: CHECKINGS or SAVINGS . Example: SAVINGS
Beneficiary’s bank account routing number. Example: 021000021
The bank account’s country (ISO 3166-1 alpha-2). Example: CO
The bank account’s currency (ISO 4217). Example: COP
An array of documentation objects provided by the merchant. The name of the documentation sent (MAX 255; MIN 3). Example: receipt.pdf
The type of the documentation sent by the merchant. Example: RECEIPT
The category of the documentation sent by the merchant (e.g., INVOICE, ID_PROOF).
The content of the documentation encoded in base64 (Max size: 1MB). Example:JVBERi0xLjQKJcfs…
List of onboarding records for each provider connection. The unique identifier of the onboarding. Example: 9104911d-5df9-429e-8488-ad41abea1a4b
Type of onboarding. If done previously or via Yuno. PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDER
Workflow of the onboarding. HOSTED_BY_PROVIDER, HOSTED_BY_YUNO, DIRECT
Status of the vinculation with the merchant. PENDING, SUCCEEDED, DECLINED, BLOCKED, CANCELED, REJECTED, ERROR
Provider response code returned by the provider during onboarding. Example: 00
provider_response_message Descriptive provider message associated with the onboarding response. Example: Approved
Reference to the full raw provider response. Use this identifier to retrieve the complete payload when required. Example: 64b3f8cba12e3c7d9f0a1234
Information about the payment provider connection. Provider identifier. Example: ADYEN
The specific Yuno connection ID associated with that onboarding. Example: 322d48b6-f423-4438-8ffb-0b9b5059a2e9
The unique identifier of the provider’s recipient. Example: 9104911d-5df9-429e-8488-ad41abea1a4b
The legal entity identifier associated with the provider.
Additional information regarding the recipient. Usually the legal entity ID.
The unique identifier of the provider’s balance account.
An array of documentation objects provided by the merchant. The name of the documentation sent (MAX 255; MIN 3). Example: receipt.pdf
The type of the documentation sent by the merchant. Example: RECEIPT
The category of the documentation sent by the merchant.
The content of the documentation encoded in base64 (Max size: 1MB). Example: JVBERi0xLjQKJcfs…
A list of withdrawal method objects; each contains a bank struct. Bank details for this withdrawal method. Bank’s code (MAX 3; MIN 3). Example: 246
Bank’s branch (MAX 3; MIN 3). Example: 123
Bank’s branch digit (MAX 3; MIN 3). Example: 5
Beneficiary’s bank account number (MAX 250; MIN 3). Example: 1093333333
Beneficiary’s bank account digit (MAX 250; MIN 1). Example: 7
Beneficiary’s bank account type: CHECKINGS , SAVINGS Example: SAVINGS
Onboarding creation date (ISO 8601). Example: 2022-05-09T20:46:54.786342Z
Last onboarding updated date (ISO 8601). Example: 2022-07-09T20:43:54.786342Z
Recipient creation date and time (MAX 27; MIN 27; ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z. Last recipient update date and time (MAX 27; MIN 27; ISO 8601 ). Example: 2022-05-09T20:46:54.786342Z. 