Skip to main content
GET
Get user fees

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

userId
string<uuid>
required

The unique identifier for the user

Example:

"c06f3427-3bbe-4d70-9a54-28acda267e48"

Query Parameters

sourceCurrency
string

ISO 4217 currency in which all fees are quoted. Defaults to USD.

Example:

"USD"

paymentMethod
enum<string>

Payment method to produce an estimate for. Presence of this field triggers the estimate block in the response and requires destinationCurrency.

Available options:
bank,
momo,
swift,
ach,
wire,
crypto,
card,
wallet
Example:

"bank"

destinationCurrency
string

ISO 4217 payout currency — keys the specific corridor for the estimate. Required whenever paymentMethod, destinationCountry, or sourceAmount is supplied.

Example:

"AUD"

destinationCountry
string

ISO 3166-1 alpha-2 destination country code. Use this when several countries share a currency (e.g. USD sent to Ecuador vs. USD sent to El Salvador) so the estimate resolves to the right country. Only meaningful when destinationCurrency is also supplied.

Example:

"AU"

sourceAmount
string

Decimal payout amount used to resolve percentage-based fees into a concrete estimate.fee.value. Ignored for fixed-fee corridors. Requires destinationCurrency.

Example:

"100"

Response

Payout catalog and (optional) corridor estimate

data
object