Skip to main content
GET
Consultar pago

Authorizations

Authorization
string
header
required

Llave cbx_live creada para el partner.

Headers

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.

externalPaymentId
string
required

Response

Detalle del pago

paymentId
string<uuid>
required
source
string
required
externalPaymentId
string
required
companyCustomerId
string<uuid>
required
amountMinor
integer
required
paymentCurrency
string
required
applicationCurrency
string
required
status
enum<string>
required
Available options:
applied,
partially_applied,
credited,
needs_certified_rate,
no_open_documents,
failed,
already_processed
totalAppliedMinor
integer
required
creditCreatedMinor
integer
required
documents
object[]
required
customer
object
paymentStatus
string
pendingReason
string
paidAt
string<date-time>
createdAt
string<date-time>
updatedAt
string<date-time>
exchangeRateId
string<uuid>
exchangeRateUsed
string