> ## Documentation Index
> Fetch the complete documentation index at: https://docs.y.uno/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Test in the sandbox first: base URL https://api-sandbox.y.uno (Test Mode in the Dashboard). Production is https://api.y.uno (Live Mode).
> Every API request needs the public-api-key and private-secret-key headers. Get them in the Dashboard at https://dashboard.y.uno/developers (Developers > Credentials); sandbox and production keys are different.
> Send an X-Idempotency-Key (a UUID) when creating payments, refunds and cancels, so retries do not create duplicates.
> Start with the Quickstart (https://docs.y.uno/docs/quickstart.md) and the agent guide (https://docs.y.uno/agents.md). To search these docs from a coding agent, connect the docs MCP server at https://docs.y.uno/mcp.

# El objeto destinatario

> Consulta los atributos del objeto destinatario, incluidos los onboardings, los datos bancarios y la documentación

Este objeto representa a un destinatario que recibirá una parte de un [pago dividido](https://docs.y.uno/es/docs/payment-features/split-payments-marketplace.md). Representa la cuenta de un vendedor dentro de tu marketplace. La división te permite dispersar el dinero de una compra en tu marketplace directamente a la cuenta del vendedor, mientras tu comisión va a la cuenta de tu marketplace.

## Atributos

**id** `string`

El identificador único del destinatario (MAX 64 ; MIN 36).

Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b.

**account\_id** `string`

El identificador único de la cuenta (MAX 64; MIN 36).

Ejemplo: 4323f8a0-7699-4a5b-8293-f4d712312eb3bd.

**merchant\_recipient\_id** `string`

El identificador único del destinatario para el dueño del marketplace (MAX 255; MIN 3).

Ejemplo: AAAA01.

**national\_entity** `string`

Categoría de entidad nacional del beneficiario. Puede ser INDIVIDUAL o ENTITY.

Ejemplo: INDIVIDUAL.

**entity\_type** `string`

Tipo de entidad nacional del beneficiario. Puede ser PUBLIC, GOVERNMENTAL, NON\_PROFIT o PRIVATE.

Ejemplo: PRIVATE.

**first\_name** `string`

El nombre del destinatario (MAX 255; MIN 3).

Ejemplo: John.

**last\_name** `string`

El apellido del destinatario (MAX 255; MIN 3).

Ejemplo: Doe.

**legal\_name** `string`

Nombre del beneficiario. (Max: 80) Solo es necesario cuando la entidad nacional es ENTITY (MAX 64 ; MIN 36).

Ejemplo: Arcos dorados S.A.

**email** `string`

El correo electrónico del destinatario (MAX 255; MIN 3).

Ejemplo: [john.doe@email.com](mailto:john.doe@email.com).

**date\_of\_birth** `string`

La fecha de nacimiento del destinatario en formato YYYY-MM-DD (MAX 10; MIN 10).

Ejemplo: 1990-02-28.

**country** `enum`

El país del destinatario (MAX 2; MIN 2; [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) ).

Valores posibles del enum: Consulta la [lista de códigos de país](https://docs.y.uno/es/reference/country-reference.md).

**website** `string`

La URL del sitio web del destinatario (MAX 255; MIN 3).

Ejemplo: [https://www.my-site.com](https://www.my-site.com)

**industry** `string`

La industria del destinatario (MAX 235; MIN 1). Para más información, accede a la página de referencia de categorías de industria.

Ejemplo: VIRTUAL\_GOODS

**merchant\_category\_code** `string`

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

Ejemplo: TTR

**document** `object`

Especifica el objeto de documento del destinatario, incluidos su número y tipo.

**propiedades**

**document\_number** `string`

El número de documento del destinatario (MAX 40; MIN 3).

Ejemplo: 1093333333.

**document\_type** `enum`

El tipo de documento del destinatario (MAX 6, MIN 2).

Valores posibles del enum: Consulta la [referencia de países](https://docs.y.uno/es/reference/country-reference.md).

**phone** `object`

Especifica el objeto de número de teléfono del destinatario.

**propiedades**

**country\_code** `string`

El código de país del teléfono del destinatario (MAX 3; MIN 2).

Ejemplo: 57.

**number** `string`

El número de teléfono del destinatario, sin el código de país (MAX 32; MIN 1).

Ejemplo: 3132450765.

**address** `object`

Especifica el objeto de dirección de facturación del destinatario.

**propiedades**

**address\_line\_1** `string`

La línea principal de la dirección de facturación del destinatario (MAX 255; MIN 3).

Ejemplo: Calle 34 # 56 - 78.

**address\_line\_2** `string`

La línea secundaria de la dirección de facturación del destinatario (MAX 255; MIN 3).

Ejemplo: Apartamento 502, Torre I.

**city** `string`

La ciudad considerada para la dirección de facturación (MAX 255; MIN 3).

Ejemplo: Bogotá.

**country** `enum`

El país considerado para la dirección de facturación (MAX 2; MIN 2; [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) ).

Valores posibles del enum: Consulta la [lista de códigos de país](https://docs.y.uno/es/reference/country-reference.md).

**state** `string`

El estado considerado para la dirección de facturación (MAX 255; MIN 3).

Ejemplo: Cundinamarca.

**zip\_code** `string`

El código postal considerado para la dirección de facturación (MAX 11; MIN 4).

Ejemplo: 111111.

**withdrawal\_methods** `array of objects`

Una lista de objetos de método de retiro; cada elemento contiene un objeto bank

**propiedades**

**bank** `struct`

Datos bancarios de este método de retiro.

**propiedades**

**code** `string`

Código del banco (MAX 3; MIN 3).

Ejemplo: 246

**branch** `string`

Sucursal del banco (MAX 3; MIN 3).

Ejemplo: 123

**branch\_digit** `string`

Dígito de la sucursal del banco (MAX 1; MIN 1).

Ejemplo: 5

**account** `string`

Número de cuenta bancaria del beneficiario (MAX 250; MIN 3).

Ejemplo: 1093333333

**account\_digit** `string`

Dígito de la cuenta bancaria del beneficiario (MAX 1; MIN 1).

Ejemplo: 7

**account\_type** `enum`

Tipo de cuenta bancaria del beneficiario: `CHECKINGS` o `SAVINGS` .

Ejemplo: SAVINGS

**routing** `string`

Número de enrutamiento de la cuenta bancaria del beneficiario.

Ejemplo: 021000021

**country** `string`

El país de la cuenta bancaria (ISO 3166-1 alpha-2).

Ejemplo: CO

**currency** `string`

La moneda de la cuenta bancaria (ISO 4217).

Ejemplo: COP

**documentation** `array of objects`

Un arreglo de objetos de documentación proporcionados por el comercio.

**propiedades**

**file\_name** `string`

El nombre de la documentación enviada (MAX 255; MIN 3).

Ejemplo: receipt.pdf

**content\_type** `enum`

El tipo de documentación enviada por el comercio.

Ejemplo: RECEIPT

**content\_category** `string`

La categoría de la documentación enviada por el comercio (por ejemplo, INVOICE, ID\_PROOF).

**content** `string`

El contenido de la documentación codificado en base64 (Tamaño máximo: 1MB).

Ejemplo:JVBERi0xLjQKJcfs…

**onboardings** `array of objects`

Lista de registros de onboarding para cada conexión con un proveedor.

**propiedades**

**id** `string`

El identificador único del onboarding.

Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

**type** `enum`

Tipo de onboarding. Si se hizo previamente o mediante Yuno.

PREVIOUSLY\_ONBOARDED, ONBOARD\_ONTO\_THE\_PROVIDER

**workflow** `enum`

Flujo de trabajo del onboarding.

HOSTED\_BY\_PROVIDER, HOSTED\_BY\_YUNO, DIRECT

**status** `enum`

Estado de la vinculación con el comercio.

PENDING, SUCCEEDED, DECLINED, BLOCKED, CANCELLED, REJECTED, ERROR

**provider\_response\_code** `string`

Código de respuesta del proveedor devuelto por el proveedor durante el onboarding.

Ejemplo: 00

**provider\_response\_message** `string`

Mensaje descriptivo del proveedor asociado con la respuesta del onboarding.

Ejemplo: Approved

**provider\_raw\_response** `string`

Referencia a la respuesta completa sin procesar del proveedor. Usa este identificador para obtener el payload completo cuando sea necesario.

Ejemplo: 64b3f8cba12e3c7d9f0a1234

**callback\_url** `string`

URL a la que redirigir a tu cliente después del proceso de onboarding, si es necesario.

Ejemplo: [https://www.google.com](https://www.google.com)

**provider** `object`

Información sobre la conexión con el proveedor de pago.

**propiedades**

**id** `string`

Identificador del proveedor.

Ejemplo: ADYEN

**connection\_id** `string`

El ID de conexión de Yuno específico asociado con ese onboarding.

Ejemplo: 322d48b6-f423-4438-8ffb-0b9b5059a2e9

**recipient\_id** `string`

El identificador único del destinatario del proveedor.

Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

**redirect\_url** `string`

URL de redirección a la que se enviará al usuario final cuando termine el onboarding.

Ejemplo: [https://www.example.com/callback](https://www.example.com/callback)

**onboarding\_url** `string`

URL a la que redirigir a tu destinatario para finalizar el onboarding.

Ejemplo: [https://www.provider.com/onboarding](https://www.provider.com/onboarding)

**legal\_entity** `string`

El identificador de la entidad legal asociado con el proveedor.

**recipient\_additional\_id** `string`

Información adicional sobre el destinatario. Normalmente es el ID de la entidad legal.

**balance\_account\_id** `string`

El identificador único de la cuenta de saldo del proveedor.

**documentation** `array of objects`

Un arreglo de objetos de documentación proporcionados por el comercio.

**propiedades**

**file\_name** `string`

El nombre de la documentación enviada (MAX 255; MIN 3).

Ejemplo: receipt.pdf

**content\_type** `enum`

El tipo de documentación enviada por el comercio.

Ejemplo: RECEIPT

**content\_category** `string`

La categoría de la documentación enviada por el comercio.

**content** `string`

El contenido de la documentación codificado en base64 (Tamaño máximo: 1MB).

Ejemplo: JVBERi0xLjQKJcfs…

**withdrawal\_methods** `array of objects`

Una lista de objetos de método de retiro; cada uno contiene una estructura `bank`.

**propiedades**

**bank** `struct`

Datos bancarios de este método de retiro.

**propiedades**

**code** `string`

Código del banco (MAX 3; MIN 3).

Ejemplo: 246

**branch** `string`

Sucursal del banco (MAX 3; MIN 3).

Ejemplo: 123

**branch\_digit** `string`

Dígito de la sucursal del banco (MAX 3; MIN 3).

Ejemplo: 5

**account** `string`

Número de cuenta bancaria del beneficiario (MAX 250; MIN 3).

Ejemplo: 1093333333

**account\_digit** `string`

Dígito de la cuenta bancaria del beneficiario (MAX 250; MIN 1).

Ejemplo: 7

**account\_type** `enum`

Tipo de cuenta bancaria del beneficiario: `CHECKINGS` , `SAVINGS`

Ejemplo: SAVINGS

**created\_at** `timestamp`

Fecha de creación del onboarding (ISO 8601).

Ejemplo: 2022-05-09T20:46:54.786342Z

**updated\_at** `timestamp`

Fecha de la última actualización del onboarding (ISO 8601).

Ejemplo: 2022-07-09T20:43:54.786342Z

**created\_at** `timestamp`

Fecha y hora de creación del destinatario (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ).

Ejemplo: 2022-05-09T20:46:54.786342Z.

**updated\_at** `timestamp`

Fecha y hora de la última actualización del destinatario (MAX 27; MIN 27; [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ).

Ejemplo: 2022-05-09T20:46:54.786342Z.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.