Transfer Object
{
"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": "XAXX010101000",
"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"
}
Objeto Transfer
Una transferencia (Transfer) representa un movimiento de fondos hacia o desde una de tus cuentas. Recibes un objetoTransfer cuando una transferencia entrante llega a un Account Number (Clave Bancaria Estandarizada (CLABE)) de tu propiedad, y creas uno cuando inicias una transferencia saliente desde una de tus Accounts. Cada Transfer referencia el Account Number con el que se liquidó y el Counterparty al otro lado del riel.
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único de la transferencia. |
object | string | El tipo del objeto, que siempre es transfer. |
account_number | object | El AccountNumber que usaste para enviar o recibir esta transferencia. |
amount | integer | El monto de la transferencia en la unidad mínima de la moneda (por ejemplo, centavos para MXN). En Chile, las transferencias no pueden superar los $7.000.000 CLP. |
comment | string | Un comentario o referencia que describe la transferencia. Para transferencias salientes, tú lo proporcionas; para entrantes, ves lo que escribió el remitente. Máx. 40 caracteres. |
counterparty | object | Información sobre la contraparte: quien te envía los fondos si es entrante, o a quien le pagas si es saliente. |
currency | string | Moneda de la transferencia (en formato ISO 4217, por ejemplo mxn). |
direction | string | inbound (si estás recibiendo una transferencia a tu Account Number) u outbound si estás enviando una transferencia desde tu cuenta. |
metadata | object | Pares clave-valor opcionales que puedes adjuntar al objeto. |
mode | string | Modo de la API (test o live). |
post_date | string | Marca temporal de cuándo se contabilizó la transferencia (formato ISO 8601). |
receipt_url | string | Una URL al comprobante de la transferencia, si está disponible. |
reference_id | string | Un ID de referencia único para la transferencia, usado con fines de conciliación. |
return_reason | string | null | Razón por la que se devolvió la transferencia. null salvo que status sea returned. Consulta la lista completa de códigos de devolución SPEI. |
status | string | El estado de la transferencia. Uno de pending, succeeded, rejected, failed, returned, return_pending o reject_failed. |
tracking_key | string | La clave única de rastreo de la transacción proporcionada por el sistema bancario. |
transaction_date | string | Marca temporal de cuándo se inició la transferencia (formato ISO 8601). |
Objeto Counterparty
| Campo | Tipo | Descripción |
|---|---|---|
account_number | string | El número de cuenta (en México: CLABE) del tercero de la transacción (contraparte). |
account_type | string | El tipo de cuenta de la contraparte. En México es uno de: clabe, debit_card o phone_number. Opciones para Chile: checking, sight. |
email | string | null | Email de la contraparte, o null. |
holder_id | string | El ID único del tercero de la transacción (contraparte). |
holder_name | string | El nombre del tercero de la transacción (contraparte). |
institution | object | El objeto institution con los detalles de la institución financiera del remitente. |
Objeto Institution
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador único de la institución. Consulta Códigos de instituciones de Chile o Códigos de instituciones de México. |
country | string | El país donde se encuentra la institución financiera (en formato ISO 3166-1 alpha-2, por ejemplo mx para México). |
name | string | El nombre de la institución financiera. |