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

# Reportar pago verificado

> Registra un pago confirmado por el partner y lo aplica únicamente a los documentos indicados. El límite es 60 solicitudes por minuto por llave.



## OpenAPI

````yaml /openapi/integrations-v1.json post /integrations/v1/{companyId}/verified-payments
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. 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: Links de cobro
    description: Sesiones de checkout para documentos abiertos.
  - name: Pagos
    description: Pagos verificados y su aplicación financiera.
paths:
  /integrations/v1/{companyId}/verified-payments:
    post:
      tags:
        - Pagos
      summary: Reportar pago verificado
      description: >-
        Registra un pago confirmado por el partner y lo aplica únicamente a los
        documentos indicados. El límite es 60 solicitudes por minuto por llave.
      operationId: ingestVerifiedPayment
      parameters:
        - $ref: '#/components/parameters/CompanyId'
        - $ref: '#/components/parameters/IdempotencyKey'
        - $ref: '#/components/parameters/CobrixTimestamp'
        - $ref: '#/components/parameters/CobrixSignature'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifiedPaymentRequest'
      responses:
        '201':
          description: Pago procesado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifiedPaymentResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '429':
          $ref: '#/components/responses/RateLimited'
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:
    VerifiedPaymentRequest:
      type: object
      required:
        - source
        - externalPaymentId
        - customerExternalId
        - amountMinor
        - currency
        - verifiedAt
        - documents
      properties:
        source:
          type: string
          minLength: 1
        externalPaymentId:
          type: string
          minLength: 1
        customerExternalId:
          type: string
          minLength: 1
        amountMinor:
          type: number
          minimum: 1
        currency:
          type: string
          enum:
            - USD
            - VES
            - usd
            - ves
        method:
          type: string
        verifiedAt:
          type: string
          format: date-time
        idempotencyKey:
          type: string
          description: Campo legacy opcional; el header sigue siendo obligatorio.
        documents:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/PaymentDocumentRequest'
        certifiedConversion:
          $ref: '#/components/schemas/CertifiedConversion'
        metadata:
          type: object
          additionalProperties: true
      example:
        source: erp_acme
        externalPaymentId: payment-5001
        customerExternalId: customer-1001
        amountMinor: 2025
        currency: USD
        method: bank_transfer
        verifiedAt: '2026-07-14T16:00:00Z'
        documents:
          - externalDocumentId: invoice-1001
            amountMinor: 2025
    VerifiedPaymentResponse:
      type: object
      required:
        - paymentId
        - source
        - externalPaymentId
        - customerExternalId
        - companyCustomerId
        - status
        - paymentCurrency
        - applicationCurrency
        - totalAppliedMinor
        - creditCreatedMinor
        - documents
      properties:
        paymentId:
          type: string
          format: uuid
        source:
          type: string
        externalPaymentId:
          type: string
        customerExternalId:
          type: string
        companyCustomerId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PublicPaymentStatus'
        paymentCurrency:
          type: string
        applicationCurrency:
          type: string
        totalAppliedMinor:
          type: integer
        creditCreatedMinor:
          type: integer
        documents:
          type: array
          items:
            $ref: '#/components/schemas/PaymentDocumentResult'
    PaymentDocumentRequest:
      type: object
      required:
        - externalDocumentId
      properties:
        externalDocumentId:
          type: string
          minLength: 1
        amountMinor:
          type: number
          minimum: 1
    CertifiedConversion:
      type: object
      required:
        - refCurrency
        - refAmountMinor
        - exchangeRateId
        - exchangeRateUsed
      properties:
        refCurrency:
          type: string
          enum:
            - USD
            - VES
            - usd
            - ves
        refAmountMinor:
          type: number
          minimum: 1
        exchangeRateId:
          type: string
          format: uuid
        exchangeRateUsed:
          type: string
          pattern: ^[0-9]+(?:\.[0-9]+)?$
          maxLength: 19
    PublicPaymentStatus:
      type: string
      enum:
        - applied
        - partially_applied
        - credited
        - needs_certified_rate
        - no_open_documents
        - failed
        - already_processed
    PaymentDocumentResult:
      type: object
      required:
        - invoiceId
        - externalDocumentId
        - currency
        - appliedMinor
        - balanceMinor
        - status
      properties:
        invoiceId:
          type: string
          format: uuid
        externalDocumentId:
          type: string
        currency:
          type: string
        appliedMinor:
          type: integer
        balanceMinor:
          type: integer
        status:
          type: string
          enum:
            - applied
            - partially_applied
            - paid
            - requires_certified_rate
            - not_applied
    IntegrationError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type:
                - string
                - 'null'
  responses:
    BadRequest:
      description: Payload, firma o idempotencia faltante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
    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
    Forbidden:
      description: Empresa o scope no autorizado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
    Conflict:
      description: Conflicto de idempotencia o estado financiero
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
    Unprocessable:
      description: La operación no cumple las reglas de negocio
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
    RateLimited:
      description: Límite por llave y ruta excedido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/IntegrationError'
          example:
            error:
              code: rate_limited
              message: Too many requests for this API key.
              requestId: req-1001
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Cobrix API key
      description: Llave cbx_live creada para el partner.

````