Skip to navigation

Cancelar un movimiento

Cancela un movimiento que aún puede cancelarse: una transferencia a teléfono no reclamada (tr_), o un retiro pendiente que no ha entrado a un lote de pago (wi_). Los envíos de stablecoin (sw_) no se pueden cancelar.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired

Response

Movimiento cancelado
idstringOptional

ID del movimiento (tr_ / wi_ / sw_)

statusenumOptional

Estado canónico del movimiento

status_detailstringOptional

Estado crudo del registro subyacente (p. ej. approved, rejected, review_requested)

amount_in_centsintegerOptional
Monto en centavos debitado del balance
currencystringOptional
Moneda del balance de origen
fee_in_centsintegerOptional

Comisión en centavos (retiros instantáneos / internacionales; 0 para p2p)

net_amount_in_centsintegerOptional

Monto neto que llega al destino después de comisiones

notestring or nullOptional
Nota del movimiento
recipient_emailstring or nullOptional

Correo del beneficiario al que le avisamos el estado del retiro. Solo aplica a movimientos wi_.

tracking_urlstring or nullOptional

Página pública de seguimiento para el beneficiario (monto que recibe, cuenta enmascarada, estado y fecha estimada de llegada). Solo aplica a movimientos wi_; compártela con quien recibe el dinero.

account_idstringOptional

Cuenta cuyo balance movió este envío. Siempre presente, para que una lista que abarca varias cuentas de una organización siga siendo atribuible.

sent_atdatetime or nullOptional

Momento en que Recurrente envió el retiro al banco; solo aplica a retiros bancarios (wi_).

settled_atdatetime or nullOptional

Momento de liquidación bancaria confirmada. Solo está presente para retiros bancarios confirmados o completados (wi_).

bank_referencestring or nullOptional

Referencia que devolvió el riel de envío, cuando ese riel devuelve una. Solo aplica a movimientos wi_; no identifica ni enumera transacciones que conformen el retiro.

bank_reference_statusenum or nullOptional

Qué esperar de bank_reference: available si ya existe, pending si el retiro aún no sale y podría traerla, y unsupported si ya salió por un riel que nunca devuelve una. Con unsupported, concilia el depósito por statement_descriptor.

Allowed values:
statement_descriptorstring or nullOptional

Lo que le pedimos al banco que imprima en el estado de cuenta del beneficiario. Solo aplica a movimientos wi_. Es el id wi_, o la note seguida del id cuando caben en 30 caracteres; si la nota sola llena el espacio, no incluye el id. Se fija al crear el retiro. En destinos internacionales es siempre el id, porque esos rieles todavía no llevan referencia.

balance_transaction_idstring or nullOptional

Fila del ledger que registró este movimiento (GET /api/balance_transactions/{id}). Vacío mientras el dinero no haya salido del balance.

destinationobjectOptional

Destino del movimiento. Los campos presentes dependen de type.

currency_conversionobject or nullOptional

(Solo registros wi_) La conversión que pagó el retiro cuando el balance de origen está en otra moneda que la cuenta bancaria (por ejemplo, de tu balance en USD a una cuenta en GTQ). source_amount_in_cents es lo que salió de tu balance; amount_in_cents del retiro es lo convertido. null si no hubo conversión. Si el retiro se rechaza o se cancela dentro de las 72 horas, la conversión pasa a reverted y el monto vuelve a tu balance en la moneda de origen.

created_atdatetimeOptional

Fecha de creación

senderobjectOptional

(Solo registros tr_) Cuenta emisora — campo legado

recipientobjectOptional

(Solo registros tr_) Destinatario — campo legado

reversal_of_idstringOptional

ID del transfer original; solo aparece en reversos por reembolso

refund_idstringOptional

ID del reembolso que originó el reverso

Errors

422
Unprocessable Entity Error