Skip to main content
POST
Emitir un token de validación embebida

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

receiverAccountKey
string
required

La cuenta de la empresa que recibe el pago, de GET payment-verifications/receiver-accounts.

amountMinor
integer
required

Monto del pedido en unidades menores, como número entero JSON: 150000 es Bs 1.500,00.

Required range: x >= 1
externalReference
string
required

Tu referencia del pedido. Vuelve en cada validación hecha con el token y en sus webhooks.

Required string length: 1 - 128
currency
string

La moneda de la cuenta receptora. Si no la envías, es esa. Otra responde 422 invalid_field.

Pattern: ^[A-Z]{3}$
methods
enum<string>[]

Los métodos que tu cliente puede usar. Solo métodos que trae la cuenta en GET payment-verifications/receiver-accounts: pago_movil en una cuenta bancaria (bank:…) sin teléfono receptor conocido responde 422 method_not_available. Por defecto, todos los de la cuenta.

pago_movil y bank_transfer: Cobrix consulta al banco. zelle: lo revisa una persona de la empresa.

Available options:
pago_movil,
bank_transfer,
zelle
metadata
object

Objeto JSON que vuelve en la validación. Hasta 2048 bytes serializado. El navegador nunca lo ve.

expiresInSeconds
integer
default:900

Cuánto vive el token, en segundos. Por defecto, 900 (15 minutos).

Required range: 60 <= x <= 1800
maxAttempts
integer
default:5

Cuántos intentos tiene tu cliente. Por defecto, 5.

Required range: 1 <= x <= 5

Response

El token emitido

id
string
required

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

token
string
required

El token completo, pvt_…_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.

maxAttempts
integer
required
methods
enum<string>[]
required

Los métodos que tu cliente puede usar.

pago_movil y bank_transfer: Cobrix consulta al banco. zelle: lo revisa una persona de la empresa.

Available options:
pago_movil,
bank_transfer,
zelle
amountMinor
integer
required
currency
string
required

La moneda de la cuenta receptora.

externalReference
string
required