Fees and Amounts

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

Get maximum payment amount for a specified Country

get

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.)

Path parameters

countryCodestringRequired

2-letter country code of the requested country.

Example: SG

currencyCodestringRequired

3-letter currency code.

Example: SGD

Responses

200

Successful response

application/json

404

Country not found

application/json

get

/countries/{countryCode}/currencies/{currencyCode}/max-amounts

HTTPcURLJavaScriptPython

GET /countries/{countryCode}/currencies/{currencyCode}/max-amounts HTTP/1.1
Host: localhost:3000
Accept: */*

[
  {
    "clearingSystemId": "SGDFAST",
    "maxAmount": "200000"
  }
]

Get Fees and Interbank Settlement Amounts

get

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

Path parameters

sourceCountrystringRequired

2-letter country code of the SOURCE country.

Example: SG

sourceCurrencystringRequired

The source currency code.

Example: SGD

destinationCountrystringRequired

2-letter country code of the DESTINATION country.

Example: MY

destinationCurrencystringRequired

The destination currency code.

Example: MYR

amountCurrencystringRequired

The currency of the specified amount.

Example: SGD

amountnumberRequired

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

exchangeRatenumberRequired

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

Responses

200

Successful response

application/json

get

/fees-and-amounts/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}/{exchangeRate}

HTTPcURLJavaScriptPython

GET /fees-and-amounts/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}/{exchangeRate} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Successful response

{
  "debtorAgent": {
    "interbankSettlementAmount": {
      "amount": 100,
      "currency": "SGD"
    },
    "nexusSchemeFee": {
      "amount": 0.5,
      "currency": "SGD"
    }
  },
  "creditorAgent": {
    "interbankSettlementAmount": {
      "amount": 350,
      "currency": "MYR"
    },
    "chargesAmount": {
      "amount": 2.24,
      "currency": "MYR"
    },
    "creditorAccountAmount": 347.76
  }
}

---

Get Nexus Scheme Fee Formula

get

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

Path parameters

countryCodestringRequired

The country code of the SOURCE Country.

Example: SG

currencyCodestringRequired

The 3-letter currency code

Example: SGD

Responses

200

Successful response

application/json

get

/fee-formulas/nexus-scheme-fee/{countryCode}/{currencyCode}

HTTPcURLJavaScriptPython

GET /fee-formulas/nexus-scheme-fee/{countryCode}/{currencyCode} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Successful response

{
  "countryCode": "SG",
  "currency": "SGD",
  "nominalFeeAmount": "0.50",
  "percentageFeeAsRatio": 0.001
}

---

Get Creditor Agent Fee Formula

get

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

Path parameters

countryCodestringRequired

The 2-letter country code of the DESTINATION Country.

Example: MY

currencyCodestringRequired

The 3-letter currency code of the DESTINATION Country.

Example: MYR

Responses

200

Successful response

application/json

get

/fee-formulas/creditor-agent-fee/{countryCode}/{currencyCode}

HTTPcURLJavaScriptPython

GET /fee-formulas/creditor-agent-fee/{countryCode}/{currencyCode} HTTP/1.1
Host: localhost:3000
Accept: */*

200

Successful response

{
  "countryCode": "MY",
  "nominalFee": {
    "amount": "2.22",
    "currency": "MYR"
  },
  "percentageFee": 0.1
}