Withdrawal Intent
Withdrawal intent models describe withdrawal requests and their related payment rail details.
WithdrawalIntent
| Field | Type | Description |
|---|---|---|
id | string | Withdrawal intent ID. |
wallet | WithdrawalWallet | Source wallet used for the withdrawal. |
transaction | WithdrawalTransaction or null | Payment rail transaction details. null when no transaction has been created yet. |
destination | WithdrawalDestination | Withdrawal destination selected by the merchant. |
status | WithdrawalIntentStatus | Current withdrawal intent status. |
serviceFeeMode | inclusive or exclusive | Determines whether the service fee is included in or added on top of amount. |
amount | NumericString | Original withdrawal amount. |
amountFee | NumericString | Fee charged for the withdrawal. |
amountNet | NumericString | Amount the recipient will receive. |
amountGross | NumericString | Gross withdrawal amount, equal to amountNet + amountFee. |
submittedAt | IsoDateTimeUtc | Time when the withdrawal intent was submitted. |
finalizedAt | IsoDateTimeUtc or null | Time when the withdrawal intent reached a final status. null if not finalized yet. |
createdAt | IsoDateTimeUtc | Time when the withdrawal intent record was created. |
updatedAt | IsoDateTimeUtc | Time when the withdrawal intent record was last updated. |
WithdrawalWallet
| Field | Type | Description |
|---|---|---|
id | string | Wallet ID. |
type | string | Wallet type, such as merchant_wallet. |
WithdrawalTransaction
| Field | Type | Description |
|---|---|---|
type | string | Transaction type, such as blockchain. |
provider | string | Transaction provider, such as tron. |
blockchain | BlockchainTransactionDetail or null | Blockchain-specific transaction details. |
legs | WithdrawalLeg[] | 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. |
WithdrawalLeg
| Field | Type | Description |
|---|---|---|
type | principal or network_fee | Asset movement type. |
currencyCode | CurrencyCode | Currency code for this leg. |
amount | NumericString | Amount for this leg. |
WithdrawalDestination
The destination object identifies where the withdrawal is sent.
| Field | Type | Description |
|---|---|---|
type | string | Destination type, such as crypto or bank. |
rail | string | Destination rail, such as tron or swift. |
routingCode | string | Routing identifier, such as a chain ID or bank routing code. |
identifier | string | Destination identifier, such as a blockchain address or bank account reference. |
WithdrawalIntentStatus
| Value | Description |
|---|---|
preparing | Withdrawal intent has been submitted and is still in its preparation or cancellation period. |
reviewing | Withdrawal intent is waiting for business review. |
processing | Withdrawal intent is waiting for operational or financial processing. |
processed | Internal approval and processing have completed, and the withdrawal is waiting for its final network outcome. |
completed | Withdrawal has completed, and the requested amount has been sent to the destination. |
failed | Withdrawal could not be completed because it was declined, rejected, or network processing failed. |
cancelled | Withdrawal intent was cancelled during the allowed cancellation period. |