transfers

Cancelar un movimiento

Changed on

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.

post/transfers/{id}/cancel

Request

Path parameters

idstring required

Response

Movimiento cancelado

idstring

ID del movimiento (tr_ / wi_ / sw_)

status'pending' | 'in_review' | 'processing' | 'sent' | 'unclaimed' | 'completed' | 'failed' | 'cancelled'

Estado canónico del movimiento

status_detailstring

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

amount_in_centsinteger

Monto en centavos debitado del balance

currencystring

Moneda del balance de origen

fee_in_centsinteger

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

net_amount_in_centsinteger

Monto neto que llega al destino después de comisiones

notestring nullable

Nota del movimiento

recipient_emailstring nullable

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

tracking_urlstring nullable

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_idstring

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_atstring date-time nullable

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

settled_atstring date-time nullable

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

bank_referencestring nullable

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_status'available' | 'pending' | 'unsupported'

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.

statement_descriptorstring nullable

Lo que le pedimos al banco que imprima en el estado de cuenta del beneficiario. Solo aplica a movimientos wi_.

balance_transaction_idstring nullable

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

created_atstring date-time

Fecha de creación

reversal_of_idstring

ID del transfer original; solo aparece en reversos por reembolso

refund_idstring

ID del reembolso que originó el reverso

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API