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

# Obtener onboarding

> Obtén el estado actual y los detalles del onboarding específico de un destinatario

Obtiene información detallada sobre un onboarding específico de un destinatario.

Este endpoint obtiene información detallada sobre un onboarding específico de un destinatario en el [marketplace de pagos con split](https://docs.y.uno/es/docs/payment-features/split-payments-marketplace.md). Usa este endpoint para consultar el estado actual, la configuración y los detalles de un onboarding existente.

Este endpoint requiere un onboarding existente creado mediante [Create Onboarding](https://docs.y.uno/es/reference/recipients-for-marketplace/create-onboarding.md).


## OpenAPI

````yaml openapi/es/recipients-for-marketplace/get-onboarding.json GET /recipients/{recipient_id}/onboardings/{onboarding_id}
openapi: 3.1.0
info:
  title: Recipients API
  version: 1.0.0
  description: >-
    API for managing recipients in split payment scenarios. This feature enables
    merchants to split payments among multiple recipients, which is particularly
    beneficial for marketplace models where transactions need to be divided
    among different sellers or stakeholders.
servers:
  - url: https://api-sandbox.y.uno/v1
    description: Sandbox
  - url: https://api.y.uno/v1
    description: Production (US)
security:
  - sec0: []
    sec1: []
paths:
  /recipients/{recipient_id}/onboardings/{onboarding_id}:
    get:
      summary: Obtener onboarding
      operationId: get-onboarding
      parameters:
        - in: path
          name: recipient_id
          description: ID del destinatario
          schema:
            type: string
          required: true
          example: 9104911d-5df9-429e-8488-ad41abea1a4b
        - in: path
          name: onboarding_id
          description: ID del onboarding que se va a obtener
          schema:
            type: string
          required: true
          example: 9104911d-5df9-429e-8488-ad41abea1a4b
      responses:
        '200':
          description: Detalles del onboarding obtenidos correctamente
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único del onboarding
                    example: 9104911d-5df9-429e-8488-ad41abea1a4b
                  account_id:
                    type: string
                    description: ID único de la cuenta en Yuno
                    example: 9104911d-5df9-429e-8488-ad41abea1a4b
                  recipient_id:
                    type: string
                    description: El identificador único del destinatario
                    example: 9104911d-5df9-429e-8488-ad41abea1a4b
                  type:
                    type: string
                    enum:
                      - PREVIOUSLY_ONBOARDED
                      - ONE_STEP_ONBOARDING
                      - TWO_STEP_ONBOARDING
                    description: Tipo de flujo de onboarding
                    example: PREVIOUSLY_ONBOARDED
                  workflow:
                    type: string
                    enum:
                      - HOSTED_BY_PROVIDER
                      - HOSTED_BY_YUNO
                      - DIRECT
                    description: Flujo del onboarding
                    example: HOSTED_BY_PROVIDER
                  status:
                    type: string
                    description: Estado actual del onboarding
                    example: ACTIVE
                  callback_url:
                    type: string
                    format: uri
                    description: URL a la que redirigir después del proceso de onboarding
                    example: https://www.google.com
                  provider:
                    type: object
                    properties:
                      id:
                        type: string
                        description: ID del proveedor
                        example: PAGARME
                      connection_id:
                        type: string
                        description: ID de la conexión en Yuno
                        example: 9104911d-5df9-429e-8488-ad41abea1a4b
                      recipient_id:
                        type: string
                        description: Identificador único del destinatario del proveedor
                        example: AAAAA01
                  created_at:
                    type: string
                    format: date-time
                    description: Fecha de creación del onboarding
                    example: '2024-01-15T10:30:00Z'
                  updated_at:
                    type: string
                    format: date-time
                    description: Fecha de la última actualización del onboarding
                    example: '2024-01-15T10:30:00Z'
              examples:
                Success Response:
                  value:
                    id: 9104911d-5df9-429e-8488-ad41abea1a4b
                    account_id: 9104911d-5df9-429e-8488-ad41abea1a4b
                    recipient_id: 9104911d-5df9-429e-8488-ad41abea1a4b
                    type: PREVIOUSLY_ONBOARDED
                    workflow: HOSTED_BY_PROVIDER
                    status: SUCCEEDED
                    callback_url: https://www.google.com
                    provider:
                      id: PAGARME
                      connection_id: 9104911d-5df9-429e-8488-ad41abea1a4b
                      recipient_id: AAAAA01
                    created_at: '2024-01-15T10:30:00Z'
                    updated_at: '2024-01-15T10:30:00Z'
        '401':
          description: No autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Unauthorized:
                  value:
                    code: INVALID_CREDENTIALS
                    messages:
                      - Invalid credentials
        '403':
          description: Prohibido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Forbidden:
                  value:
                    code: AUTHORIZATION_REQUIRED
                    messages:
                      - The merchant has no authorization to use this API.
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          example: INVALID_REQUEST
        messages:
          type: array
          items:
            type: string
            example: Invalid request
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: public-api-key
      x-default: <Your public-api-key>
    sec1:
      type: apiKey
      in: header
      name: private-secret-key
      x-default: <Your private-secret-key>

````

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