Skip to main content
See Deposits.
​
id
string<uuid>
required

Unique identifier of the deposit.

Example:

"550e8400-e29b-41d4-a716-446655440004"

​
type
enum<string>
required

Resource type discriminator.

Available options:
deposit
​
status
enum<string>
required

Current status of the deposit.

Available options:
settled
Example:

"settled"

​
account_id
string<uuid>
required

ID of the account that was credited with the deposit.

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
amount
string
required

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

Example:

"100.50"

​
currency
enum<string>
required

Currency code (ISO 4217 or crypto).

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

"USD"

​
counterparty_id
string<uuid> | null
required

ID of the counterparty that sent the money, or null when not known.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
unstructured_remittance_information
string | null
required

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

Maximum string length: 140
Example:

"INV-2026-0042"

​
tracking_reference
object | null
required

Rail network tracking identifier with its type: UETR for SWIFT, IMAD for Fedwire, or the 15-digit trace number for ACH. Null when unavailable.

Example:
​
rail
enum<string> | null
required

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

Available options:
sepa,
sepa_instant,
faster_payments,
swift,
internal,
target,
ach,
fedwire,
bitcoin,
bitcoin_testnet4,
ethereum,
ethereum_sepolia,
solana,
solana_devnet,
polygon,
polygon_amoy,
null
Example:

"ach"

​
tx_hash
string | null
required

Transaction hash for crypto deposits, or null when not known. Only blockchain rails support this field.

Example:

null

​
returns
string<uuid>[]
required

Array of deposit return IDs associated with this deposit.

Example:
​
settled_at
string<date-time>
required

ISO 8601 UTC timestamp when the deposit was settled.

Example:

"2026-01-15T10:30:00Z"