get https://prod.api.getborderless.com/quote/fee
Introduction
This endpoint allows you to retrieve minimum amounts, minimum fees, maximum fees and calculated fees fot the payment.
NOTE: Values calculated using this endpoint are aproximate.
Data Requirements
Provide the following data requirements when sending a GET request to the Fees endpoint.
The request should contain the following query parameter:
Parameter | Required? | Description | Type |
---|---|---|---|
payerCurrency | Yes | This field is the three letter currency code identifying the currency of the payer. E.G. USD for United States. | String |
beneCurrency | Yes | This field is the three letter currency code identifying the currency of the beneficiary. E.G. EUR for Lithuania. | String |
beneCountry | Yes | This field is the two letter country code identifying the country of the beneficiary. E.G. LT for Lithuania. | String |
beneAccountType | Yes | This field is the account type of the beneficiary. Possible values are BUSINESS | PERSONAL. | String |
amount | No | Desired amount of the payment. Fees in the response will be calculated according to the provided amount. | Number |
feesPaidBy | No | This field defines who is gonna be bearing the fee of the payment. Possible values are PAYER | BENE. Default value is PAYER. | String |
Response Body
The response will contain the following information:
Parameter | Description | Type |
---|---|---|
amount | Desired amount of the payment. | Number |
payerCurrency | This field is the three letter currency code identifying the currency of the payer. E.G. USD for United States. | String |
beneCurrency | This field is the three letter currency code identifying the currency of the beneficiary. E.G. EUR for Lithuania. | String |
beneCountry | This field is the two letter country code identifying the country of the beneficiary. E.G. LT for Lithuania. | String |
minAmountInBeneCurrency | This field defines the minimum payment amount in beneficiary currency. | Number |
minAmountInPayerCurrency | This field defines the minimum payment amount to the beneficiary in payer currency. | Number |
minFeeInBeneCurrency | This field defines the minimum fee of the payment converted to beneficiary currency. | Number |
minFeeInPayerCurrency | This field defines the minimum fee of the payment in payer’s currency. | Number |
maxFeeInBeneCurrency | This field defines the maximum fee of the payment converted to beneficiary currency. | Number |
maxFeeInPayerCurrency | This field defines the maximum fee of the payment in payer’s currency. | Number |
rate | This field defines the exchange rate from payer’s currency to beneficiary’s. | Number |
invertedRate | This field defines the exchange rate from beneficiary’s currency to payer’s. | Number |
feesPaidBy | This field defines who is gonna be bearing the fee of the payment. Default value is PAYER. | String |
fee | This field defines an approximate calculated fee to be paid. Note: Fee will be calculated only when the amount is specified in query params. Otherwise this field will be null. | Number |
feeCurrency | This field reflects the currency of who pays the fees. Default value is payer's currency. | String |