Skip to main content
POST
Pedir el código

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
externalDocumentId
string
required

Tu referencia del cobro. Si ya existe y sigue abierta, Cobrix la actualiza y abre un cobro nuevo.

Required string length: 1 - 200
customerExternalId
string
required

El cliente en tu sistema.

Required string length: 1 - 200
customer
object
required
currency
enum<string>
required

Moneda del cobro. El banco siempre debita bolívares.

Available options:
USD,
VES,
EUR
totalMinor
integer
required

Total en unidades menores: 1500 es USD 15,00.

Required range: x >= 1
payer
object
required

Quién paga: la cuenta que el banco debita, con los datos que el banco tiene.

description
string

Texto del cobro cuando no envías lines. También es el concepto del débito.

Required string length: 1 - 500
lines
object[]

Las líneas del cobro. Cada amountMinor es quantity por unitAmountMinor y la suma da totalMinor.

Minimum array length: 1
dueDate
string

Fecha ISO 8601. Por defecto, hoy.

expiresInHours
integer
default:72
Required range: 1 <= x <= 720
splits
object[]

Opcional. Reparte esta venta entre varias cuentas, con el mismo formato y los mismos errores que en Links de cobro. La llave necesita además payout_splits:write.

Required array length: 1 - 20 elements

Response

Código enviado: el débito queda en otp_sent

id
string<uuid>
required

El débito. Es el directDebitId de payment.failed.

externalDocumentId
string
required

Tu referencia del cobro.

status
enum<string>
required

otp_sent: el banco envió el código, falta ejecutar. processing: enviado al banco, falta su respuesta. succeeded: cobrado y aplicado al documento. failed: el banco lo rechazó o falló el cobro. expired: el código venció; Cobrix lo cierra solo un minuto después. cancelled: lo cancelaste. Solo succeeded mueve dinero.

Available options:
otp_sent,
processing,
succeeded,
failed,
expired,
cancelled
amount
object
required

Lo que el banco debita, siempre en bolívares.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
reference
object
required

El total del cobro en su moneda.

otp
object

Solo mientras espera su código (otp_sent).

paymentId
string<uuid>

Solo en succeeded. Es el data.paymentId de payment.succeeded.

error
object

Por qué un débito failed, expired o cancelled no se cobró.

splits
object[]

Solo cuando la petición trajo splits: cada cuenta enmascarada, en el mismo orden, como en Links de cobro.