Skip to main content
GET
Consultar un token de 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.

tokenId
string<uuid>
required

El id que respondió POST customer-payouts/tokens. Otro valor que no sea un UUID responde 400 invalid_request.

Response

El token

id
string
required

El id del token. Es un UUID.

status
enum<string>
required

active: se puede usar. used: creó su vuelto; payoutId y payoutStatus dicen dónde está. exhausted: gastó sus intentos, o llegó a su tope de envíos, sin crear un vuelto. expired: caducó sin crear un vuelto. revoked: lo revocaste, o la llave que lo emitió ya no sirve. Un token exhausted se lee expired cuando caduca y revoked si lo revocas.

Available options:
active,
used,
exhausted,
expired,
revoked
attemptsUsed
integer
required

Intentos gastados. Un intento devuelto no cuenta. Puede ser menor que maxAttempts en un token exhausted: llegó a su tope de envíos.

maxAttempts
integer
required
expiresAt
string<date-time>
required
externalReference
string | null
required
payoutId
string<uuid> | null
required

El vuelto que creó el token. Léelo con GET customer-payouts/{payoutId}. null hasta entonces.

payoutStatus
enum<string> | null
required

El estado actual de ese vuelto. null sin vuelto.

Available options:
processing,
sent,
failed,
unknown
lastErrorCode
string | null
required

El código del último intento que no creó un vuelto, por ejemplo invalid_request, beneficiary_document_unsupported o payout_daily_limit_exceeded. rate_limited si lo frenó el límite de la llave.