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

# Emitir un token de vuelto embebido

> Emite un token para un vuelto. Tu web se lo pasa a `checkout.js` y la persona escribe en tu página su banco, su teléfono y, si no la fijaste, su cédula, sin ver tu llave. Cliente, monto, concepto, motivo, `externalReference`, cuenta de origen y cédula quedan fijos en el token: el navegador no puede cambiarlos. El token vive 5 minutos y tiene 3 intentos; no se pueden cambiar. `token` solo vuelve en esta respuesta. La misma `Idempotency-Key` con el mismo cuerpo devuelve el mismo token: para un token nuevo, usa otra clave. Requiere el vuelto embebido activo y al menos una web registrada en el panel. El límite es 60 solicitudes por minuto por llave.



## OpenAPI

````yaml /openapi/integrations-v1.json post /integrations/v1/{companyId}/customer-payouts/tokens
openapi: 3.1.0
info:
  title: Cobrix API de integraciones
  version: 1.0.0
  description: >-
    API firmada para sincronizar clientes, documentos de cobro, links y pagos
    verificados, para cobrar con débito inmediato, validar pagos recibidos y
    enviar vueltos. Los campos monetarios terminados en Minor usan unidades
    menores.
  license:
    name: Propietaria
    url: https://cobrix.co/terms
servers:
  - url: https://api.cobrix.co/api
    description: Producción
  - url: https://sandbox-api.cobrix.co/api
    description: Sandbox
security:
  - bearerAuth: []
tags:
  - name: Clientes
    description: Identidades externas vinculadas al source de la llave.
  - name: Documentos de cobro
    description: Documentos o cargos importados desde un sistema externo.
  - name: Débito inmediato
    description: Cobros por débito inmediato desde el formulario propio del comercio.
  - name: Validación de pagos
    description: >-
      Comprueba un pago móvil, una transferencia o un Zelle que recibió la
      empresa, desde tu servidor o con un token que usa tu web.
  - name: Vueltos
    description: Pago móvil desde la cuenta de la empresa a una persona.
  - name: Links de cobro
    description: Sesiones de checkout para documentos abiertos.
  - name: Pagos
    description: Pagos verificados y su aplicación financiera.
  - name: Dispersiones
    description: Lo que Cobrix transfirió a tus cuentas de los cobros por débito inmediato.
paths:
  /integrations/v1/{companyId}/customer-payouts/tokens:
    post:
      tags:
        - Vueltos
      summary: Emitir un token de vuelto embebido
      description: >-
        Emite un token para un vuelto. Tu web se lo pasa a `checkout.js` y la
        persona escribe en tu página su banco, su teléfono y, si no la fijaste,
        su cédula, sin ver tu llave. Cliente, monto, concepto, motivo,
        `externalReference`, cuenta de origen y cédula quedan fijos en el token:
        el navegador no puede cambiarlos. El token vive 5 minutos y tiene 3
        intentos; no se pueden cambiar. `token` solo vuelve en esta respuesta.
        La misma `Idempotency-Key` con el mismo cuerpo devuelve el mismo token:
        para un token nuevo, usa otra clave. Requiere el vuelto embebido activo
        y al menos una web registrada en el panel. El límite es 60 solicitudes
        por minuto por llave.
      operationId: createCustomerPayoutToken
      parameters:
        - $ref: '#/components/parameters/CompanyId'
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/CobrixTimestamp'
        - $ref: '#/components/parameters/CobrixSignature'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        description: >-
          Cada campo acepta solo el tipo JSON de su esquema; Cobrix no convierte
          tipos.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerPayoutTokenRequest'
      responses:
        '201':
          description: El token emitido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPayoutTokenCreated'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            `company_mismatch` o `insufficient_scope`. `embed_disabled`: el
            vuelto embebido o el checkout embebido no está activo para la
            empresa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '409':
          description: >-
            `idempotency_conflict`: la clave ya se usó con otro cuerpo.
            `request_in_progress`: otra llamada con esa clave sigue en curso;
            espera y repítela con la misma clave.
            `idempotency_result_ambiguous`: esa clave ya no responde; emite el
            token con una clave nueva.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '422':
          description: >-
            `embed_domain_required`: la empresa no tiene ninguna web registrada.
            `invalid_field` con `field: "concept"`: el banco de la cuenta de
            origen no acepta ese concepto. `account_required`,
            `account_not_available`, `beneficiary_document_unsupported`,
            `customer_not_found`, `payout_limit_not_configured`,
            `payout_limit_exceeded`, `rate_unavailable` o
            `customer_payout_rejected`: los mismos que en `POST
            customer-payouts`. Ninguno emite un token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
              example:
                error:
                  code: invalid_field
                  message: A field is invalid.
                  field: concept
        '429':
          description: '`rate_limited`: más de 60 tokens por minuto con esta llave.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '500':
          $ref: '#/components/responses/DirectDebitInternalError'
