Skip to main content
GET
/
api
/
payouts
/
quote
Get a quote
curl --request GET \
  --url https://business.madhousewallet.com/api/payouts/quote \
  --header 'Authorization: Bearer <token>'
{
  "quoteId": "281901c4-19c6-462f-9c81-37fc6bbde340",
  "sourceAmount": 1000,
  "providerCharge": 2,
  "serviceFeePercent": 1.5,
  "targetCurrency": "EUR",
  "usdToTargetRate": 0.9183,
  "quote": {
    "targetAmount": 915.28,
    "transferFee": 0.58,
    "feeFxPercent": 0,
    "feeFxAmount": 0,
    "feePayoutAmount": 0.58,
    "estimatedDelivery": "2026-03-26T15:52:37Z"
  }
}

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token: Authorization: Bearer mw_live_<keyId>_<secret>

Query Parameters

targetCurrency
string
required

ISO 4217 target currency code. Supported currencies (81): AED, ALL, ARS, AUD, BAM, BDT, BHD, BMD, BOB, BRL, BWP, CAD, CHF, CLP, CNY, COP, CRC, CVE, CZK, DKK, DOP, EGP, EUR, GBP, GEL, GHS, GMD, GNF, GTQ, HKD, HNL, HUF, IDR, ILS, INR, ISK, JPY, KES, KGS, KHR, KRW, KWD, LAK, LKR, MAD, MNT, MOP, MUR, MXN, MYR, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PEN, PHP, PKR, PLN, PYG, QAR, RON, RSD, RWF, SAR, SCR, SEK, SGD, SRD, THB, TND, TRY, TZS, UAH, UGX, USD, UYU, VND, ZAR.

sourceAmount
number
required

USD amount to convert

Required range: 0.01 <= x <= 1000000
v2_offloader
enum<string>

Pass true to receive fee fields calculated for the v2 transfer pipeline (POST /api/payouts/transfer/v2). When set, serviceFeePercent reflects your configured fee + 20 bips, serviceFeeFixed is 0, and providerCharge is absent. Ignored for non-API-key callers.

Available options:
true

Response

Quote generated successfully

serviceFeePercent
number
required

Combined platform service fee displayed as a percentage (e.g. 0.6 means 0.6%). 0 when not configured.

Example:

0.6

serviceFeeFixed
number | null
required

Fixed fee in USD (display only). Always 0 for v2-offloader accounts. Absent when not applicable.

Example:

0

targetCurrency
string
required

ISO 4217 currency code of the payout destination (uppercased).

Example:

"EUR"

usdToTargetRate
number
required

Exchange rate from 1 USD to the target currency.

Example:

0.9183

quote
object
required

Settlement layer quote details — fees and estimated delivery.

quoteId
string
required

UUID identifying this quote — pass to POST /api/payouts/transfer or POST /api/payouts/transfer/v2 as quote_id (API key callers only; absent for JWT callers). Valid for 5 minutes, single-use.

Example:

"3f7a2b1c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"

sourceAmount
number
required

Original USD input amount (before any fee deductions).

Example:

1000

providerCharge
number

Provider processing fee in USD deducted from the source amount before conversion. Present only for v1 accounts; absent for v2-offloader accounts.

Example:

2