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

# Enviar un vuelto

> Crea el vuelto y lo envía al banco: un pago móvil desde la cuenta de la empresa al beneficiario. Responde `201` con el vuelto, normalmente en `processing`. El resultado llega por webhook o con `GET`. La misma `Idempotency-Key` con el mismo cuerpo devuelve la respuesta guardada y no envía dinero otra vez. No cambies de clave hasta confirmar que el vuelto quedó `failed`. El límite es 30 solicitudes por minuto por llave.



## OpenAPI

````yaml /openapi/integrations-v1.json post /integrations/v1/{companyId}/customer-payouts
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:
    post:
      tags:
        - Vueltos
      summary: Enviar un vuelto
      description: >-
        Crea el vuelto y lo envía al banco: un pago móvil desde la cuenta de la
        empresa al beneficiario. Responde `201` con el vuelto, normalmente en
        `processing`. El resultado llega por webhook o con `GET`. La misma
        `Idempotency-Key` con el mismo cuerpo devuelve la respuesta guardada y
        no envía dinero otra vez. No cambies de clave hasta confirmar que el
        vuelto quedó `failed`. El límite es 30 solicitudes por minuto por llave.
      operationId: createCustomerPayout
      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/CreateCustomerPayoutRequest'
      responses:
        '201':
          description: El vuelto, ya en la cola del banco
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPayout'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: >-
            `rate_changed`: la tasa cambió antes de enviar y Cobrix canceló el
            vuelto; repite con otra clave. `idempotency_key_expired`: el vuelto
            preparado con esa clave venció; repite con otra clave.
            `idempotency_conflict`: la clave ya se usó con otro cuerpo.
            `request_in_progress`: otra llamada con esa clave sigue en curso,
            también si dos reintentos de una llamada fallida llegan a la vez;
            repite con la misma clave. `idempotency_result_ambiguous`: deja de
            reintentar con esa clave y consulta `GET
            customer-payouts?idempotencyKey=`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '422':
          description: >-
            `account_required`, `account_not_available`,
            `payout_limit_not_configured`, `payout_limit_exceeded`,
            `payout_daily_limit_not_configured`, `payout_daily_limit_exceeded`,
            `beneficiary_document_unsupported`, `invalid_request`,
            `invalid_amount`, `rate_unavailable`, `customer_not_found`,
            `payment_not_found` o `customer_payout_rejected`. Aquí
            `invalid_request` es un rechazo del banco a datos con formato
            correcto; el de formato responde `400`. Ninguno envía dinero.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
              example:
                error:
                  code: payout_daily_limit_exceeded
                  message: >-
                    The amount would exceed the company daily limit for API
                    payouts (Venezuela day).
                  requestId: req-1001
        '429':
          description: '`rate_limited`: más de 30 vueltos por minuto con esta llave.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationError'
        '500':
          description: >-
            `internal_error`: falló algo de Cobrix y no se sabe si el vuelto se
            creó. Repite con la misma `Idempotency-Key`. No uses otra sin buscar
            antes el vuelto con `GET customer-payouts?idempotencyKey=`. El
            mensaje es genérico. 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
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:
    CreateCustomerPayoutRequest:
      type: object
      required:
        - customerId
        - amountMinor
        - currency
        - bankCode
        - phone
        - document
        - concept
        - reason
      properties:
        customerId:
          type: string
          format: uuid
          description: >-
            El cliente de la empresa en Cobrix: el `companyCustomerId` que
            devuelven `POST customers/upsert` y `GET customers`.
        accountId:
          type: string
          format: uuid
          description: >-
            Cuenta de origen. Opcional si la empresa tiene una sola cuenta
            habilitada para vueltos.
        amountMinor:
          type: integer
          minimum: 1
          maximum: 999999999999999
          description: >-
            Monto en unidades menores de `currency`, como número entero JSON:
            `500` es USD 5,00. Un texto (`"500"`, `"5.00"`) responde `400
            invalid_request`.
        currency:
          type: string
          enum:
            - VES
            - USD
            - EUR
          description: >-
            `USD` y `EUR` se convierten a bolívares con la tasa certificada de
            la empresa.
        bankCode:
          type: string
          pattern: ^[0-9]{4}$
          description: Banco del beneficiario.
        phone:
          type: string
          pattern: ^(0[0-9]{10}|58[0-9]{10})$
          description: 'Teléfono del beneficiario: `04120000000` o `584120000000`.'
        document:
          type: string
          pattern: ^[VEJ][0-9]{9}$
          description: 'Documento del beneficiario: `V`, `E` o `J` y 9 dígitos.'
        concept:
          type: string
          pattern: ^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{1,60}$
          description: 'Concepto del pago móvil: solo letras y espacios, hasta 60.'
        reason:
          type: string
          minLength: 10
          maxLength: 300
          description: Por qué se devuelve el dinero. Queda en la auditoría de la empresa.
        paymentId:
          type: string
          format: uuid
          description: El pago de Cobrix de ese cliente que originó el vuelto.
        externalReference:
          type: string
          minLength: 1
          maxLength: 100
          description: Tu referencia. Vuelve tal cual y viaja en los webhooks.
      example:
        customerId: 2c7a9e1b-4d6f-4a3c-8b5e-1f0d9c8b7a65
        amountMinor: 500
        currency: USD
        bankCode: '0102'
        phone: '04120000000'
        document: V012345678
        concept: Vuelto de compra
        reason: Pago duplicado del pedido PED-1001
        externalReference: PED-1001
    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'
    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.
    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.
  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'
  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.