Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
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.

Body

application/json

Incoming deposit simulation parameters

account_id
string<uuid>
required

ID of the account to credit with the simulated deposit.

amount
string
required

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

Pattern: ^(0|[1-9]\d*)(\.\d+)?$
currency
enum<string>
required

Currency of the simulated deposit.

Available options:
EUR,
GBP,
USD,
USDC
Example:

"EUR"

unstructured_remittance_information
string

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

Minimum string length: 1
counterparty
object

Sender of the simulated deposit.

rail
enum<string>

Payment rail the simulated deposit arrives on.

Available options:
sepa_instant,
sepa_credit_transfer,
t2,
ach,
fedwire,
faster_payments

Response

200 - application/json

The deposit simulation acknowledgement

type
enum<string>
required

Resource type discriminator.

Available options:
deposit_simulation
success
boolean
required

Whether the simulation submission was successful.

account_id
string<uuid>
required

Account receiving the simulated deposit.

amount
string
required

Simulated amount as a decimal string.

currency
enum<string>
required

Currency of the receiving account.

Available options:
EUR,
GBP,
USD,
USDC
Example:

"EUR"

unstructured_remittance_information
string | null
required

ISO 20022 unstructured remittance information (/), or null when omitted.

rail
enum<string> | null
required

Payment rail used for the simulated deposit.

Available options:
sepa_instant,
sepa_credit_transfer,
t2,
ach,
fedwire,
faster_payments,
null