Update Recipient

patch

https://api-sandbox.y.uno/v1/recipients/{recipient_id}

Updates an existing recipient. Only specified fields will be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

recipient_id

string

required

The unique identifier of the recipient

Body Params

merchant_recipient_id

string

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

first_name

string

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

last_name

string

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

date_of_birth

string

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

entity_type

string

enum

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

Allowed:

website

string

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

industry

string

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).

string

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

phone

object

address

object

withdrawal_methods

array of objects

withdrawal_methods

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

200Recipient updated successfully

400Bad Request

401Unauthorized

403Forbidden