Skip to main content
PATCH
/
recipients
/
{recipient_id}
curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/recipients/{recipient_id} \
  --header 'Content-Type: application/json' \
  --header 'private-secret-key: <api-key>' \
  --header 'public-api-key: <api-key>' \
  --data '
{
  "email": "newemail@example.com",
  "phone": {
    "country_code": "57",
    "number": "9876543210"
  }
}
'
{
  "id": "9104911d-5df9-429e-8488-ad41abea1a4b",
  "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
  "merchant_recipient_id": "AAAA01",
  "national_entity": "INDIVIDUAL",
  "first_name": "John",
  "last_name": "Doe",
  "email": "newemail@example.com",
  "country": "CO",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:45:00Z"
}
Updates an existing recipient. Only specified fields will be updated.

Authorizations

​
public-api-key
string
header
default:<Your public-api-key>
required
​
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

​
recipient_id
string
required

The unique identifier of the recipient

Body

application/json
​
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
enum<string>

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

Available options:
GOVERNMENTAL,
PUBLIC,
NON_PROFIT,
PRIVATE
​
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).

​
email
string

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

​
phone
object
​
address
object
​
withdrawal_methods
object[]
​
documentation
object[]

Array of documentation objects

​
onboardings
object[]

Array of onboarding objects for different payment providers

​
split_configuration
object

Rules for automatic split calculation at the recipient level.

Response

Recipient updated successfully

​
id
string

The unique identifier of the recipient.

Example:

"3aaa4d82-11e8-48ce-8ef5-04eee3a10802"

​
account_id
string

The account identifier associated with this recipient.

Example:

"fe14c7c6-c75e-43b7-bdbe-4c87ad52c482"

​
merchant_recipient_id
string

Unique identifier of the recipient defined by the merchant.

Example:

"MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6"

​
national_entity
string

Beneficiary's national entity type.

Example:

"INDIVIDUAL"

​
entity_type
string

Beneficiary's type of organization.

Example:

"PRIVATE"

​
first_name
string

Beneficiary's name.

Example:

"Juan"

​
last_name
string

Beneficiary's last name.

Example:

"Perez"

​
legal_name
string | null

Beneficiary's legal name.

Example:

null

​
email
string

The Beneficiary's email.

Example:

"juan.perez@example.com"

​
date_of_birth
string

Beneficiary's date of birth.

Example:

"1990-01-15"

​
country
string

The Beneficiary's country.

Example:

"CO"

​
website
string

The seller's website URL.

Example:

"https://juanperez.com"

​
industry
string

The seller's industry.

Example:

"Technology"

​
merchant_category_code
string

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

Example:

"5734"

​
document
object
​
phone
object
​
address
object
​
legal_representatives
object[]
​
withdrawal_methods
object
​
documentation
object[]
​
onboardings
object[]
​
split_configuration
object

Rules for automatic split calculation at the recipient level.

​
created_at
string<date-time>

Recipient creation date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497413Z"

​
updated_at
string<date-time>

Last Recipient updated date (ISO 8601 MAX 27; MIN 27).

Example:

"2025-08-27T15:41:19.497425Z"