Skip to main content
GET
Consultar vuelto

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.

payoutId
string<uuid>
required

El id que respondió POST customer-payouts.

Response

El vuelto

Un vuelto. También es el data de los webhooks customer_payout.*.

id
string<uuid>
required
status
enum<string>
required

processing: en camino al banco. sent: el banco lo pagó. failed: no salió dinero. unknown: pudo llegar al banco sin una respuesta clara; no lo reintentes: Cobrix lo concilia con el banco y pasa a sent o failed. sent y failed son finales.

Available options:
processing,
sent,
failed,
unknown
amountMinor
integer
required

Lo que recibe el beneficiario, en unidades menores de currency. Es el monto que se envía.

currency
string
required

La moneda del banco: VES.

sourceAmountMinor
integer
required

Lo que pediste.

sourceCurrency
string
required
rateEffectiveAt
string<date-time> | null
required

Fecha de la tasa certificada usada. null si pediste en bolívares.

customerId
string<uuid>
required
accountId
string<uuid>
required

La cuenta de origen usada.

beneficiaryMasked
string
required

Banco, últimos 4 dígitos del teléfono y documento enmascarado. El teléfono y el documento completos nunca vuelven.

externalReference
string | null
required
failureCode
string | null
required

Solo en failed o unknown. Es diagnóstico y depende del banco: no programes lógica sobre él.

bankReferenceMasked
string | null
required

Los últimos 4 dígitos de la referencia del banco, cuando la hay.

createdAt
string<date-time>
required
finishedAt
string<date-time> | null
required

Cuándo se registró su resultado. null si todavía no lo tiene.