Skip to main content
POST
Cancelar débito

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}$

Path Parameters

companyId
string<uuid>
required

Empresa vinculada a la llave.

id
string<uuid>
required

El id que respondió POST direct-debits o POST direct-debits/{id}/otp.

Response

El débito en cancelled

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