Skip to main content
GET
/
v1
/
deposits
/
{id}
JavaScript
import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

const deposit = await client.deposits.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(deposit.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "deposit",
  "status": "received",
  "amount": "<string>",
  "currency": "EUR",
  "source": {
    "type": "iban",
    "iban": "<string>",
    "account_holder_name": "<string>",
    "bic": "<string>"
  },
  "destination_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bank_statement_reference": "<string>",
  "rail": "sepa_instant",
  "tx_hash": "<string>",
  "returns": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

​
id
string<uuid>
required

Unique identifier of the deposit.

Response

200 - application/json

The deposit resource

​
id
string<uuid>
required

Unique identifier of the deposit.

​
type
enum<string>
required

Resource type discriminator.

Available options:
deposit
​
status
enum<string>
required

Current status of the deposit.

Available options:
received,
rejected,
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
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.

​
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.

Available options:
sepa_instant,
faster_payments,
sepa,
elixir,
express_elixir,
sek_account_to_account,
sumclearing,
straksclearing,
swift,
internal,
target,
eth,
eth_sepolia,
sol,
sol_devnet,
matic,
matic_amoy
​
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.

​
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the deposit was created.

​
updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the deposit was last updated.