Create Recipient

post

https://api-sandbox.y.uno/v1/recipients

Creates a new recipient for split payment scenarios. This endpoint allows merchants to define recipients that can receive portions of payments in marketplace or split payment models.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_id

string

required

Unique id of the account in Yuno (MAX 64; MIN 36).

merchant_recipient_id

string

required

Unique identifier of the recipient defined by the merchant (MAX 255; MIN 1).

national_entity

string

enum

required

Beneficiary's national entity type. Could be INDIVIDUAL or ENTITY.

Allowed:

entity_type

string

enum

The Beneficiary's type of organization. GOVERNMENTAL, PUBLIC, NON_PROFIT, PRIVATE

Allowed:

first_name

string

required

Beneficiary's name. (MAX 80; MIN 1).

last_name

string

required

Beneficiary's last name. (MAX 80; MIN 1).

date_of_birth

string

length between 10 and 10

The Beneficiary's date of birth in the YYYY-MM-DD format (MAX 10; MIN 10).

legal_name

string

Beneficiary's name. (MAX 80; MIN 1) Only necessary when national entity is ENTITY.

string

The Beneficiary's email (MAX 255; MIN 3).

country

string

required

The Beneficiary's country (ISO 3166-1 MAX 2; MIN 2).

website

string

length between 3 and 255

The seller's website URL (MAX 255; MIN 3).

industry

string

length between 1 and 235

The seller's industry (MAX 235; MIN 1). For more information access the Industry category reference page.

merchant_category_code

string

MCC - The merchant category code (MAX 235; MIN 1).

document

object

Beneficiary's document information

phone

object

Specifies the customer's phone number object.

address

object

Address

legal_representatives

array of objects

Owners/beneficials of the recipient. Required when national_entity = ENTITY.

legal_representatives

withdrawal_methods

object

Withdrawal methods for the merchant

documentation

array of objects

Array of documentation objects

documentation

onboardings

array of objects

Array of onboarding objects for different payment providers

onboardings

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Recipient created successfully

400Bad Request

401Unauthorized

403Forbidden