components:
  parameters:
    CompanyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Empresa vinculada a la llave.
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      schema:
        type: string
        minLength: 1
      description: Identificador estable de la operación.
    CobrixTimestamp:
      name: Cobrix-Timestamp
      in: header
      required: true
      schema:
        type: string
        pattern: ^[0-9]{10}$
      description: Segundos Unix dentro de una ventana de cinco minutos.
    CobrixSignature:
      name: Cobrix-Signature
      in: header
      required: true
      schema:
        type: string
        pattern: ^v1=[a-f0-9]{64}$
      description: HMAC-SHA256 de timestamp, método, ruta y cuerpo crudo.
    RequestId:
      name: X-Request-Id
      in: header
      required: false
      schema:
        type: string
      description: Identificador opcional para correlación de soporte.
  schemas:
    CreateCustomerPayoutTokenRequest:
      type: object
      required:
        - customerId
        - amountMinor
        - concept
        - reason
        - externalReference
      description: >-
        El vuelto que el token deja fijo. Cada campo acepta solo el tipo JSON de
        su esquema. Un campo que no está aquí responde `400 invalid_request`,
        también `expiresInSeconds` y `maxAttempts`: son fijos.
      properties:
        customerId:
          type: string
          format: uuid
          description: >-
            El cliente de la empresa en Cobrix: el `companyCustomerId` que
            devuelven `POST customers/upsert` y `GET customers`.
        accountId:
          type: string
          format: uuid
          description: >-
            Cuenta de origen. Opcional si la empresa tiene una sola cuenta
            habilitada para vueltos.
        amountMinor:
          type: integer
          minimum: 1
          maximum: 999999999999999
          description: >-
            Monto en céntimos de bolívar, como número entero JSON: `150000` es
            Bs 1.500,00.
        currency:
          type: string
          enum:
            - VES
          description: Solo `VES`. Un vuelto embebido nunca se convierte.
        concept:
          type: string
          pattern: ^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{1,60}$
          description: >-
            Concepto del pago móvil: solo letras y espacios, hasta 60. Además,
            el banco de la cuenta de origen debe aceptarlo; si no, `422
            invalid_field`.
        reason:
          type: string
          minLength: 10
          maxLength: 300
          description: Por qué se devuelve el dinero. Queda en la auditoría de la empresa.
        externalReference:
          type: string
          minLength: 1
          maxLength: 100
          description: Tu referencia. Viaja en el vuelto y en los webhooks.
        document:
          type: string
          pattern: ^[VEJ][0-9]{9}$
          description: >-
            Documento de quien recibe, si ya lo sabes: `V`, `E` o `J` y 9
            dígitos. Con él, el formulario no lo pide. Si el banco de la cuenta
            no paga ese tipo, `422 beneficiary_document_unsupported`.
      example:
        customerId: 2c7a9e1b-4d6f-4a3c-8b5e-1f0d9c8b7a65
        amountMinor: 150000
        concept: Vuelto de compra
        reason: Vuelto del pedido PED-1001
        externalReference: PED-1001
    CustomerPayoutTokenCreated:
      type: object
      required:
        - id
        - token
        - expiresAt
        - maxAttempts
        - amountMinor
        - currency
        - externalReference
      properties:
        id:
          type: string
          description: >-
            Identifica el token en `GET` y `DELETE
            customer-payouts/tokens/{tokenId}`. Es un UUID.
        token:
          type: string
          description: >-
            El token completo, `cpt_…_secret_…`. Solo vuelve en esta respuesta.
            Entrégaselo a tu página para `checkout.js`; nunca lo pongas en una
            URL.
        expiresAt:
          type: string
          format: date-time
          description: 'Cuándo caduca: 5 minutos después de emitirlo.'
        maxAttempts:
          type: integer
          description: Siempre 3.
        amountMinor:
          type: integer
        currency:
          type: string
          description: Siempre `VES`.
        externalReference:
          type: string
      example:
        id: 0f8fad5b-…
        token: cpt_0f8f…_secret_…
        expiresAt: '2026-11-17T12:05:00.000Z'
        maxAttempts: 3
        amountMinor: 150000
        currency: VES
        externalReference: PED-1001
    IntegrationError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: El campo con problema, cuando el error trae uno.
            requestId:
              type:
                - string
                - 'null'
    DirectDebitApiError:
      type: object
      required:
        - error
      description: Todos los errores HTTP de las rutas de débito inmediato.
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: >-
                En `invalid_request`, el primer campo con problema, por ejemplo
                `payer.phone`. En un error de `splits`, la parte, por ejemplo
                `splits[1].holderDocument`.
            reason:
              type: string
              description: >-
                Solo en `invalid_split`: qué regla no se cumple, por ejemplo
                `sum`.
            details:
              type: array
              description: 'Solo en `invalid_request`: cada problema con su campo.'
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    type: string
                  message:
                    type: string
            bankCode:
              type: string
              description: 'Solo en `payer_bank_rejected`: el código propio del banco.'
            requestId:
              type: string
              description: El `X-Request-Id` que enviaste, si enviaste uno.
  responses:
    InvalidRequest:
      description: >-
        `invalid_request`: el cuerpo, la query o el `id` de la ruta no cumple el
        formato, o un campo trae otro tipo JSON. `field` y `message` son los del
        primer problema y `details` los trae todos. No gasta la
        `Idempotency-Key`. En un `POST`, también `missing_idempotency_key`. Un
        cuerpo vacío o que no es JSON válido responde `400` con el formato del
        servidor web, sin `error.code`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DirectDebitApiError'
          example:
            error:
              code: invalid_request
              message: amountMinor must not be less than 1
              field: amountMinor
              details:
                - field: amountMinor
                  message: amountMinor must not be less than 1
              requestId: req-1001
    Unauthorized:
      description: Llave o firma inválida
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
          example:
            error:
              code: invalid_api_key
              message: The API key is missing or invalid.
              requestId: req-1001
    DirectDebitInternalError:
      description: >-
        `internal_error`: falló algo de Cobrix, no del banco ni de los datos. El
        mensaje es genérico; reintenta en unos minutos. Con `X-Request-Id`, la
        respuesta lo trae como `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DirectDebitApiError'
          example:
            error:
              code: internal_error
              message: >-
                Something failed on our side. Try again in a few minutes; if it
                keeps failing, contact Cobrix support.
              requestId: req-1001
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Cobrix API key
      description: Llave cbx_live creada para el partner.

````

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