Skip to main content
POST
Create a withdrawal/off-ramp order that debits a partner fund balance and locks in a confirmed quote (rate, outcome, fees). No VND is sent yet — the order stays in a pending-confirmation state for up to 15 minutes, after which it expires. To actually pay out VND, call Confirm Withdrawal with the returned order.id before the order expires. Use idempotency_key to ensure the order is not created twice.

Authentication

string
required
Your partner app key.
string
required
Base64-encoded Ed25519 signature of the sign data.
string
required
Unix timestamp (seconds) of the request. Must be within 60 seconds of server time.

Body Parameters

string
required
Amount to withdraw.
string
required
Currency of the amount. Available values: vnd, token.
string
required
Token symbol for the withdrawal (e.g., USDT, USDC, USD1).
object
required
Bank payment information for the withdrawal recipient.
string
required
Callback URL for receiving withdrawal status updates.
string
Optional. Use this to map the Holdstation Pay order to your internal order. Must be unique per partner.
string
required
Idempotency key to ensure the withdrawal is not processed twice.
string
Partner customer KYC id. Required when the partner_kyc feature flag is enabled for your account — the order is rejected if this is missing or does not match a registered KYC record. See Partner Customer KYC.