Skip to main content

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.

POST/api/withdrawals/fees_infoAuth: Required

This 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.

The fee is added on top, not taken out of the amount

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.

Quote the exact request, don't compute from rates

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_idstringRequired

The network the payout would go out on.

amountstring | numberRequired

The amount to be paid out. Accepted as a string or a number.

addressstringRequired

The destination address. It is part of the quote — screening cost can depend on the destination.

address_tagstring

Destination 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_fee

The whole fee for this payout — the flat and percentage withdrawal fees plus the AML component.

aml_fee

The AML screening part on its own. It is already included in total_fee — do not add the two together.

total_amount

What will be taken from the member's balance: amount + total_fee.

operation_type

How the payout would be settled: ON_CHAIN or OFF_CHAIN.

Errors

Beyond the shared errors:

CodeMeaning
1001dchain_id is not a known network, or no fee group is configured for your account or for this network
2029The fee could not be calculated