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.
providers array of objects
Specifies the provider object. Only necessary when using a third party split. If not, you´ll need to complete the rest of the recipient fields.
recipient_id string
The unique identifier of the provider's recipient.
Example: 12445.
id string
The unique identifier of the provider.
Example: PAGARME.
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 type. Could be INDIVIDUAL or ENTITY (MAX 64 ; MIN 36).
Example: INDIVIDUAL.
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].
country enum
The recipient's country (MAX 2; MIN 2; ISO 3166-1).
Possible enum values: Check the Country Code List.
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.
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.