Skip to main content
GET
Get a deposit

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL, with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed.

Path Parameters

depositId
string
required

The deposit's id.

Pattern: ^[1-9]\d{0,18}$

Response

The deposit.

id
string
required

The deposit's id. The data.id of its investor.deposit.processed webhook.

Example:

"99001"

tokenId
string
required

The token the cash is for.

Example:

"d1dbb6b6-3bda-48f2-b86e-c87610db1ae1"

tokenIssuanceId
string | null
required

The token issuance this deposit funded. null until tokens are issued for it. The same value is on the issuance in GET /transactions and is the data.id of investor.minting.completed.

Example:

"3697998"

currencyId
integer
required

The cash currency. 1 is the US dollar.

Example:

1

amount
string
required

The cash amount, in the minor units of currencyId.

Pattern: ^[0-9]+$
Example:

"500000000"

decimals
integer
required

The currency's decimals; they interpret amount. 2 for the US dollar.

Example:

2

direction
enum<string>
required

deposit: cash you sent, received for a subscription. liquidation: cash of yours applied to a token issuance; recorded when the tokens are issued, for the amount the tokens cost. withdraw: cash returned at your request. refund: cash returned by Securitize, for example the unused part of a deposit.

Available options:
deposit,
withdraw,
liquidation,
refund
uetr
string | null
required

The bank transfer's Unique End-to-end Transaction Reference, when the cash moved by wire.

Example:

"f3a1b2c3-6d4e-4f5a-9b8c-1d2e3f4a5b6c"

date
string<date-time> | null
required

When the cash movement took place.