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/",
  "tracking_key": "s2123423423324334",
  "return_reason": null,
  "counterparty": {
    "holder_id": "OODC911119JL3",
    "holder_name": "Carmen Marcela",
    "account_number": "012969123456789120",
    "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

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).
`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` or `returned`.
`mode`	string	Mode of the API (`test` or `live`).
`post_date`	string	The date the transfer was posted (YYYY-MM-DD format).
`transaction_date`	string	The actual date when the transfer was initiated (YYYY-MM-DD format).
`comment`	string	A comment or reference provided by the sender for the transfer.
`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	Details on why the Transfer was returned. Is`null` unless in `returned` status.
`counterparty`	object	Information about the Counterparty (sender if inbound, receiver if outbound) of the transfer. See details below.
`account_number`	object	The AccountNumber object associated with this transfer. See below for details on this object.
`metadata`	object	Optional key-value pairs associated with this account number.

Counterparty Object (within Transfer 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 (within Counterparty)

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).

AccountNumber Object (within Transfer Object)

Field	Type	Description
`id`	string	Unique identifier for the account number.
`object`	string	The type of the object, which is always `account_number`.
`description`	string	A description you can use to easily identify this Account Number (40 chars max.).
`number`	string	The account number (for Mexico: CLABE) of the sender.
`created_at`	string	Timestamp when the account number was created (in ISO 8601 format).
`mode`	string	Mode of the API (`test` or `live`).
`metadata`	object	Optional key-value pairs associated with this account number.