Skip to main content
PATCH

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

Unique identifier of the recipient.

Cuerpo

application/json
alias
string | null

Label you assign to the recipient. Send null or a blank string to clear it.

Ejemplo:

"Test recipient"

holder_name
string

Account holder name. Up to 40 characters.

Ejemplo:

"Test Customer 1"

holder_type
enum<string>

Account holder category. One of person or company.

Opciones disponibles:
person,
company
Ejemplo:

"person"

account_type
enum<string>

Destination account type. Chile only. One of checking_account, sight_account, or savings_account.

Opciones disponibles:
checking_account,
sight_account,
savings_account
Ejemplo:

"checking_account"

email
string | null

Contact email address in name@example.com format. Up to 200 characters. Send null or a blank string to clear it.

Ejemplo:

"recipient@example.com"

Respuesta

The recipient object.

A recipient represents a saved destination account for an entity. The recipient contains the account holder, institution, and account details for the destination in Chile or Mexico.

id
string
requerido

Unique identifier of the recipient.

Ejemplo:

"rcp_2hQ9vBmKpR7xLtZ3sWn1fJ4dGcA"

object
any
requerido

Type of the object. Always recipient.

account_number
string
requerido

Destination bank account number. In Mexico, an 18-digit standardized Mexican bank account number (CLABE), a 16-digit debit card number, or a 10-digit mobile number.

Ejemplo:

"000000000000000000"

account_type
enum<string> | null
requerido

Destination account type, in lowercase. In Mexico, inferred from account_number. Returns null when unknown. One of clabe, debit_card, mobile, vostro_account, vostro_account1, vostro_account2, vostro_account3, vostro_account4, values_custody, institution, checking_account, sight_account, and savings_account.

Opciones disponibles:
clabe,
debit_card,
mobile,
vostro_account,
vostro_account1,
vostro_account2,
vostro_account3,
vostro_account4,
values_custody,
institution,
checking_account,
sight_account,
savings_account,
null
Ejemplo:

"clabe"

alias
string | null
requerido

Label you assign to the recipient, or null when none is set.

Ejemplo:

"Test recipient"

created_at
string<date-time>
requerido

Time you created the recipient, as an ISO 8601 datetime in UTC.

Ejemplo:

"2026-03-01T12:00:00Z"

email
string | null
requerido

Contact email address, or null when none is set.

Ejemplo:

"recipient@example.com"

holder_id
string | null
requerido

Account holder identification. In Chile, the Chilean tax ID (RUT). Cannot change after creation. Returns null when none is set.

Ejemplo:

"111111111"

holder_name
string | null
requerido

Account holder name, or null when unavailable.

Ejemplo:

"Test Customer 1"

holder_type
enum<string>
requerido

Account holder category. One of person, company, or unknown.

Opciones disponibles:
person,
company,
unknown
Ejemplo:

"person"

institution
object
requerido

Financial institution that holds the destination account.

updated_at
string<date-time>
requerido

Time you last updated the recipient, as an ISO 8601 datetime in UTC.

Ejemplo:

"2026-03-01T12:00:00Z"