This object represents a recipient who will receive part of a split payment. 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 and your commission in your marketplace account.
Attributes
id
string
The unique identifier of the recipient (MAX 64 ; MIN 36).
Example: 9104911d-5df9-429e-8488-ad41abea1a4b.
account_id
string
The unique identifier of the account (MAX 64; MIN 36).
Example: 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.
merchant_recipient_id
string
The unique identifier of the recipient for the marketplace owner (MAX 255; MIN 3).
Example: AAAA01.
national_entity
string
Beneficiary's national entity category. Could be INDIVIDUAL or ENTITY.
Example: INDIVIDUAL.
entity_type
string
Beneficiary's national entity type. Could be PUBLIC, GOVERNMENTAL, NON_PROFIT or PRIVATE.
Example: PRIVATE.
first_name
string
The recipient's first name (MAX 255; MIN 3).
Example: John.
last_name
string
The recipient's last name (MAX 255; MIN 3).
Example: Doe.
legal_name
string
Beneficiary's name. (Max: 80) Only necessary when national entity is ENTITY (MAX 64 ; MIN 36).
Example: Arcos dorados S.A.
email
string
The recipient's e-mail (MAX 255; MIN 3).
Example: [email protected].
date_of_birth
string
The recipient's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).
Example: 1990-02-28.
country
enum
The recipient's country (MAX 2; MIN 2; ISO 3166-1).
Possible enum values: Check the Country Code List.
website
string
The recipient's website URL (MAX 255; MIN 3).
Example: https://www.my-site.com
industry
string
The recipient's industry (MAX 235; MIN 1) For more information access the Industry category reference page.
Example: VIRTUAL_GOODS
merchant_category_code
string
The merchant category code (MAX 235; MIN 1).
Example: TTR
document
object
Specifies the recipient's document object, including its number and type.
document_number
string
The recipient's document number (MAX 40; MIN 3).
Example: 1093333333.
document_type
enum
The recipient's document type (MAX 6, MIN 2).
Possible enum values: Check the Document Type List.
phone
object
Specifies the recipient's phone number object.
country_code
string
The country code of the recipient's phone (MAX 3; MIN 2).
Example: 57.
number
string
The recipient's phone number, without the country code (MAX 32; MIN 1).
Example: 3132450765.
address
object
Specifies the recipient's billing address object.
address_line_1
string
The primary billing address line of the recipient (MAX 255; MIN 3).
Example: Calle 34 # 56 - 78.
address_line_2
string
The secondary billing address line of the recipient (MAX 255; MIN 3).
Example: Apartamento 502, Torre I.
city
string
The city considered for the billing address (MAX 255; MIN 3).
Example: Bogotá.
country
enum
The country considered for the billing address (MAX 2; MIN 2; ISO 3166-1).
Possible enum values: Check the Country Code List.
state
string
The state considered for the billing address (MAX 255; MIN 3).
Example: Cundinamarca.
zip_code
string
The zipcode considered for the billing address (MAX 11; MIN 4).
Example: 111111.
withdrawal_methods
array of objects
A list of withdrawal method objects; each item contains a bank object
bank
struct
Bank details for this withdrawal method.
code
string
Bank’s code (MAX 3; MIN 3).
Example: 246
branch
string
Bank’s branch (MAX 3; MIN 3).
Example: 123
branch_digit
string
Bank’s branch digit (MAX 1; MIN 1).
Example: 5
account
string
Beneficiary’s bank account number (MAX 250; MIN 3).
Example: 1093333333
account_digit
string
Beneficiary’s bank account digit (MAX 1; MIN 1).
Example: 7
account_type
enum
Beneficiary’s bank account type: CHECKINGS
or SAVINGS
.
Example: SAVINGS
routing
string
Beneficiary’s bank account routing number.
Example: 021000021
country
string
The bank account’s country (ISO 3166-1 alpha-2).
Example: CO
currency
string
The bank account’s currency (ISO 4217).
Example: COP
documentation
array of objects
An array of documentation objects provided by the merchant.
file_name
string
The name of the documentation sent (MAX 255; MIN 3).
Example: receipt.pdf
Example: receipt.pdf
content_type
enum
The type of the documentation sent by the merchant.
Example: RECEIPT
Example: RECEIPT
content_category
string
The category of the documentation sent by the merchant (e.g., INVOICE, ID_PROOF).
content
string
The content of the documentation encoded in base64 (Max size: 1MB).
Example:JVBERi0xLjQKJcfs…
Example:JVBERi0xLjQKJcfs…
onboardings
array of objects
List of onboarding records for each provider connection.
id
enum
The unique identifier of the onboarding.
Example: 9104911d-5df9-429e-8488-ad41abea1a4b
type
enum
Type of onboarding. If done previously or via Yuno.
PREVIOUSLY_ONBOARDED, ONBOARD_ONTO_THE_PROVIDER
workflow
enum
Workflow of the onboarding.
HOSTED_BY_PROVIDER, HOSTED_BY_YUNO, DIRECT
status
enum
Status of the vinculation with the merchant.
PENDING, SUCCEEDED, DECLINED, BLOCKED, CANCELED, REJECTED, ERROR
callback_url
string
URL to redirect your customer after the onboarding process, if needed.
Example: https://www.google.com
provider
object
Information about the payment provider connection.
id
string
Provider identifier.
Example: PAGARME
redirect_url
string
URL to redirect your recipient to finalize the onboarding.
Example: https://www.stripe.com
recipient_id
string
The unique identifier of the provider's recipient.
Example: AAAAA01
documentation
array of objects
An array of documentation objects provided by the merchant.
file_name
string
The name of the documentation sent (MAX 255; MIN 3).
Example: receipt.pdf
content_type
enum
The type of the documentation sent by the merchant.
Example: RECEIPT
content_category
string
The category of the documentation sent by the merchant.
content
string
The content of the documentation encoded in base64 (Max size: 1MB).
Example: JVBERi0xLjQKJcfs…
withdrawal_methods
array of objects
A list of withdrawal method objects; each contains a bank
struct.
bank
struct.
bank
struct
Bank details for this withdrawal method.
code
string
Bank’s code (MAX 3; MIN 3).
Example: 246
branch
string
Bank’s branch (MAX 3; MIN 3).
Example: 123
branch_digit
string
Bank’s branch digit (MAX 3; MIN 3).
Example: 5
account
string
Beneficiary’s bank account number (MAX 250; MIN 3).
Example: 1093333333
account_digit
string
Beneficiary’s bank account digit (MAX 250; MIN 1).
Example: 7
account_type
enum
Beneficiary’s bank account type: CHECKINGS
, SAVINGS
Example: SAVINGS
created_at
timestamp
Onboarding creation date (ISO 8601).
Example: 2022-05-09T20:46:54.786342Z
updated_at
timestamp
Last onboarding updated date (ISO 8601).
Example: 2022-07-09T20:43:54.786342Z
created_at
timestamp
Recipient creation date and time (MAX 27; MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.
updated_at
timestamp
Last recipient update date and time (MAX 27; MIN 27; ISO 8601).
Example: 2022-05-09T20:46:54.786342Z.