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

# Consultar dispersión

> Una dispersión con sus montos y una transferencia por cuenta, con la cuenta enmascarada y la referencia bancaria.



## OpenAPI

````yaml /openapi/integrations-v1.json get /integrations/v1/{companyId}/payouts/{payoutId}
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}/payouts/{payoutId}:
    get:
      tags:
        - Dispersiones
      summary: Consultar dispersión
      description: >-
        Una dispersión con sus montos y una transferencia por cuenta, con la
        cuenta enmascarada y la referencia bancaria.
      operationId: getPayout
      parameters:
        - $ref: '#/components/parameters/CompanyId'
        - $ref: '#/components/parameters/PayoutId'
        - $ref: '#/components/parameters/CobrixTimestamp'
        - $ref: '#/components/parameters/CobrixSignature'
      responses:
        '200':
          description: Dispersión
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          description: >-
            La consulta tardó demasiado; reintenta después de `Retry-After`
            segundos
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
components:
  parameters:
    CompanyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Empresa vinculada a la llave.
    PayoutId:
      name: payoutId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: El `payoutId` de la lista de dispersiones.
    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.
  schemas:
    PayoutDetail:
      allOf:
        - $ref: '#/components/schemas/Payout'
        - type: object
          required:
            - transfers
          properties:
            transfers:
              type: array
              items:
                $ref: '#/components/schemas/PayoutTransfer'
    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'
    Payout:
      type: object
      required:
        - payoutId
        - createdAt
        - status
        - currency
        - paymentsCount
        - salesMinor
        - costMinor
        - receivedMinor
      properties:
        payoutId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/PayoutStatus'
        currency:
          type: string
        paymentsCount:
          type: integer
        salesMinor:
          type: integer
          description: Lo que pagaron tus clientes.
        costMinor:
          type: integer
          description: Costo del débito más la comisión del otro banco.
        receivedMinor:
          type: integer
          description: Lo que llegó a tus cuentas.
      example:
        payoutId: 9c41a0e2-5b7d-4a8e-9f1c-2d3e4f5a6b7c
        createdAt: '2026-11-04T22:00:00Z'
        status: received
        currency: VES
        paymentsCount: 37
        salesMinor: 1250000
        costMinor: 32450
        receivedMinor: 1217550
    PayoutTransfer:
      type: object
      required:
        - beneficiaryId
        - kind
        - bankCode
        - bankName
        - maskedAccount
        - alias
        - status
        - amountMinor
        - otherBankFeeMinor
        - bankReference
        - receivedAt
      properties:
        beneficiaryId:
          type:
            - string
            - 'null'
          format: uuid
        kind:
          type: string
          enum:
            - principal
            - additional
            - api
        bankCode:
          type: string
        bankName:
          type: string
        maskedAccount:
          type: string
          description: Banco y últimos 4 dígitos; nunca el número ni el titular.
        alias:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/PayoutTransferStatus'
        amountMinor:
          type: integer
          description: Lo que se envió a esta cuenta.
        otherBankFeeMinor:
          type: integer
        bankReference:
          type:
            - string
            - 'null'
          description: La referencia que aparece en tu estado de cuenta.
        receivedAt:
          type:
            - string
            - 'null'
          format: date-time
    PayoutStatus:
      type: string
      enum:
        - in_transit
        - received
        - partly_redirected
        - in_review
      description: >-
        `in_transit`: va en camino. `received`: todo llegó. `partly_redirected`:
        una cuenta rechazó el dinero y esa parte fue a tu cuenta principal.
        `in_review`: Cobrix la está revisando.
    PayoutTransferStatus:
      type: string
      enum:
        - in_transit
        - received
        - retrying
        - refused
        - in_review
      description: >-
        `retrying`: no salió y sale en la siguiente dispersión. `refused`: el
        banco rechazó esa cuenta y su parte fue a la principal.
  responses:
    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'
    NotFound:
      description: Recurso no encontrado dentro del source
      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.

````

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