Fiat Withdraw Apply
/payout/v1/fiat-withdraw/apply
Create a fiat withdraw order (idempotency key: mchOrderId). Quote first to obtain quoteId.
Request
Header Parameters
content-type
string
REQUIRED
Fixed value: application/json
x-api-key
string
REQUIRED
Provided by Paydify, same as appId
x-api-timestamp
string
REQUIRED
Timestamp in milliseconds
x-api-signature
string
REQUIRED
Signature, see the signature algorithm
Body
mchOrderId
string
REQUIRED
Merchant order id (idempotency key)
quoteId
string
REQUIRED
Quote session id
merchantId
string
Merchant ID of the withdrawal owner (sub-merchant). Required when calling with a partner credential on behalf of a sub-merchant; can be omitted with a merchant-owned credential (defaults to the credential owner). Max 64 characters
merchantAppId
string
App ID under the owner merchant, used for disambiguation when the owner merchant has multiple authorized apps. Required if the credential covers multiple apps of the owner merchant; can be omitted when only one app is authorized (resolved automatically). Max 64 characters
Response
Body
code
string
Response code, SYS_SUCCESS indicates success
message
string
Response message
messageDetail
string
Detailed response message
success
boolean
Whether the request was successful
data
object
withdrawOrderId
string
Withdraw order id
mchOrderId
string
Merchant order id
quoteId
string
Quote session id
status
string
Status (typically PENDING)
arrivalAmount
string
Arrival amount
arrivalCurrency
string
Arrival currency (ISO 4217)
feeAmountFiat
string
Fee amount (fiat)
chargeAmountFiat
string
Total charge amount (fiat)
deductionSnapshot
object
deductionPlan
object[]
assetCode
string
Deduction asset code (e.g. USDC/USDT)
currency
string
Legacy field name, same as assetCode
deductAmount
string
Actual deduction amount for this asset
principalAmount
string
Principal amount covered by this asset
feeAmount
string
Fee amount allocated to this asset
sequence
integer
Deduction priority (lower = higher priority)
bankAccountInfo
object
bankAccountId
string
Bank account ID
beneficiaryBankBic
string
Beneficiary bank BIC/SWIFT code
supportedCurrencies
string[]
Supported fiat currencies (ISO 4217)
beneficiaryAccountNumber
string
Masked beneficiary bank account number
beneficiaryAccountNumberPlain
string
Plain account number; null when unavailable or restricted
correspondentBankBic
string
Correspondent / intermediary bank BIC/SWIFT
beneficiaryAddress
string
Beneficiary address
beneficiaryBankAddress
string
Beneficiary bank address
beneficiaryAccountName
string
Beneficiary account name
beneficiaryBankName
string
Beneficiary bank name
beneficiaryCountry
string
Beneficiary country
lockedRateSnapshot
string
Locked rate snapshot (JSON string)
rateSnapshot
object[]
fromCurrency
string
Source currency
toCurrency
string
Target currency
rate
string
Exchange rate (1 fromCurrency = rate toCurrency)
createdAt
string
Created time (ISO 8601); may be null before persistence completes
1
RESPONSE
Click the Send API Request button above and see the response here!