Skip to main content
POST
Reportar pago verificado

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
source
string
required
Minimum string length: 1
externalPaymentId
string
required
Minimum string length: 1
customerExternalId
string
required
Minimum string length: 1
amountMinor
number
required
Required range: x >= 1
currency
enum<string>
required
Available options:
USD,
VES,
usd,
ves
verifiedAt
string<date-time>
required
documents
object[]
required
Minimum array length: 1
method
string
idempotencyKey
string

Campo legacy opcional; el header sigue siendo obligatorio.

certifiedConversion
object
metadata
object

Response

Pago procesado

paymentId
string<uuid>
required
source
string
required
externalPaymentId
string
required
customerExternalId
string
required
companyCustomerId
string<uuid>
required
status
enum<string>
required
Available options:
applied,
partially_applied,
credited,
needs_certified_rate,
no_open_documents,
failed,
already_processed
paymentCurrency
string
required
applicationCurrency
string
required
totalAppliedMinor
integer
required
creditCreatedMinor
integer
required
documents
object[]
required