Deposit
Deposit models describe incoming funds received by merchant wallets and their related payment rail details.
Deposit
| Field | Type | Description |
|---|---|---|
id | string | Deposit ID. |
wallet | DepositWallet | Wallet that received the deposit. |
transaction | DepositTransaction | Payment rail transaction details. |
source | DepositSource | Observed external payment source. |
status | DepositStatus | Current deposit status. |
currencyCode | CurrencyCode | Currency code for the deposit amount. |
amount | NumericString | Original deposit amount. |
amountFee | NumericString | Fee charged for the deposit. |
amountNet | NumericString | Net amount credited after fees. |
finalizedAt | IsoDateTimeUtc or null | Time when the deposit reached a final status. null if not finalized yet. |
createdAt | IsoDateTimeUtc | Time when the deposit record was created. |
updatedAt | IsoDateTimeUtc | Time when the deposit record was last updated. |
DepositWallet
| Field | Type | Description |
|---|---|---|
id | string | Wallet ID. |
type | string | Wallet type, such as merchant_wallet. |
DepositTransaction
| Field | Type | Description |
|---|---|---|
type | blockchain or bank | Payment rail type. |
provider | string | Transaction provider, such as tron, solana, swift, or stripe. |
blockchain | BlockchainTransactionDetail or null | Blockchain-specific transaction details. |
bank | null | Bank-specific transaction details. This is always null in the current version. |
legs | DepositLeg[] | Asset movement details for this transaction. |
BlockchainTransactionDetail
| Field | Type | Description |
|---|---|---|
chainId | string | Blockchain chain identifier, such as tron:nile. |
hash | string | Blockchain transaction hash. |
fromAddress | string | Source blockchain address. |
toAddress | string | Destination blockchain address. |
DepositLeg
| Field | Type | Description |
|---|---|---|
type | principal or network_fee | Asset movement type. |
currencyCode | CurrencyCode | Currency code for this leg. |
amount | NumericString | Amount for this leg. |
DepositSource
The source object identifies where the deposit came from.
| Field | Type | Description |
|---|---|---|
type | string | Source type, such as crypto or bank. |
rail | string | Source rail, such as tron or solana. |
identifier | string | Source identifier, such as a blockchain address or bank account reference. |
DepositStatus
| Value | Description |
|---|---|
preparing | Deposit record has been created and is waiting for initial handling. |
reviewing | Deposit is undergoing routine validation before processing. |
processing | Deposit is being processed by the system. |
processed | Internal processing has completed, and the deposit is waiting for final network or compliance resolution. |
completed | Deposit has completed, and the credited funds are available. |
under_review | Deposit is held for compliance or risk review. The underlying review reason is not disclosed. |
blocked | Deposit was blocked following a compliance or risk decision, and the associated funds remain unavailable. |