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

> El estado actual de un vuelto pedido por la API.



## OpenAPI

````yaml /openapi/integrations-v1.json get /integrations/v1/{companyId}/customer-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}/customer-payouts/{payoutId}:
    get:
      tags:
        - Vueltos
      summary: Consultar vuelto
      description: El estado actual de un vuelto pedido por la API.
      operationId: getCustomerPayout
      parameters:
        - $ref: '#/components/parameters/CompanyId'
        - name: payoutId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: El `id` que respondió `POST customer-payouts`.
        - $ref: '#/components/parameters/CobrixTimestamp'
        - $ref: '#/components/parameters/CobrixSignature'
      responses:
        '200':
          description: El vuelto
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPayout'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            `customer_payout_not_found`: no existe, es de otra empresa o no se
            pidió por la API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '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.
    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:
    CustomerPayout:
      type: object
      required:
        - id
        - status
        - amountMinor
        - currency
        - sourceAmountMinor
        - sourceCurrency
        - rateEffectiveAt
        - customerId
        - accountId
        - beneficiaryMasked
        - externalReference
        - failureCode
        - bankReferenceMasked
        - createdAt
        - finishedAt
      description: Un vuelto. También es el `data` de los webhooks `customer_payout.*`.
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/CustomerPayoutStatus'
        amountMinor:
          type: integer
          description: >-
            Lo que recibe el beneficiario, en unidades menores de `currency`. Es
            el monto que se envía.
        currency:
          type: string
          description: 'La moneda del banco: `VES`.'
        sourceAmountMinor:
          type: integer
          description: Lo que pediste.
        sourceCurrency:
          type: string
        rateEffectiveAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Fecha de la tasa certificada usada. `null` si pediste en bolívares.
        customerId:
          type: string
          format: uuid
        accountId:
          type: string
          format: uuid
          description: La cuenta de origen usada.
        beneficiaryMasked:
          type: string
          description: >-
            Banco, últimos 4 dígitos del teléfono y documento enmascarado. El
            teléfono y el documento completos nunca vuelven.
        externalReference:
          type:
            - string
            - 'null'
        failureCode:
          type:
            - string
            - 'null'
          description: >-
            Solo en `failed` o `unknown`. Es diagnóstico y depende del banco: no
            programes lógica sobre él.
        bankReferenceMasked:
          type:
            - string
            - 'null'
          description: Los últimos 4 dígitos de la referencia del banco, cuando la hay.
        createdAt:
          type: string
          format: date-time
        finishedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Cuándo se registró su resultado. `null` si todavía no lo tiene.
      example:
        id: 5a9e3c1d-7f2b-4e86-b0c4-9d8a7f6e5b41
        status: processing
        amountMinor: 437825
        currency: VES
        sourceAmountMinor: 500
        sourceCurrency: USD
        rateEffectiveAt: '2026-11-14T04:00:00.000Z'
        customerId: 2c7a9e1b-4d6f-4a3c-8b5e-1f0d9c8b7a65
        accountId: 8d4f1a6c-3b7e-4c92-a5d0-6e1f2a3b4c5d
        beneficiaryMasked: 0102 · ***0000 · V*****78
        externalReference: PED-1001
        failureCode: null
        bankReferenceMasked: null
        createdAt: '2026-11-14T10:00:00.000Z'
        finishedAt: 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'
    CustomerPayoutStatus:
      type: string
      enum:
        - processing
        - sent
        - failed
        - unknown
      description: >-
        `processing`: en camino al banco. `sent`: el banco lo pagó. `failed`: no
        salió dinero. `unknown`: pudo llegar al banco sin una respuesta clara;
        no lo reintentes: Cobrix lo concilia con el banco y pasa a `sent` o
        `failed`. `sent` y `failed` son finales.
    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
    Forbidden:
      description: Empresa o scope no autorizado
      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
    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.