Simulations

Simulate an incoming deposit

Changed on

Initiates an incoming deposit through the sandbox provider pipeline. This endpoint is unavailable in live production.

post/v1/simulations/deposits

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/simulations/deposits
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

account_idstring uuid required

ID of the account to credit with the simulated deposit.

amountstring required

Amount as a decimal string in the account currency (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' | 'USDC' required

Currency of the simulated deposit.

unstructured_remittance_informationstring

Unstructured remittance information attached to the transfer. Not all rails support this field.

counterparty_idstring uuid

ID of an existing counterparty to use as the sender of the simulated deposit. Mutually exclusive with counterparty.

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'ach' | 'fedwire' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy'

Payment rail the simulated deposit arrives on.

Example request

{
  "amount": "100.50",
  "currency": "USD",
  "unstructured_remittance_information": "Invoice INV-2026-0042",
  "counterparty": {
    "financial_address": {
      "type": "aba",
      "routing_number": "110000000",
      "account_number": "000123456789",
      "account_holder_name": "Acme Sandbox Ltd.",
      "account_type": "checking"
    },
    "physical_address": {
      "line_1": "548 Market St",
      "line_2": "Apartment 4B",
      "city": "San Francisco",
      "postal_code": "94103",
      "state": "CA",
      "country_code": "DE"
    }
  }
}

Response

The deposit simulation acknowledgement

type'deposit_simulation' required

Resource type discriminator.

account_idstring uuid required

Account receiving the simulated deposit.

Changes