Saltar al contenido principal
GET
Obtener destinatario por ID del comercio
Usa GET /v1/recipients?merchant_recipient_id=... para buscar un destinatario por tu ID de destinatario de comercio. La búsqueda se limita a tu organización y no requiere account_id. Una solicitud exitosa devuelve un objeto de destinatario de nivel superior. Si ningún destinatario coincide, el endpoint devuelve HTTP 400 con el código RECIPIENT_NOT_FOUND. El parámetro de consulta merchant_recipient_id es obligatorio. Este endpoint mantiene su comportamiento actual. Las integraciones existentes que lo usan para buscar un destinatario no necesitan cambios. Para una colección paginada, usa Listar destinatarios en GET /v1/recipients/list. Ese endpoint devuelve un arreglo data y pagination, incluido un arreglo vacío cuando ningún destinatario coincide. Las integraciones o tareas cron que necesiten una lista deben usar /list. Para buscar un destinatario por su ID de Yuno, usa Obtener destinatario.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido

Parámetros de consulta

merchant_recipient_id
string
requerido

Identificador del destinatario asignado por el comercio.

Minimum string length: 1

Respuesta

Respuesta exitosa

id
string

El identificador único del destinatario.

Ejemplo:

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

account_id
string

El identificador de cuenta asociado a este destinatario.

Ejemplo:

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

merchant_recipient_id
string

Identificador único del destinatario definido por el comercio.

Ejemplo:

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

national_entity
string

Tipo de entidad nacional del beneficiario.

Ejemplo:

"INDIVIDUAL"

entity_type
string

Tipo de organización del beneficiario.

Ejemplo:

"PRIVATE"

first_name
string

Nombre del beneficiario.

Ejemplo:

"Juan"

last_name
string

Apellido del beneficiario.

Ejemplo:

"Perez"

Razón social del beneficiario.

Ejemplo:

null

email
string

El correo electrónico del beneficiario.

Ejemplo:

"juan.perez@example.com"

date_of_birth
string

Fecha de nacimiento del beneficiario.

Ejemplo:

"1990-01-15"

country
string

El país del beneficiario.

Ejemplo:

"CO"

website
string

La URL del sitio web del vendedor.

Ejemplo:

"https://juanperez.com"

industry
string

El sector del vendedor.

Ejemplo:

"Technology"

merchant_category_code
string

El código de categoría del comercio (MCC) (MAX 235; MIN 1).

Ejemplo:

"5734"

document
object
phone
object
address
object
withdrawal_methods
object
documentation
object[]
onboardings
object[]
split_configuration
object[] | null

Reglas para el cálculo automático del split a nivel de destinatario. Se devuelve como un arreglo que contiene la regla de split actual, aunque las solicitudes envían split_configuration como un objeto. null cuando no hay configuración de split.

created_at
string<date-time>

Fecha de creación del destinatario (ISO 8601 MAX 27; MIN 27).

Ejemplo:

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

updated_at
string<date-time>

Fecha de la última actualización del destinatario (ISO 8601 MAX 27; MIN 27).

Ejemplo:

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