Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-044359269.1 KB
Deposits

Retrieve deposit

Retrieves a deposit by ID.

get/v1/deposits/{id}

Path parameters

idstring uuid required

Unique identifier of the deposit.

Response

The deposit resource

idstring uuid required

Unique identifier of the deposit.

type'deposit' required

Resource type discriminator.

status'received' | 'in_return' | 'returned' | 'return_failed' | 'return_returned' required

Current status of the deposit.

amountstring required

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

currency'EUR' | 'GBP' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL' required

Supported fiat or crypto currency code for the deposit amount.

destination_account_idstring uuid required

ID of the merchant account that received the deposit.

bank_statement_referencestring nullable required

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

rail'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' nullable required

Payment rail or blockchain used for the deposit.

tx_hashstring nullable required

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

returnsstring[] required

Array of deposit return IDs associated with this deposit.

created_atstring date-time required

ISO 8601 UTC timestamp when the deposit was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the deposit was last updated.