v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Transfers

Simulate receiving a transfer

Test-mode helper that simulates an inbound transfer into one of your account numbers, so you can exercise incoming-transfer flows. Only available with a test API key.

post/simulate/receive_transfer

Request body

account_number_idstring required

Account number that receives the simulated transfer.

amountinteger required

Amount to receive, in the smallest currency unit. For MXN this is centavos; CLP has no minor unit. The minimum is 1.

currency'CLP' | 'MXN' required

Currency of the transfer. One of CLP, MXN.

commentstring

Comment to attach to the simulated transfer.

reference_idstring

Numeric reference shown in the counterparty statement in Mexico. Up to 7 digits.

counterparty_account_numberstring

Account number of the simulated sender. In Mexico, Fintoc derives the sender's account type and institution from this value. Use a standardized Mexican bank account number (CLABE), debit card number, mobile phone number, or a Chilean bank account number; defaults to a Fintoc test counterparty when omitted.

counterparty_account_typestring

Type of the simulated sender account, used in Chile. One of checking_account, sight_account, or savings_account.

counterparty_institution_idstring

Identifier of the simulated sender's financial institution, used in Chile. Use a bank public ID such as cl_banco_santander. In Mexico, Fintoc ignores this value and derives the institution from counterparty_account_number.

counterparty_holder_idstring

Tax ID of the simulated sender. Use a Chilean tax ID (RUT) in Chile, or a Mexican tax ID (RFC) in Mexico.

counterparty_holder_namestring

Name of the simulated sender account holder.

Example request

{
  "account_number_id": "acno_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
  "amount": 1500,
  "currency": "CLP",
  "comment": "Test deposit",
  "reference_id": "1234567",
  "counterparty_account_number": "646180111800000000",
  "counterparty_account_type": "checking_account",
  "counterparty_institution_id": "cl_banco_santander",
  "counterparty_holder_id": "11.111.111-1",
  "counterparty_holder_name": "Test Customer 1"
}

Response

The simulated inbound transfer.

idstring required

Unique identifier of the transfer.

object'transfer' required

Type of the object. Always transfer.

amountinteger required

Amount of the transfer, in the smallest currency unit. For MXN this is centavos; CLP has no minor unit.

commentstring nullable required

Comment shown to the counterparty, or null.

currency'CLP' | 'MXN' required

Currency of the transfer. One of CLP, MXN.

direction'inbound' | 'outbound' required

Whether the transfer is inbound or outbound.

metadataobject required

Set of key-value pairs attached to the transfer.

mode'live' | 'test' required

Whether the transfer is live or test data.

post_datestring date-time nullable required

Time the transfer was posted, as an ISO 8601 datetime in UTC, or null.

receipt_urlstring nullable required

URL of the transfer receipt, or null.

reference_idstring nullable required

Numeric reference shown in the counterparty statement in Mexico, or null.

return_reasonstring nullable required

Reason code when the transfer was returned, or null.

status'succeeded' | 'rejected' | 'failed' | 'pending' | 'returned' | 'return_pending' | 'reject_failed' required

Lifecycle status of the transfer. One of pending (being processed), succeeded (settled), rejected (rejected before settling), failed (could not be processed), returned (settled, then returned to the sender), return_pending (a return is in progress), or reject_failed (the rejection could not be completed).

tracking_keystring nullable required

Interbank tracking key (clave de rastreo) of the transfer, or null.

transaction_datestring date-time nullable required

Time the transfer occurred, as an ISO 8601 datetime in UTC, or null.

Example response

{
  "id": "tr_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
  "account_number": {
    "id": "acno_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
    "account_id": "acc_2hQ9vBmKpR7xLtZ3sWn1fJ4dGcA",
    "created_at": "2026-03-01T12:00:00.000Z",
    "description": "Payouts CLABE",
    "metadata": {
      "invoice_id": "12345"
    },
    "mode": "test",
    "number": "646180111800000000",
    "options": {
      "min_amount": 1000,
      "max_amount": 1000000
    },
    "status": "enabled",
    "updated_at": "2026-03-01T12:00:00.000Z"
  },
  "amount": 50000,
  "comment": "Payout March",
  "counterparty": {
    "account_number": "132000000000000004",
    "account_type": "clabe",
    "holder_name": "Test Customer 1",
    "institution": {
      "id": "40132",
      "name": "MULTIVA BANCO",
      "country": "mx"
    }
  },
  "currency": "MXN",
  "direction": "outbound",
  "entity": {
    "id": "ent_2eGhTp1rLqWnXkZbYc4JsKmAvD9",
    "holder_id": "000000000",
    "holder_name": "Test Customer 1",
    "is_root": true
  },
  "metadata": {
    "test_key": "test_value"
  },
  "mode": "test",
  "status": "succeeded",
  "transaction_date": "2026-03-01T12:00:00.000Z"
}