Simulate inbound credit
Sandbox only. Creates a simulated inbound credit on the treasury account identified in the path — an external deposit that appears as a bank-reported line without running a payin or ingesting a BAI2 file.
Funds credit the treasury account (account_id in the path), or subaccount_id when you pass the UUID of one of its subaccounts.
Path
Request Body
Response
Returns a treasury-aligned subset of the created bank line:
Examples
- US/USD with ACH:
POST /accounts/{usd_account_id}/simulate-inbound-creditwith{ "rail": "standard_ach", "amount_in_minor_units": 4000 }→ $40.00 inbound ACH credit. - Backdated wire:
{ "rail": "wire", "amount_in_minor_units": 50000, "transaction_date": "2026-01-15" }→ credits with as-of date 2026-01-15. - US/USD with wire:
{ "rail": "wire", "amount_in_minor_units": 100000 }→ $1,000.00 inbound wire credit. - GB/GBP with wire:
{ "rail": "wire", "amount_in_minor_units": 80000 }→ £800.00 inbound wire credit on the GBP SIM account.
Error Responses
Authentication
RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.
Path parameters
Request
Payment rail for the simulated deposit. standard_ach requires a US/USD SIM treasury account; wire credits the account’s currency.
Amount in the smallest unit of the treasury account’s currency. For USD, this is cents (100 = $1.00).
Optional as-of calendar date for the simulated bank line (YYYY-MM-DD). Omit to use the current UTC date.
Optional label for the external sending party (shown on treasury inbound activity).
Attribute the inbound amount to this subaccount (UUID of a subaccount under the treasury account in the path). Omit to credit the main account itself.