Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

id
string<uuid>
required

Unique identifier of the deposit.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Response

200 - application/json

The deposit resource

id
string<uuid>
required

Unique identifier of the deposit.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
type
enum<string>
required

Resource type discriminator.

Available options:
deposit
status
enum<string>
required

Current status of the deposit.

Available options:
received,
in_return,
returned,
return_failed,
return_returned
amount
string
required

Amount as a string decimal (e.g. "100.50").

currency
enum<string>
required

Supported fiat or crypto currency code for the deposit amount.

Available options:
EUR,
GBP,
USD,
USDC
source
IBAN · object
required

Counterparty bank account or crypto wallet that sent the funds.

destination_account_id
string<uuid>
required

ID of the merchant account that received the deposit.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
bank_statement_reference
string | null
required

Reference visible on the bank statement, or null when not applicable.

rail
enum<string> | null
required

Payment rail or blockchain used for the deposit, or null when unknown.

Available options:
sepa_instant,
faster_payments,
sepa,
elixir,
express_elixir,
sek_account_to_account,
sumclearing,
straksclearing,
swift,
internal,
target,
ach,
fedwire,
btc,
btc_testnet4,
eth,
eth_sepolia,
sol,
sol_devnet,
matic,
matic_amoy,
null
tx_hash
string | null
required

Transaction hash for crypto deposits, or null when not known.

returns
string<uuid>[]
required

Array of deposit return IDs associated with this deposit.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the deposit was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the deposit was last updated.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$