Transfer object

A Transfer object represents money received in or sent from your Account Numbers. It includes the transfer’s amount, currency, direction, counterparty, and status.

{
  "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": "012969123456789120",
    "account_type": "clabe",
    "holder_id": "OODC911119JL3",
    "holder_name": "Carmen Marcela",
    "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/",
  "reference_id": "130824",
  "return_reason": null,
  "status": "succeeded",
  "tracking_key": "s2123423423324334",
  "transaction_date": "2020-04-17T05:12:41.462Z"
}

Attribute	Type	Description
`id`	`string`	Unique identifier for the transfer.
`object`	`string`	The type of the object, which is always `transfer`.
`account_number`	`object`	The Account Number object associated with this transfer.
`account_number.id`	`string`	Unique identifier for the account number.
`account_number.object`	`string`	The type of the object, which is always `account_number`.
`account_number.account_id`	`string`	Account the Account Number points to.
`account_number.created_at`	`string`	Timestamp when the account number was created (in ISO 8601 format).
`account_number.description`	`string`	A description you can use to easily identify this Account Number (40 chars max.).
`account_number.metadata`	`object`	Optional key-value pairs associated with this account number.
`account_number.mode`	`string`	Mode of the API (`test` or `live`).
`account_number.number`	`string`	The account number (for Mexico: CLABE) of the sender.
`amount`	`integer`	The amount of the transfer in the smallest currency unit (e.g. centavos for MXN). In Chile, transfers cannot be over $7.000.000 CLP.
`comment`	`string`	A comment or reference provided by the sender for the transfer, visible by the recipient. In Chile, the same amount-counterparty-comment combination cannot be used more than once per day (40 chars max.).
`counterparty`	`object`	Information about the Counterparty (sender if inbound, receiver if outbound) of the transfer.
`counterparty.account_number`	`string`	The account number (in Mexico: CLABE) of the third party of the transaction (counterparty).
`counterparty.account_type`	`string`	The type of the counterparty account. In Mexico is one of: `clabe`, `debit_card` or `phone_number`. Options for Chile: `checking`, `sight`.
`counterparty.holder_id`	`string`	The unique ID of the third party of the transaction (counterparty).
`counterparty.holder_name`	`string`	The name of the third party of the transaction (counterparty).
`counterparty.institution`	`object`	The institution object containing details about the sender’s financial institution.
`counterparty.institution.id`	`string`	Unique identifier for the institution.
`counterparty.institution.country`	`string`	The country where the financial institution is located (in ISO 3166-1 alpha-2 format, e.g., `mx` for Mexico).
`counterparty.institution.name`	`string`	The name of the financial institution.
`currency`	`string`	Currency of the transfer (in ISO 4217 format, e.g., MXN).
`direction`	`string`	Either `inbound` (if you are receiving a transfer to your Account Number) or `outbound` (if you are sending a transfer from your Account).
`metadata`	`object`	Optional key-value pairs associated with this transfer.
`mode`	`string`	Mode of the API (`test` or `live`).
`post_date`	`string`	The date the transfer was posted (YYYY-MM-DD format).
`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`	Details on why the Transfer was returned. Is `null` unless in `returned` status.
`status`	`string`	The status of the transfer. It can be `pending`, `succeeded`, `failed`, `returned`, `rejected` or `return_pending`.
`tracking_key`	`string`	The unique tracking key for the transaction provided by the banking system.
`transaction_date`	`string`	The actual date when the transfer was initiated (YYYY-MM-DD format).

Fintoc API

Main Resources

Payment Initiation API

Transfers API

Movements API

Direct Debit and Subscriptions

Fiscal API

Billing API

Transfer object