RErecurrente
transfers

Listar movimientos de dinero

Changed on

Lista unificada de todo el dinero que sale de tu balance, del más reciente al más antiguo: retiros bancarios (wi_), transferencias p2p (tr_) y envíos de stablecoin (sw_).

Filtra por tipo de destino con types[] y por cualquiera de las tres fechas de un retiro: creación (from_time + until_time), envío al banco (sent_from + sent_until) y liquidación bancaria confirmada (settled_from + settled_until).

sent_* y settled_* solo aplican a retiros bancarios, así que limitan la lista a bank_account; combinarlos con otros types[] devuelve 400. Cada par se envía completo: enviar solo una mitad devuelve 400 en vez de ignorar el rango.

Para conciliar depósitos, usa settled_* cuando el retiro tenga liquidación confirmada y sent_* en cualquier otro caso: hay rieles de envío que nunca confirman una liquidación y para esos settled_at siempre viene vacío.

get/transfers

Request

Query parameters

types[]TransfersGetParametersTypesSchemaItems[]

Filtra por tipo de destino: bank_account, account, phone_number, crypto_address

from_timestring date-time

Inicio del rango de creación. Si se envía como fecha sin hora, se interpreta como el inicio del día. Se aplica solo junto con until_time.

until_timestring date-time

Fin del rango de creación. Si se envía como fecha sin hora, se interpreta como el final del día. Se aplica solo junto con from_time.

sent_fromstring date-time

Inicio del rango de envío al banco (sent_at). Limita la lista a retiros bancarios y se envía junto con sent_until.

sent_untilstring date-time

Fin del rango de envío al banco. Si se envía como fecha sin hora, se interpreta como el final del día. Se envía junto con sent_from.

settled_fromstring date-time

Inicio del rango de liquidación bancaria confirmada. Devuelve únicamente retiros confirmados o completados y se aplica solo junto con settled_until.

settled_untilstring date-time

Fin del rango de liquidación bancaria confirmada. Si se envía como fecha sin hora, se interpreta como el final del día. Devuelve únicamente retiros confirmados o completados y se aplica solo junto con settled_from.

itemsinteger

Elementos por página.

Response

Lista unificada de movimientos

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

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API

  • 3389210172a9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status