Simulating IBAN Deposits (SANDBOX ONLY)

When building your integration in the TransFi Sandbox, you need a way to test how your system handles incoming funds without moving real money. The Simulate Incoming IBAN Deposits API allows you to push mock funds into your test IBANs to trigger the Collections and Prefunding flows.

Note: This endpoint is strictly for the Sandbox environment.

How the Simulation Works

Because TransFi operates on a strict order-matching system, the behavior of your simulated deposit depends on the depositType you select:

1. Collections (depositType: "collections")

When you simulate a standard collection, the funds arrive in the IBAN but are treated as an unlinked deposit.

• The simulated amount is added to your Locked Balance.
• It does not automatically reconcile.
• To move these funds to your Unsettled Balance, you will need to map them to an order using the Sandbox Reconciliation API (covered in the next section).

2. Prefunding (depositType: "prefunding")

When you simulate prefunding (funding your own IBAN from a known external account), the system bypasses the locked state.

• The system automatically creates a matching prefunding order.
• The deposit auto-reconciles.
• The funds immediately appear in your Available Balance.

Make a Simulation Request

To simulate an incoming deposit, make a POST request to the /incoming-iban-deposits endpoint.

Request Example:

curl --location 'https://sandbox-api.transfi.com/v3/simulation/incoming-iban-deposits' \
--header 'MID: TSANYJ_TAIKGF_NA' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \
--data '{
    "ibanId": "IBANXNCA3N670I5ME0N",
    "amount": "20000",
    "depositType": "collections"
}'

Payload Parameters

For more technical details, you can reference the full API specification here: Simulate Incoming IBAN Deposits.