Skip to main content
POST
Emitir un token de vuelto embebido

Authorizations

Authorization
string
header
required

Llave cbx_live creada para el partner.

Headers

Idempotency-Key
string
required

Identificador estable de la operación.

Minimum string length: 1
Cobrix-Timestamp
string
required

Segundos Unix dentro de una ventana de cinco minutos.

Pattern: ^[0-9]{10}$
Cobrix-Signature
string
required

HMAC-SHA256 de timestamp, método, ruta y cuerpo crudo.

Pattern: ^v1=[a-f0-9]{64}$
X-Request-Id
string

Identificador opcional para correlación de soporte.

Path Parameters

companyId
string<uuid>
required

Empresa vinculada a la llave.

Body

application/json

Cada campo acepta solo el tipo JSON de su esquema; Cobrix no convierte tipos.

El vuelto que el token deja fijo. Cada campo acepta solo el tipo JSON de su esquema. Un campo que no está aquí responde 400 invalid_request, también expiresInSeconds y maxAttempts: son fijos.

customerId
string<uuid>
required

El cliente de la empresa en Cobrix: el companyCustomerId que devuelven POST customers/upsert y GET customers.

amountMinor
integer
required

Monto en céntimos de bolívar, como número entero JSON: 150000 es Bs 1.500,00.

Required range: 1 <= x <= 999999999999999
concept
string
required

Concepto del pago móvil: solo letras y espacios, hasta 60. Además, el banco de la cuenta de origen debe aceptarlo; si no, 422 invalid_field.

Pattern: ^[A-Za-zÁÉÍÓÚÜÑáéíóúüñ ]{1,60}$
reason
string
required

Por qué se devuelve el dinero. Queda en la auditoría de la empresa.

Required string length: 10 - 300
externalReference
string
required

Tu referencia. Viaja en el vuelto y en los webhooks.

Required string length: 1 - 100
accountId
string<uuid>

Cuenta de origen. Opcional si la empresa tiene una sola cuenta habilitada para vueltos.

currency
enum<string>

Solo VES. Un vuelto embebido nunca se convierte.

Available options:
VES
document
string

Documento de quien recibe, si ya lo sabes: V, E o J y 9 dígitos. Con él, el formulario no lo pide. Si el banco de la cuenta no paga ese tipo, 422 beneficiary_document_unsupported.

Pattern: ^[VEJ][0-9]{9}$

Response

El token emitido

id
string
required

Identifica el token en GET y DELETE customer-payouts/tokens/{tokenId}. Es un UUID.

token
string
required

El token completo, cpt_…_secret_…. Solo vuelve en esta respuesta. Entrégaselo a tu página para checkout.js; nunca lo pongas en una URL.

expiresAt
string<date-time>
required

Cuándo caduca: 5 minutos después de emitirlo.

maxAttempts
integer
required

Siempre 3.

amountMinor
integer
required
currency
string
required

Siempre VES.

externalReference
string
required