Transfer Object

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

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 a Account Number (Clave Bancaria Estandarizada (CLABE)) you own, and you create one when you initiate an outbound transfer from one of your Accounts. Each Transfer references the Account Number it settled against and the Counterparty on the other side of the rail.

Field	Type	Description
`id`	string	Unique identifier for the transfer.
`object`	string	The type of the object, which is always transfer.
`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.
`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).
`status`	string	The status of the transfer. It can be `pending`, `succeeded`, `failed`, `returned`, `rejected` or `return_pending`.
`mode`	string	Mode of the API (`test` or `live`).
`post_date`	string	Timestamp when the transfer was posted (ISO 8601 format).
`transaction_date`	string	Timestamp when the transfer was initiated (ISO 8601 format).
`comment`	string	A comment or reference describing the transfer. For outbound transfers, you provide it; for inbound transfers, you see what the sender wrote. Max 40 chars.
`reference_id`	string	A unique reference ID for the transfer, used for reconciliation purposes.
`receipt_url`	string	A URL to the receipt of the transfer, if available.
`tracking_key`	string	The unique tracking key for the transaction provided by the banking system.
`return_reason`	string \| null	Reason the transfer was returned. null unless status is returned. See the full list of SPEI return codes.
`counterparty`	object	Information about the counterparty: the party sending you the funds if inbound, or the party you are paying if outbound.
`account_number`	object	The AccountNumber you used to send or receive this transfer.
`metadata`	object	Optional key-value pairs you can attach to the object.

Counterparty object

Field	Type	Description
`holder_id`	string	The unique ID of the third party of the transaction (counterparty).
`holder_name`	string	The name of the third party of the transaction (counterparty).
`account_number`	string	The account number (in Mexico: CLABE) of the third party of the transaction (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`.
`institution`	object	The institution object containing details about the sender's financial institution.

Institution object

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