Transfer object

The Transfer object

A Transfer represents a movement of funds into or out of one of your accounts. You receive a Transfer object when an inbound transfer lands on an AccountNumber (CLABE, the standardized Mexican bank account number) you own, and you create one when you initiate an outbound transfer from one of your Accounts. Each Transfer references the AccountNumber it settled against and the Counterparty on the other side of the rail.

{
  "id": "tr_jKaHD105H",
  "object": "transfer",
  "account_number": {
    "id": "acno_Kasf91034gj1AD",
    "object": "account_number",
    "account_id": "acc_Jas92lf9adg94ka",
    "created_at": "2024-03-01T20:09:42.949787176Z",
    "description": "Mis payins",
    "metadata": {
      "id_cliente": "12343212"
    },
    "mode": "test",
    "number": "738969123456789120"
  },
  "amount": 2864,
  "comment": "Pago de gas",
  "counterparty": {
    "account_number": "012180000000000008",
    "account_type": "clabe",
    "email": null,
    "holder_id": "AAA010101AAA",
    "holder_name": "Jane Doe",
    "institution": {
      "id": "mx_banco_bbva",
      "country": "mx",
      "name": "BBVA Mexico"
     }
   },
  "currency": "MXN",
  "direction": "inbound",
  "metadata": {},
  "mode": "test",
  "post_date": "2020-04-17T00:00:00.000Z",
  "receipt_url": "https://www.banxico.org.mx/cep/example",
  "reference_id": "130824",
  "return_reason": null,
  "status": "succeeded",
  "tracking_key": "TEST0000000000000001",
  "transaction_date": "2020-04-17T05:12:41.462Z"
}

Field	Type	Description
`id`	`string`	Unique identifier for the transfer.
`object`	`string`	Type of the object. Always `transfer`.
`account_number`	`object`	The AccountNumber you used to send or receive this transfer.
`amount`	`integer`	Amount of the transfer in the smallest currency unit (for example, centavos for MXN). CLP has no minor unit, so the value is the number of pesos. In Chile, transfers cannot be over `7000000` CLP.
`comment`	`string`	A comment or reference describing the transfer. For outbound transfers, you provide it; for inbound transfers, you see what the sender wrote. Up to 40 characters.
`counterparty`	`object`	Information about the counterparty: the party sending you the funds if inbound, or the party you are paying if outbound.
`currency`	`string`	Currency of the transfer, in ISO 4217 format, for example `MXN`.
`direction`	`string`	Either `inbound` if you are receiving a transfer to your `AccountNumber`, or `outbound` if you are sending a transfer from your `Account`.
`metadata`	`object`	Set of key-value pairs you can attach to the object. Useful for storing additional information about the object in a structured format.
`mode`	`string`	Mode of the API. One of `test` or `live`.
`post_date`	`string`	ISO 8601 datetime in UTC of when the transfer was posted.
`receipt_url`	`string`	A URL to the receipt of the transfer, if available.
`reference_id`	`string`	A unique reference ID for the transfer, used for reconciliation purposes.
`return_reason`	`string` or `null`	Reason the transfer was returned. `null` unless `status` is `returned`. See the full list of SPEI return codes.
`status`	`string`	The status of the transfer. One of `pending`, `succeeded`, `rejected`, `failed`, `returned`, `return_pending`, or `reject_failed`.
`tracking_key`	`string`	The unique tracking key for the transaction provided by the banking system.
`transaction_date`	`string`	ISO 8601 datetime in UTC of when the transfer was initiated.

The Counterparty object (within the Transfer object)

The Counterparty object describes the party on the other side of the transfer, the sender if inbound or the payee if outbound, and it appears in the counterparty field of the Transfer object.

Field	Type	Description
`account_number`	`string`	Account number of the counterparty. In Mexico, this is a standardized Mexican bank account number (CLABE).
`account_type`	`string`	Type of the counterparty account. In Mexico, one of `clabe`, `debit_card`, or `phone_number`. In Chile, one of `checking` or `sight`.
`email`	`string` or `null`	Email of the counterparty. `null` when not provided.
`holder_id`	`string`	Tax identifier of the counterparty. In Mexico, a Mexican tax ID (RFC).
`holder_name`	`string`	Name of the counterparty.
`institution`	`object`	The institution object containing details about the counterparty's financial institution.

The Institution object (within the Counterparty object)

The Institution object identifies the counterparty's financial institution, and it appears in the institution field of the Counterparty object.

Field	Type	Description
`id`	`string`	Unique identifier for the institution. See Chile Institution Codes or Mexico Institution Codes.
`country`	`string`	Country where the financial institution is located, in ISO 3166-1 alpha-2 format, for example `mx` for Mexico.
`name`	`string`	Name of the financial institution.