Fees and Amounts

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

Get Fees and Interbank Settlement Amounts

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

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

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sourceCountrystringRequired

The ISO 3166 alpha-2 country code

Example: SG

sourceCurrencystringRequired

The source currency code.

Example: SGD

destinationCountrystringRequired

The ISO 3166 alpha-2 country code

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

400

Invalid request. Applicable reason codes: TE001 INVALID_REQUEST, BE007 QUOTE_SAME_CURRENCY, BE010 FXP_NOT_REGISTERED, BE012 FXP_NO_SETTLEMENT_ACCOUNT.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

Not found. Applicable reason codes: BE009 QUOTE_CURRENCY_PAIR_NOT_CONFIGURED, BE011 FEE_FORMULA_NOT_FOUND.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

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

HTTPcURLJavaScriptPython

GET /v1/fees-and-amounts/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}/{exchangeRate} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get Creditor Agent Fee Formula

get

http://localhost:8080https://nexus-ai-simulator-683365449922.asia-southeast1.run.app

/v1/fee-formulas/destination-agent-fee/{countryCode}/{currencyCode}

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

400

Invalid country code. Reason code BE001 COUNTRY_CODE_INVALID.

application/json

401

Authentication failed. Applicable reason codes: AE001 AUTH_TOKEN_MISSING, AE002 AUTH_TOKEN_INVALID.

application/json

403

Authorization failed. The token is valid but its OAuth2 scopes do not grant access to this endpoint or corridor. Reason code AE004 ACCESS_DENIED.

application/json

404

Fee formula not found. Reason code BE011 FEE_FORMULA_NOT_FOUND.

application/json

429

Rate limit exceeded. Returned by the API gateway and carries no structured Nexus body. The Retry-After response header indicates when to retry.

500

An unhandled exception or infrastructure failure occurred. Reason code TE099 INTERNAL_ERROR. The caller may retry with exponential backoff.

application/json

get/v1/fee-formulas/destination-agent-fee/{countryCode}/{currencyCode}

HTTPcURLJavaScriptPython

GET /v1/fee-formulas/destination-agent-fee/{countryCode}/{currencyCode} HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countryCode": "MY",
  "nominalFee": {
    "amount": "2.22",
    "currency": "MYR"
  },
  "percentageFee": 0.1,
  "validTo": "2026-05-28T23:59:59+08:00"
}