Skip to main content
GET
Get a deposit

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Path Parameters

id
string
required
Example:

"deposit_9hr9t3wfre5ebpk2"

Response

The deposit.

id
string
required
Example:

"deposit_9hr9t3wfre5ebpk2"

wallet_id
string
required

The wallet that was credited.

Example:

"wallet_7t4m9k2qx8d3hn5r"

amount
string
required

A decimal string with at most the currency's decimals.

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"500.00"

currency
string
required
Example:

"usd"

rail
enum<string> | null
required

How it arrived. null for a manual credit, including sandbox test deposits.

Available options:
ach,
wire,
swift,
sepa,
faster_payments,
spei,
null
Example:

"wire"

description
string | null
required
Example:

"Top-up October"

created_at
string<date-time>
required

When it was credited.

Example:

"2026-10-23T09:00:00Z"