Fees and Amounts

For further information on the types of fees in Nexus, see Fees.

Get maximum payment amount for a specified Country

Returns the maximum payment amount for a specified country, based on the countryCode and currencyCode provided. (Currency code is required because some countries use 2 currencies in parallel.)

GEThttp://localhost:3000/countries/{countryCode}/currencies/{currencyCode}/max-amounts

Path parameters

countryCode*string

2-letter country code of the requested country.

Example: "SG"

currencyCode*string

3-letter currency code.

Example: "SGD"

Response

200404

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/countries/{countryCode}/currencies/{currencyCode}/max-amounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

404

{
  "message": "text"
}

Get Fees and Interbank Settlement Amounts

Retrieves the various fees and amounts based on specified parameters. Information can be used in the pacs.008 payment instruction.

GEThttp://localhost:3000/fees-and-amounts/{sourceCurrency}/{destinationCurrency}/{amountCurrency}/{amount}/{exchangeRate}

Path parameters

sourceCurrency*string

The source currency code.

Example: "SGD"

destinationCurrency*string

The destination currency code.

Example: "MYR"

amountCurrency*string

The currency of the specified amount.

Example: "SGD"

amount*number

The amount in the specified amount currency. If the amount is defined in the Source Currency, this amount must be the amount AFTER the Source PSP has made any deduction. (This is the Interbank Settlement Amount that must be transferred to the FXP's account at the Source SAP). If the amount is defined in the Destination Currency, this must be the Creditor Agent Amount that will be credited to the recipient's account.

Example: 100

exchangeRate*number

The exchange rate from the source to destination currency.This information must be taken from (a) a quote provided by Nexus, or (b) the Source PSP's own exchange rate (when the Source PSP manages their own FX.).

Example: 3.5

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/fees-and-amounts/{sourceCurrency}/{destinationCurrency}/{amountCurrency}/{amount}/{exchangeRate}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

---

Get Nexus Scheme Fee Formula

Returns the Nexus Scheme Fee Formula (paid by the Source IPS to the Nexus Scheme) in a specified Source Currency, denominated in the Source Currency

GEThttp://localhost:3000/fee-formulas/nexus-scheme-fee/{countryCode}/{currencyCode}

Path parameters

countryCode*string

The country code of the SOURCE Country.

Example: "SG"

currencyCode*string

The 3-letter currency code

Example: "SGD"

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/fee-formulas/nexus-scheme-fee/{countryCode}/{currencyCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

---

Get Creditor Agent Fee Formula

Returns the Creditor Agent (Destination PSP) Fee FORMULA for a specified Destination Country, denominated in the Destination Currency.

GEThttp://localhost:3000/fee-formulas/creditor-agent-fee/{countryCode}/{currencyCode}

Path parameters

countryCode*string

The 2-letter country code of the DESTINATION Country.

Example: "MY"

currencyCode*string

The 3-letter currency code of the DESTINATION Country.

Example: "MYR"

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3000/fee-formulas/creditor-agent-fee/{countryCode}/{currencyCode}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();