Simulate a fiat deposit
Simulates a bank transfer credited to the project’s master collateral account. The deposit is recorded as already settled, the master balance is credited, and FIAT_DEPOSIT_CREATED is delivered, matching what a reconciled transfer does in production. Only available to Program-Funded projects, which are the ones that have a master collateral account. Pass originalAmount and originalCurrency together to simulate a transfer that was converted on the way in.
Authorizations
API key as Bearer token
Headers
API version (YYYY-MM-DD)
2025-02-14 "2025-02-14"
Body
Simulate a bank transfer credited to the project's master collateral account
Amount credited to the master account, in the project's billing currency
100.5
0
1234.99
Amount the sending bank transferred, when the transfer was converted on the way in. Must be provided together with originalCurrency. Defaults to amount.
Currency the transfer was sent in as an ISO 4217 alpha code (e.g. EUR). Must be provided together with originalAmount. Defaults to the project's billing currency.
^[A-Z]{3}$Name of the sender. Randomly generated if omitted.
1 - 255"MOON INC LIMITED"
Reference the sender attached to the transfer. Absent if omitted.
1 - 255"INV-2024-0142"
Response
Response for status 200
Unique fiat deposit identifier
Account credited by the deposit
The bank's unique identifier for the incoming transfer. Use it to reconcile the deposit against a bank statement.
"20240115HKHHXXXX000123456"
Current deposit status
SETTLED "SETTLED"
Amount credited to the account balance
x >= 0100.5
0
1234.99
Currency the credit was applied in
"USD"
"HKD"
"EUR"
Amount of the incoming transfer, as received by the bank
x >= 0100.5
0
1234.99
Currency the transfer was sent in. Differs from currency when the transfer was converted on the way in; amount divided by originalAmount is the rate that was applied.
"USD"
"HKD"
"EUR"
Name of the sender, when the bank reported one
"MOON INC LIMITED"
Reference the sender attached to the transfer, when present
"INV-2024-0142"
ISO 8601 timestamp of when the bank received the transfer
"2024-01-15T10:30:00Z"
ISO 8601 timestamp of creation
"2024-01-15T10:30:00Z"
ISO 8601 timestamp of last update
"2024-01-15T10:35:00Z"