Fiat Withdraw Quote
/payout/v1/fiat-withdraw/quote
Quote preview (no side effects). Returns quote session and deduction plan based on arrival amount/currency or deduction asset/amount.
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
quoteMode
string
REQUIRED
Quote mode: ARRIVAL / DEDUCT_ASSET
bankAccountId
string
REQUIRED
Target bank account id
arrivalCurrency
string
REQUIRED
Arrival fiat currency (ISO 4217, e.g. USD/EUR/HKD), see Supported fiat currencies
arrivalAmount
string
ARRIVAL mode: arrival amount
assetCode
string
Mode DEDUCT_ASSET: asset code to deduct (e.g. USDC/USDT), see Supported Chains and Currencies
deductAmount
string
DEDUCT_ASSET mode: deduction amount
merchantId
string
Merchant ID the quote belongs to (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).
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).
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
quoteId
string
Quote session id
quoteMode
string
Quote mode
expireAt
string
Quote expiry time (ISO 8601)
bankAccountId
string
Target bank account id
bankAccountInfo
object
bankAccountId
string
Bank account id
beneficiaryBankBic
string
Beneficiary bank BIC/SWIFT
supportedCurrencies
string[]
Supported fiat currencies (ISO 4217)
beneficiaryAccountNumber
string
Masked beneficiary account number
beneficiaryAccountNumberPlain
string
Plain beneficiary 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
arrivalAmount
string
Arrival amount (fiat)
arrivalCurrency
string
Arrival fiat currency (ISO 4217, e.g. USD/EUR/HKD), see Supported fiat currencies
feeAmountFiat
string
Fee amount (fiat)
chargeAmountFiat
string
Total charge amount (fiat)
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
deductionPlan
object[]
assetCode
string
Mode DEDUCT_ASSET: asset code to deduct (e.g. USDC/USDT), see Supported Chains and Currencies
currency
string
Legacy field; same as assetCode
deductAmount
string
Amount deducted for this asset
principalAmount
string
Principal portion covered by this asset
feeAmount
string
Fee portion allocated to this asset
sequence
integer
Deduction priority (lower = higher priority)
1
RESPONSE
Click the Send API Request button above and see the response here!