Token Management
Client Management
Reference
Models
Powered by Stoplight
get

/me/send-money/preview

Return the total fee, which the sender will be charged at send money with the requested amount, the amount converted in customer’s currency and the fxRate to be applied.

Authorization

oauth2 - authorizationCode

Request Parameters

4 Query Parameters
1 Header

Responses

Return the total fee, which the sender will be charged at send money with the requested amount, the amount converted in customer’s currency and the fxRate to be applied.

Example response:

{
    "feeAmount": 1.67,
    "feeCurrency": "USD",
    "customerAmount": 167.365322,
    "displayCustomerAmount": 167.37,
    "customerCurrency": "USD",
    "maxAmountInTransactionCurrency": 0,
    "displayMaxAmountInTransactionCurrency": 0,
    "maxAmountInCustomerCurrency": 0,
    "displayMaxAmountInCustomerCurrency": 0,
    "fxRate": 0.597496,
    "displayFxRate": 0.60
}

In this example, fxRate denotes that 1 USD = 0.60 GBP.

1 Example
Schema
object
accountId
integer
1 validation
bruttoCustomerAmount
number

Sender amount of the remittance, with fees included

1 validation
bruttoCustomerCurrencyLimit
number
1 validation
customerAmount
number
1 validation
customerCurrency
string
customerCurrencyLimit
number
1 validation
displayBruttoCustomerAmount
number

Sender amount of the remittance, with fees included, rounded to maximum decimal places for sender currency

1 validation
displayBruttoCustomerCurrencyLimit
number
1 validation
displayBruttoPaymentAmount
number
1 validation
displayBruttoPaymentCurrencyLimit
number
1 validation
displayCustomerAmount
number
1 validation
displayCustomerCurrencyLimit
number
1 validation
displayFxRate
number
1 validation
displayMaxAmountInCustomerCurrency
number
1 validation
displayMaxAmountInTransactionCurrency
number
1 validation
displayMaxBruttoAmountInCustomerCurrency
number

Maximum amount to be sent with total fee amount included, rounded to max decimal places for sender currency

1 validation
displayPaymentAmount
number
1 validation
displayPaymentFeeAmount
number
1 validation
displayPaymentFxRate
number
1 validation
displayTotalFeeAmount
number
1 validation
displayTotalPaymentFeeAmount
number
1 validation
displayTransactionCurrencyLimit
number
1 validation
feeAmount
number
1 validation
feeCurrency
string
firstTransactionFeeApplied
boolean

Flags if the first send money will be charged with “first transaction with no qualified deposit” fee. This fee can drop if the customer has already sent money or successfully deposits.

fxRate
number
1 validation
isMerchant
boolean
isRecipientEligibleToReceive
boolean

Flag if the user is eligible to receive money - locked user or some other restrictions

isRecipientUnregistered
boolean
maxAmountInCustomerCurrency
number
1 validation
maxAmountInTransactionCurrency
number
1 validation
maxBruttoAmountInCustomerCurrency
number

Maximum amount to be sent with total fee amount included

1 validation
noQualifiedDepositFeeApplied
boolean

Flags if the send money will be charged with “no qualified deposit” fee. This fee can drop if the customer successfully deposits.

paymentAmount
number
1 validation
paymentCurrency
string
paymentFxRate
number
1 validation
processingAmount
number
1 validation
processingCurrency
string
stamp
string

A stamp to specify when creating the actual upload, so the amounts given in this preview are the same for the upload, as FX rates may have changed in the meantime.

totalFeeAmount
number
1 validation
transactionCurrencyLimit
number
1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token