v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Transfers

List transfers

Lists the transfers of your organization in the live or test mode of the API key used. Filter by account_id, account_number_id, direction, status, tracking_key, and transfer_batch_id, or by date range with since and until. The list is paginated. Use the starting_after, ending_before, and limit query parameters to page through it. The Link response header carries the URLs to navigate the pages.

get/transfers

Query parameters

account_idstring

Identifier of the account whose transfers are returned.

account_number_idstring

Identifier of the account number whose transfers are returned.

direction'inbound' | 'outbound'

Direction of the transfers to return. One of inbound or outbound.

statusstring[]

Statuses to filter by. One or more of succeeded, rejected, failed, pending, returned, return_pending, and reject_failed. Returns transfers whose status matches any of the values you provide.

sincestring date-time

Example:2026-01-01T00:00:00Z

Lower bound for the transaction date. Returns transfers with a transaction_date on or after this ISO 8601 datetime in UTC.

untilstring date-time

Example:2026-03-31T23:59:59Z

Upper bound for the transaction date. Returns transfers with a transaction_date on or before this ISO 8601 datetime in UTC.

tracking_keystring

Example:3843CP04202404102978240559

Interbank tracking key (clave de rastreo) to filter by. Returns transfers whose tracking_key matches this value exactly. Available for Mexican transfers only.

transfer_batch_idstring

Example:trbatch_2daFu0zqqDtZGJaSi2TGI2Mm1nN

Identifier of the transfer batch to filter by. Returns the transfers that belong to this batch.

starting_afterstring

Example:tr_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

Cursor that fetches the next page of transfers. Use the ID of the last transfer from the current page.

ending_beforestring

Example:tr_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

Cursor that fetches the previous page of transfers. Use the ID of the first transfer from the current page.

limitinteger

Example:50

Maximum number of transfers to return per page. Ranges from 1 to 300. Defaults to 30.

Response

List of transfers for the current mode.

idstring required

Unique identifier of the transfer.

object'transfer' required

Type of the object. Always transfer.

amountinteger required

Amount of the transfer, in the smallest currency unit. For MXN this is centavos; CLP has no minor unit.

commentstring nullable required

Comment shown to the counterparty, or null.

currency'CLP' | 'MXN' required

Currency of the transfer. One of CLP, MXN.

direction'inbound' | 'outbound' required

Whether the transfer is inbound or outbound.

metadataobject required

Set of key-value pairs attached to the transfer.

mode'live' | 'test' required

Whether the transfer is live or test data.

post_datestring date-time nullable required

Time the transfer was posted, as an ISO 8601 datetime in UTC, or null.

receipt_urlstring nullable required

URL of the transfer receipt, or null.

reference_idstring nullable required

Numeric reference shown in the counterparty statement in Mexico, or null.

return_reasonstring nullable required

Reason code when the transfer was returned, or null.

Lifecycle status of the transfer. One of pending (being processed), succeeded (settled), rejected (rejected before settling), failed (could not be processed), returned (settled, then returned to the sender), return_pending (a return is in progress), or reject_failed (the rejection could not be completed).

tracking_keystring nullable required

Interbank tracking key (clave de rastreo) of the transfer, or null.

transaction_datestring date-time nullable required

Time the transfer occurred, as an ISO 8601 datetime in UTC, or null.

Example response

[
  {
    "id": "tr_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
    "account_number": {
      "id": "acno_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
      "account_id": "acc_2hQ9vBmKpR7xLtZ3sWn1fJ4dGcA",
      "created_at": "2026-03-01T12:00:00.000Z",
      "description": "Payouts CLABE",
      "metadata": {
        "invoice_id": "12345"
      },
      "mode": "test",
      "number": "646180111800000000",
      "options": {
        "min_amount": 1000,
        "max_amount": 1000000
      },
      "status": "enabled",
      "updated_at": "2026-03-01T12:00:00.000Z"
    },
    "amount": 50000,
    "comment": "Payout March",
    "counterparty": {
      "account_number": "132000000000000004",
      "account_type": "clabe",
      "holder_name": "Test Customer 1",
      "institution": {
        "id": "40132",
        "name": "MULTIVA BANCO",
        "country": "mx"
      }
    },
    "currency": "MXN",
    "direction": "outbound",
    "entity": {
      "id": "ent_2eGhTp1rLqWnXkZbYc4JsKmAvD9",
      "holder_id": "000000000",
      "holder_name": "Test Customer 1",
      "is_root": true
    },
    "metadata": {
      "test_key": "test_value"
    },
    "mode": "test",
    "status": "succeeded",
    "transaction_date": "2026-03-01T12:00:00.000Z"
  }
]