Skip to content

POST Prepare Withdrawal endpoint.

Endpoint

POST/web/v1/partner/withdrawals/prepare WEB

Authentication

  • Chain: WEB
  • JWT Token: true
  • API Key: false
  • Permissions: ["withdrawal:create"]
  • Secure Channel: REQUIRED

Rate Limit

120 requests per 60 seconds.

Headers

Frontend Headers

HeaderRequiredDescription
X-LOCALEYes用户的 locale
Accept-LanguageNo语言偏好

Cloudflare Headers

HeaderRequiredDescription
CF-Connecting-IPYesClient IP from Cloudflare
CF-IPCountryYesClient country code
CF-RayYesCloudflare Ray ID
CF-VisitorYesVisitor scheme
X-Real-IPYesReal client IP

Nginx Headers

HeaderRequiredDescription
X-PORTAL-ACCESS-CODEYesPortal access code
X-Real-IPYes客户端真实 IP
X-Forwarded-ForYes代理链
X-Forwarded-ProtoYes协议

Request Parameters

Body (JSON)

FieldTypeRequiredDescription
channelBizIdStringYesWithdrawal channel business ID
amountBigDecimalYesWithdrawal amount (max 18.8 digits)
remarkStringNoRemark
bizParamsMap<String, Object>NoBusiness params
idempotentKeyStringYesIdempotency key

Response

200 OK

FieldTypeDescription
bizIdStringWithdrawal order business ID
workspaceBizIdStringWorkspace business ID
channelBizIdStringChannel business ID
currencyCodeStringCurrency code
amountBigDecimalWithdrawal amount
userFeeAmountBigDecimalUser fee amount
channelFeeAmountBigDecimalChannel fee amount
walletDebitAmountBigDecimalWallet debit amount
statusintOrder status
approvalStatusintApproval status
approvedByStringApproved by
approvedAtInstantApproval time
rejectionReasonStringRejection reason
createdAtInstantCreation time
completedAtInstantCompletion time

Phase 3 Simulation

SlaunchX Internal Documentation