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

# Validar un pago

> Valida un pago que recibió la empresa. Pago móvil y transferencia: Cobrix consulta al banco y responde el resultado en esta llamada. Zelle: queda en `pending_review` hasta que una persona de la empresa lo aprueba o lo rechaza en el panel de Cobrix. Un resultado negativo no es un error HTTP: responde `201` con su `status`. Toda respuesta `201` se guarda con su `Idempotency-Key`: la misma clave con el mismo cuerpo devuelve esa respuesta y no consulta al banco otra vez. Para consultar de nuevo, usa una clave nueva. La moneda es la de la cuenta receptora: otra responde `422 invalid_field`. El límite es 60 solicitudes por minuto por llave.



## OpenAPI

````yaml /openapi/integrations-v1.json post /integrations/v1/{companyId}/payment-verifications
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:
    post:
      tags:
        - Validación de pagos
      summary: Validar un pago
      description: >-
        Valida un pago que recibió la empresa. Pago móvil y transferencia:
        Cobrix consulta al banco y responde el resultado en esta llamada. Zelle:
        queda en `pending_review` hasta que una persona de la empresa lo aprueba
        o lo rechaza en el panel de Cobrix. Un resultado negativo no es un error
        HTTP: responde `201` con su `status`. Toda respuesta `201` se guarda con
        su `Idempotency-Key`: la misma clave con el mismo cuerpo devuelve esa
        respuesta y no consulta al banco otra vez. Para consultar de nuevo, usa
        una clave nueva. La moneda es la de la cuenta receptora: otra responde
        `422 invalid_field`. El límite es 60 solicitudes por minuto por llave.
      operationId: createPaymentVerification
      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/CreatePaymentVerificationRequest'
      responses:
        '201':
          description: La validación con su resultado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentVerification'
              examples:
                verified:
                  summary: Pago móvil confirmado por el banco
                  value:
                    id: 0b6e2f4a-7c1d-4e8b-9a3f-5d2c1b0a9e87
                    method: pago_movil
                    status: verified
                    reason: null
                    warnings: []
                    reference: ••••3456
                    amountMinor: 150000
                    currency: VES
                    paymentDate: '2026-11-12'
                    bank:
                      amountMinor: 150000
                      valueDate: '2026-11-12'
                    receiverAccountKey: bank:3d9a7c52-1e4b-4f6a-8c2d-7b5e9f1a0c34
                    externalReference: PED-1001
                    metadata: null
                    createdAt: '2026-11-13T12:00:00.000Z'
                    resolvedAt: '2026-11-13T12:00:01.000Z'
                    resolvedBy: bank
                    reviewNote: null
                    tokenId: null
                unverifiable:
                  summary: El banco no respondió
                  value:
                    id: 4c8d1e6f-2a7b-4d9c-8e5f-1a3b5c7d9e02
                    method: pago_movil
                    status: unverifiable
                    reason: bank_unavailable
                    warnings: []
                    reference: ••••3456
                    amountMinor: 150000
                    currency: VES
                    paymentDate: '2026-11-12'
                    bank: null
                    receiverAccountKey: bank:3d9a7c52-1e4b-4f6a-8c2d-7b5e9f1a0c34
                    externalReference: PED-1001
                    metadata: null
                    createdAt: '2026-11-13T12:00:00.000Z'
                    resolvedAt: '2026-11-13T12:00:08.000Z'
                    resolvedBy: bank
                    reviewNote: null
                    tokenId: null
                pendingReview:
                  summary: Zelle en revisión
                  value:
                    id: 7e2a9c4d-6b1f-4a3e-9d8c-0f5b2e7a4c61
                    method: zelle
                    status: pending_review
                    reason: null
                    warnings: []
                    reference: ••••7731
                    amountMinor: 5000
                    currency: USD
                    paymentDate: '2026-11-12'
                    bank: null
                    receiverAccountKey: zelle:91d2b6e4-5a3c-4f7d-8e1b-2c6a9d0f4b75
                    externalReference: PED-1002
                    metadata: null
                    createdAt: '2026-11-12T10:00:00.000Z'
                    resolvedAt: null
                    resolvedBy: null
                    reviewNote: null
                    tokenId: null
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            `company_mismatch` o `insufficient_scope`.
            `verification_limit_reached`: la empresa alcanzó su número de
            validaciones configurado.
          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;
            valida de nuevo con una clave nueva.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '422':
          description: >-
            `missing_fields`: faltan datos del pagador que exige el banco de esa
            cuenta; `fields` los trae todos. `invalid_field`: un dato no sirve;
            `field` dice cuál y `detail` por qué. Con `field: "currency"`, la
            moneda no es la de la cuenta receptora y `detail` dice cuál es.
            `invalid_receiver_account`: la cuenta no existe, está inactiva, no
            tiene una moneda reconocida o no acepta ese método, también
            `pago_movil` en una cuenta en `USD` o `EUR` o en una cuenta bancaria
            (`bank:…`) sin teléfono receptor conocido. `method_not_available`:
            la empresa no tiene Zelle configurado. Ninguno consulta al banco ni
            crea la validación.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentVerificationError'
              examples:
                missingFields:
                  summary: Faltan datos del pagador
                  value:
                    error:
                      code: missing_fields
                      message: Required fields are missing for this receiver account.
                      fields:
                        - payerPhone
                        - payerBankCode
                currency:
                  summary: La moneda no es la de la cuenta
                  value:
                    error:
                      code: invalid_field
                      message: A field is invalid.
                      field: currency
                      detail: Payments to this receiver account are in VES.
        '429':
          description: '`rate_limited`: más de 60 validaciones 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:
    CreatePaymentVerificationRequest:
      type: object
      required:
        - method
        - reference
        - amountMinor
        - paymentDate
      properties:
        method:
          $ref: '#/components/schemas/PaymentVerificationMethod'
        receiverAccountKey:
          type: string
          pattern: ^(pago_movil|pago_movil_method|bank|zelle):[0-9a-f-]{36}$
          description: >-
            La cuenta de la empresa que recibió el pago, de `GET
            payment-verifications/receiver-accounts`. Obligatoria en
            `pago_movil` y `bank_transfer`. Opcional en `zelle`: si la empresa
            tiene una sola cuenta Zelle, Cobrix usa esa.
        reference:
          type: string
          minLength: 1
          maxLength: 64
          description: >-
            La referencia del comprobante, completa. En Zelle, la confirmación
            completa.
        amountMinor:
          type: integer
          minimum: 1
          description: >-
            Monto en unidades menores, como número entero JSON: `150000` es Bs
            1.500,00. Un texto (`"150000"`, `"1500.00"`) responde `400
            invalid_request`.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: >-
            La moneda de la cuenta receptora, la que trae `currency` en `GET
            payment-verifications/receiver-accounts`. Si no la envías, es esa.
            Otra responde `422 invalid_field` con `field: "currency"`. Zelle es
            siempre `USD`.
        paymentDate:
          type: string
          format: date
          description: El día del pago, `YYYY-MM-DD`.
        payerBankCode:
          type: string
          pattern: ^[0-9]{4}$
          description: >-
            Banco desde el que pagó la persona. Obligatorio si el banco de la
            cuenta receptora lo exige.
        payerPhone:
          type: string
          minLength: 1
          maxLength: 32
          description: >-
            Teléfono del pagador. Obligatorio si el banco de la cuenta receptora
            lo exige.
        payerDocument:
          type: string
          minLength: 1
          maxLength: 32
          description: >-
            Cédula o RIF del pagador. Obligatorio si el banco de la cuenta
            receptora lo exige.
        payerName:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Nombre de quien envió el Zelle. Lo ve quien revisa; nunca vuelve en
            la respuesta.
        externalReference:
          type: string
          minLength: 1
          maxLength: 128
          description: Tu referencia. Vuelve tal cual.
        metadata:
          type: object
          additionalProperties: true
          description: Objeto JSON que vuelve tal cual. Hasta 2048 bytes serializado.
      example:
        method: pago_movil
        receiverAccountKey: bank:3d9a7c52-1e4b-4f6a-8c2d-7b5e9f1a0c34
        reference: '000123456'
        amountMinor: 150000
        paymentDate: '2026-11-12'
        payerBankCode: '0134'
        payerPhone: '04120000000'
        payerDocument: V12345678
        externalReference: PED-1001
    PaymentVerification:
      type: object
      required:
        - id
        - method
        - status
        - reason
        - warnings
        - reference
        - amountMinor
        - currency
        - paymentDate
        - bank
        - receiverAccountKey
        - externalReference
        - metadata
        - createdAt
        - resolvedAt
        - resolvedBy
        - reviewNote
        - tokenId
      description: >-
        Una validación. También es el `data` de los webhooks
        `payment_verification.verified` y `payment_verification.rejected`.
      properties:
        id:
          type: string
          format: uuid
        method:
          $ref: '#/components/schemas/PaymentVerificationMethod'
        status:
          $ref: '#/components/schemas/PaymentVerificationStatus'
        reason:
          type:
            - string
            - 'null'
          description: >-
            Por qué no quedó `verified`. En `mismatch`: `amount_mismatch`,
            `date_mismatch`, `phone_mismatch`, `document_mismatch`,
            `bank_mismatch`, `duplicate_reference`, `already_reconciled` o
            `bank_rejected`. En `unverifiable`: `bank_unavailable`,
            `payment_too_old`, `invalid_payer_data` o `provider_misconfigured`.
            En `already_used`: `reference_already_used`. En `ambiguous`:
            `multiple_matches`. En `rejected`: `rejected_by_reviewer`.
        warnings:
          type: array
          items:
            type: string
            enum:
              - already_recorded_in_cobrix
              - pending_in_cobrix
              - bank_amount_differs
          description: >-
            Solo en `verified`. `already_recorded_in_cobrix`: Cobrix ya tiene un
            pago de la empresa con esa referencia aplicado a un documento de
            cobro. `pending_in_cobrix`: Cobrix tiene un pago con esa referencia
            esperando aprobación. `bank_amount_differs`: el banco informó un
            monto distinto de `amountMinor`.
        reference:
          type: string
          description: 'La referencia enmascarada: solo sus últimos 4 caracteres.'
        amountMinor:
          type: integer
          description: El monto que enviaste.
        currency:
          type: string
        paymentDate:
          type: string
          format: date
        bank:
          type:
            - object
            - 'null'
          required:
            - amountMinor
            - valueDate
          description: >-
            Lo que informó el banco sobre la cuenta de la empresa. Solo en
            `verified` tras una respuesta del banco.
          properties:
            amountMinor:
              type:
                - integer
                - 'null'
            valueDate:
              type:
                - string
                - 'null'
              format: date
              description: '`null` si el banco no devolvió un día.'
        receiverAccountKey:
          type:
            - string
            - 'null'
        externalReference:
          type:
            - string
            - 'null'
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
        createdAt:
          type: string
          format: date-time
        resolvedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: '`null` mientras está en `pending_review`.'
        resolvedBy:
          type:
            - string
            - 'null'
          enum:
            - bank
            - reviewer
            - null
          description: >-
            `bank`: Cobrix la resolvió en el `POST`. `reviewer`: una persona de
            la empresa (Zelle). `null` mientras está en `pending_review`.
        reviewNote:
          type:
            - string
            - 'null'
          description: >-
            La nota de quien revisó el Zelle, si dejó una. Su identidad nunca se
            expone.
        tokenId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            El token de validación embebida con el que tu cliente envió el pago.
            `null` si la validación la pidió tu servidor con `POST
            payment-verifications`.
        originalVerificationId:
          type: string
          format: uuid
          description: >-
            Solo en `already_used`, y solo si la referencia la usó antes una
            validación de tu misma integración: el `id` de esa validación.
      example:
        id: 0b6e2f4a-7c1d-4e8b-9a3f-5d2c1b0a9e87
        method: pago_movil
        status: verified
        reason: null
        warnings: []
        reference: ••••3456
        amountMinor: 150000
        currency: VES
        paymentDate: '2026-11-12'
        bank:
          amountMinor: 150000
          valueDate: '2026-11-12'
        receiverAccountKey: bank:3d9a7c52-1e4b-4f6a-8c2d-7b5e9f1a0c34
        externalReference: PED-1001
        metadata: null
        createdAt: '2026-11-13T12:00:00.000Z'
        resolvedAt: '2026-11-13T12:00:01.000Z'
        resolvedBy: bank
        reviewNote: null
        tokenId: null
    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.
    PaymentVerificationStatus:
      type: string
      enum:
        - verified
        - not_found
        - mismatch
        - already_used
        - ambiguous
        - unverifiable
        - pending_review
        - rejected
      description: >-
        `verified`: el banco confirmó el pago, o una persona de la empresa
        aprobó el Zelle. `not_found`: el banco no tiene un pago con esos datos.
        `mismatch`: el banco rechazó el pago porque un dato no coincide; ver
        `reason`. `already_used`: la referencia ya se usó en otra validación de
        la empresa. `ambiguous`: más de un pago coincide y no se marcó ninguno.
        `unverifiable`: no se pudo consultar al banco; ver `reason`.
        `pending_review`: Zelle en revisión, sin vencimiento. `rejected`: una
        persona de la empresa rechazó el Zelle. Solo `pending_review` cambia
        después.
    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.