> ## 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 validación embebida

> Emite un token para un pedido. Tu web se lo pasa a `checkout.js` y tu cliente escribe la referencia de su pago en tu página, sin ver tu llave. Cuenta receptora, monto, moneda, métodos, `externalReference` y `metadata` quedan fijos en el token: el navegador no puede cambiarlos. La moneda es la de la cuenta receptora: otra responde `422 invalid_field`. `token` solo vuelve en esta respuesta. La misma `Idempotency-Key` con el mismo cuerpo devuelve el mismo token, aunque ya haya caducado, se haya revocado o se haya usado: para un token nuevo, usa otra clave. Requiere 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}/payment-verifications/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}/payment-verifications/tokens:
    post:
      tags:
        - Validación de pagos
      summary: Emitir un token de validación embebida
      description: >-
        Emite un token para un pedido. Tu web se lo pasa a `checkout.js` y tu
        cliente escribe la referencia de su pago en tu página, sin ver tu llave.
        Cuenta receptora, monto, moneda, métodos, `externalReference` y
        `metadata` quedan fijos en el token: el navegador no puede cambiarlos.
        La moneda es la de la cuenta receptora: otra responde `422
        invalid_field`. `token` solo vuelve en esta respuesta. La misma
        `Idempotency-Key` con el mismo cuerpo devuelve el mismo token, aunque ya
        haya caducado, se haya revocado o se haya usado: para un token nuevo,
        usa otra clave. Requiere al menos una web registrada en el panel. El
        límite es 60 solicitudes por minuto por llave.
      operationId: createPaymentVerificationToken
      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/CreatePaymentVerificationTokenRequest'
      responses:
        '201':
          description: El token emitido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentVerificationTokenCreated'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            `company_mismatch` o `insufficient_scope`. `embed_disabled`: 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`: la misma llamada sigue en curso; espera y
            repítela. `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_receiver_account`: la cuenta no existe, está inactiva o no
            tiene una moneda reconocida. `method_not_available`: algún método de
            `methods` no es de esa cuenta, también `pago_movil` en una cuenta
            que no está en `VES` o en una cuenta bancaria (`bank:…`) sin
            teléfono receptor conocido; `methods` dice cuáles. `invalid_field`:
            `currency` no es la moneda de la cuenta, o `metadata` es demasiado
            grande; `field` dice cuál. Ninguno emite un token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentVerificationError'
              example:
                error:
                  code: method_not_available
                  message: The receiver account does not accept every requested method.
                  field: methods
                  methods:
                    - pago_movil
        '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:
    CreatePaymentVerificationTokenRequest:
      type: object
      required:
        - receiverAccountKey
        - amountMinor
        - externalReference
      description: >-
        El pedido 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`.
      properties:
        receiverAccountKey:
          type: string
          description: >-
            La cuenta de la empresa que recibe el pago, de `GET
            payment-verifications/receiver-accounts`.
        amountMinor:
          type: integer
          minimum: 1
          description: >-
            Monto del pedido en unidades menores, como número entero JSON:
            `150000` es Bs 1.500,00.
        externalReference:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            Tu referencia del pedido. Vuelve en cada validación hecha con el
            token y en sus webhooks.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: >-
            La moneda de la cuenta receptora. Si no la envías, es esa. Otra
            responde `422 invalid_field`.
        methods:
          type: array
          items:
            $ref: '#/components/schemas/PaymentVerificationMethod'
          description: >-
            Los métodos que tu cliente puede usar. Solo métodos que trae la
            cuenta en `GET payment-verifications/receiver-accounts`:
            `pago_movil` en una cuenta bancaria (`bank:…`) sin teléfono receptor
            conocido responde `422 method_not_available`. Por defecto, todos los
            de la cuenta.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Objeto JSON que vuelve en la validación. Hasta 2048 bytes
            serializado. El navegador nunca lo ve.
        expiresInSeconds:
          type: integer
          minimum: 60
          maximum: 1800
          default: 900
          description: Cuánto vive el token, en segundos. Por defecto, 900 (15 minutos).
        maxAttempts:
          type: integer
          minimum: 1
          maximum: 5
          default: 5
          description: Cuántos intentos tiene tu cliente. Por defecto, 5.
      example:
        receiverAccountKey: bank:3d9a7c52-…
        amountMinor: 150000
        externalReference: PED-1001
        methods:
          - pago_movil
          - bank_transfer
        expiresInSeconds: 900
        maxAttempts: 5
    PaymentVerificationTokenCreated:
      type: object
      required:
        - id
        - token
        - expiresAt
        - maxAttempts
        - methods
        - amountMinor
        - currency
        - externalReference
      properties:
        id:
          type: string
          description: >-
            Identifica el token en `GET` y `DELETE
            payment-verifications/tokens/{tokenId}`. Es un UUID.
        token:
          type: string
          description: >-
            El token completo, `pvt_…_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.
        maxAttempts:
          type: integer
        methods:
          type: array
          items:
            $ref: '#/components/schemas/PaymentVerificationMethod'
          description: Los métodos que tu cliente puede usar.
        amountMinor:
          type: integer
        currency:
          type: string
          description: La moneda de la cuenta receptora.
        externalReference:
          type: string
      example:
        id: 0f8fad5b-…
        token: pvt_0f8f…_secret_…
        expiresAt: '2026-11-17T12:15:00.000Z'
        maxAttempts: 5
        methods:
          - pago_movil
          - bank_transfer
        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'
    PaymentVerificationError:
      type: object
      required:
        - error
      description: >-
        Los `422` de `POST payment-verifications` y `POST
        payment-verifications/tokens`.
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - missing_fields
                - invalid_field
                - invalid_receiver_account
                - method_not_available
                - embed_domain_required
            message:
              type: string
            fields:
              type: array
              items:
                type: string
              description: 'Solo en `missing_fields`: todos los campos que faltan.'
            field:
              type: string
              description: >-
                En `invalid_field`, `invalid_receiver_account` y
                `method_not_available` de un token: el campo con problema.
            detail:
              type: string
              description: >-
                Solo en `invalid_field`: por qué no sirve. Con `field:
                "currency"`, nombra la moneda de la cuenta.
            methods:
              type: array
              items:
                $ref: '#/components/schemas/PaymentVerificationMethod'
              description: >-
                Solo en `method_not_available` de un token: los métodos pedidos
                que la cuenta no acepta.
    PaymentVerificationMethod:
      type: string
      enum:
        - pago_movil
        - bank_transfer
        - zelle
      description: >-
        `pago_movil` y `bank_transfer`: Cobrix consulta al banco. `zelle`: lo
        revisa una persona de la empresa.
    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.