Withdrawal Fees
Quotes what a payout will cost before you create it. Takes the same network, amount and destination as the payout itself, and returns the fee and the resulting total.
/api/withdrawals/fees_infoAuth: RequiredThis is the correct way to show a customer a fee. List Assets gives the merchant's rates per network; this endpoint applies them to one specific amount and destination and returns the figures for that payout.
Answers 201. Nothing is created — this endpoint only calculates.
amount is what the destination receives. The member's balance is debited
amount + total_fee.
That has one consequence worth building for deliberately: wherever there is a fee,
a "withdraw everything" button cannot send the full balance — asking for exactly the
balance leaves nothing to cover the fee. Quote first, then send
balance − total_fee.
The quote is calculated for the network, the amount and the destination you pass in, and it is the only figure that accounts for all three. List Assets gives per-network rates, so a number computed from those alone is an estimate, not the amount that will be charged.
operation_type in the answer tells you how the payout would be settled —
ON_CHAIN or OFF_CHAIN.
Request Body
dchain_idstringRequiredThe network the payout would go out on.
amountstring | numberRequiredThe amount to be paid out. Accepted as a string or a number.
addressstringRequiredThe destination address. It is part of the quote — screening cost can depend on the destination.
address_tagstringDestination memo, for networks that use one.
Response
201, carrying the quote. All four values come back as strings, except
operation_type, which is one of two keywords:
total_feeThe whole fee for this payout — the flat and percentage withdrawal fees plus the AML component.
aml_feeThe AML screening part on its own. It is already included in total_fee —
do not add the two together.
total_amountWhat will be taken from the member's balance: amount + total_fee.
operation_typeHow the payout would be settled: ON_CHAIN or OFF_CHAIN.
Errors
Beyond the shared errors:
| Code | Meaning |
|---|---|
1001 | dchain_id is not a known network, or no fee group is configured for your account or for this network |
2029 | The fee could not be calculated |