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

# Recuperar la personalización de instrucciones de un proveedor

> Devuelve las instrucciones de conexión personalizadas almacenadas para un proveedor: la lectura enfocada que carga un editor antes de guardar.

Devuelve las instrucciones de conexión personalizadas que has almacenado para este proveedor: la lectura enfocada que carga un editor antes de guardar.

Un proveedor sin personalización responde `404`. Usa [Retrieve a Provider Overlay](https://docs.y.uno/es/reference/organizations/whitelabel/retrieve-provider.md), que nunca devuelve 404, cuando quieras la capa sin importar si existe una personalización.

> [!NOTE]
>
> Un campo que no personalizas está **ausente**: no es `null` ni una lista vacía. Ausente significa "conserva el valor del catálogo de Yuno"; presente y vacío significa "reemplázalo por nada".

### Parámetros de ruta

**provider\_id** `string` *required*

ID de proveedor del catálogo de Yuno en UPPER\_SNAKE\_CASE. No distingue mayúsculas de minúsculas: se normaliza a mayúsculas.

### Respuesta

**provider\_id** `string`

Id del proveedor del catálogo de Yuno, normalizado a mayúsculas.

**instructions** `object[]`

Pasos de conexión que reemplazan los del catálogo. Cada paso acepta `step`, `text`, `text_link`, `link`, `type`, `has_sub_instructions`, `sub_instructions_type` y `sub_instructions` (anidados hasta 3 niveles). `text` y `text_link` son un string simple o un mapa de idiomas como `{"EN": "...", "ES": "..."}`.

**setup\_instructions** `object[]`

Pasos de configuración agrupados que reemplazan los del catálogo. Cada grupo acepta `title`, `order`, `instructions_type` y `instructions` (la misma forma de paso).

**more\_info\_url** `string`

Enlace de documentación que reemplaza el del catálogo. Siempre https.

**name** `string`

Nombre para mostrar que reemplaza el del catálogo. Solo los proveedores propiedad de Yuno pueden llevar uno.

**created\_at** `string`

Marca de tiempo ISO 8601: cuándo se escribió la personalización por primera vez.

**updated\_at** `string`

Marca de tiempo ISO 8601: cuándo se escribió la personalización por última vez.

**created\_by** `string`

El usuario del dashboard que la creó. Las personalizaciones escritas mediante esta API llevan el valor centinela de ceros, que significa "escritas mediante la API" y no por una persona en el Dashboard.

**updated\_by** `string`

El usuario del dashboard que la actualizó por última vez, con la misma regla del valor centinela que `created_by`.

```bash cURL theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
curl -X GET 'https://api.y.uno/v1/whitelabel/providers/STRIPE/instructions' \
  -H 'public-api-key: <YOUR_PUBLIC_KEY>' \
  -H 'private-secret-key: <YOUR_SECRET_KEY>'
```

```json 200 OK theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
  "provider_id": "STRIPE",
  "more_info_url": "https://docs.example.com/stripe",
  "instructions": [
    {
      "step": 1,
      "text": { "EN": "Open your Stripe dashboard.", "ES": "Abre tu panel de Stripe." },
      "type": "TEXT"
    },
    {
      "step": 2,
      "text": "Copy the secret API key and paste it below.",
      "text_link": "Where do I find my key?",
      "link": "https://docs.example.com/stripe#api-keys",
      "type": "LINK"
    }
  ],
  "setup_instructions": [
    {
      "title": "Before you start",
      "order": 1,
      "instructions_type": "TEXT",
      "instructions": [
        { "step": 1, "text": "Make sure your Stripe account is activated." }
      ]
    }
  ],
  "created_at": "2026-09-02T13:54:13Z",
  "updated_at": "2026-09-02T13:54:13Z",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "updated_by": "00000000-0000-0000-0000-000000000000"
}
```

```json 404 — no override theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
  "title": "Not Found",
  "status": 404,
  "detail": "No instruction override for provider STRIPE"
}
```

```json 400 Bad Request theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
  "code": "VALIDATION_ERROR",
  "messages": ["provider_id is invalid"]
}
```

### Errores

| HTTP | Envoltorio | Cuándo |
| - | - | - |
| `400` | `VALIDATION_ERROR` | `provider_id` no es un id de catálogo válido. |
| `401` | `NOT_AUTHENTICATED` | Faltan las claves de API o no son válidas. |
| `404` | problem+json | Este proveedor no tiene personalización de instrucciones. |


## OpenAPI

````yaml openapi/es/organizations/whitelabel/retrieve-provider-instructions.json GET /whitelabel/providers/{provider_id}/instructions
openapi: 3.1.0
info:
  title: White-label Providers API - Retrieve Instructions
  version: 1.0.0
servers:
  - url: https://api-sandbox.y.uno/v1
    description: Sandbox
  - url: https://api.y.uno/v1
    description: Production (US)
security:
  - sec0: []
    sec1: []
paths:
  /whitelabel/providers/{provider_id}/instructions:
    get:
      summary: Obtener la anulación de instrucciones de un proveedor
      description: >-
        Devuelve las instrucciones de conexión personalizadas que almacenaste
        para este proveedor: la lectura puntual que carga un editor antes de
        guardar. Un proveedor sin anulación responde `404`; usa `GET
        /v1/whitelabel/providers/{provider_id}`, que nunca devuelve 404, cuando
        quieras obtener la superposición exista o no una anulación.


        Un campo que no anulas está ausente, no es nulo ni una lista vacía:
        ausente significa "conservar el valor del catálogo de Yuno", presente y
        vacío significa "reemplazarlo por nada".
      operationId: retrieve-whitelabel-provider-instructions
      parameters:
        - name: provider_id
          in: path
          required: true
          description: >-
            ID del proveedor del catálogo de Yuno en UPPER_SNAKE_CASE. No
            distingue mayúsculas de minúsculas; se normaliza a mayúsculas.
          schema:
            type: string
            example: STRIPE
      responses:
        '200':
          description: La anulación almacenada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  provider_id:
                    type: string
                    description: ID del proveedor del catálogo de Yuno, UPPER_SNAKE_CASE.
                    example: STRIPE
                  instructions:
                    type: array
                    description: Pasos de conexión que reemplazan los del catálogo.
                    items:
                      type: object
                      additionalProperties: true
                      description: >-
                        Un paso de instrucciones. Acepta `step`, `text`,
                        `text_link`, `link`, `type`, `has_sub_instructions`,
                        `sub_instructions_type` y `sub_instructions` (anidados
                        hasta 3 niveles). `text` y `text_link` son una cadena
                        simple o un mapa de idiomas como `{"EN": "...", "ES":
                        "..."}`. Todo `link` debe ser https.
                  setup_instructions:
                    type: array
                    description: >-
                      Pasos de configuración agrupados que reemplazan los del
                      catálogo.
                    items:
                      type: object
                      additionalProperties: true
                      description: >-
                        Un grupo de configuración. Acepta `title`, `order`,
                        `instructions_type` e `instructions` (la misma
                        estructura de paso).
                  more_info_url:
                    type: string
                    format: uri
                    description: >-
                      Enlace a la documentación que reemplaza al del catálogo,
                      cuando se personaliza. Siempre https.
                    example: https://docs.example.com/stripe
                  name:
                    type: string
                    description: >-
                      Nombre visible que reemplaza al del catálogo, cuando se
                      personaliza. Solo los proveedores propiedad de Yuno pueden
                      tener uno.
                    example: Acme Risk
                  created_at:
                    type: string
                    format: date-time
                    readOnly: true
                    description: Cuándo se escribió la anulación por primera vez.
                    example: '2026-09-02T13:54:13Z'
                  updated_at:
                    type: string
                    format: date-time
                    readOnly: true
                    description: Cuándo se escribió la anulación por última vez.
                    example: '2026-09-02T13:54:13Z'
                  created_by:
                    type: string
                    format: uuid
                    readOnly: true
                    description: >-
                      El usuario del Dashboard que la creó. Las anulaciones
                      escritas mediante esta API llevan el valor centinela con
                      todos ceros `00000000-0000-0000-0000-000000000000`, que
                      significa "escrito mediante la API" y no por una persona
                      en el Dashboard.
                    example: 00000000-0000-0000-0000-000000000000
                  updated_by:
                    type: string
                    format: uuid
                    readOnly: true
                    description: >-
                      El usuario del Dashboard que la actualizó por última vez,
                      con la misma regla del valor centinela que `created_by`.
                    example: 00000000-0000-0000-0000-000000000000
        '400':
          description: provider_id no válido.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: VALIDATION_ERROR
                  messages:
                    type: array
                    items:
                      type: string
                    example:
                      - provider_id is invalid
        '401':
          description: 'No autorizado: las claves de API no son válidas o faltan.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: NOT_AUTHENTICATED
                  messages:
                    type: array
                    items:
                      type: string
                    example:
                      - Not authenticated
        '404':
          description: Este proveedor no tiene una anulación de instrucciones.
          content:
            application/json:
              schema:
                type: object
                properties:
                  title:
                    type: string
                    example: Not Found
                  status:
                    type: integer
                    example: 404
                  detail:
                    type: string
                    example: No instruction override for provider STRIPE
components:
  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.