Quotes

Get quotes for a specific currency pair and amount

Retrieves a list of quotes for currency exchange based on the specified country/currency pair and the amount (denominated in either the source currency or destination currency)

GEThttp://localhost:3000/quotes/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}

Path parameters

sourceCountry*string

2-letter country code for the Source Country

Example: "SG"

sourceCurrency*string

3-letter currency code for the Source Currency

Example: "SGD"

destinationCountry*string

2-letter country code for the Destination Country

Example: "TH"

destinationCurrency*string

3-letter currency code for the Destination Currency

Example: "THB"

amountCurrency*string

Source Currency if the Sender defined the amount to be sent. Destination Currency if the Sender defined the amount to be received by the Recipient.

Example: "SGD"

amount*number

The amount to be exchanged. If the Sender defined the amount to be sent in the source currency, the amount here must be the amount set by the Sender MINUS any Source PSP Deducted Fee. If the Sender defined the amount for the Recipient to receive, then the amount here is the amount that will be credited to the Recipient's account.

Example: 1000

Response

Quotes retrieved successfully

Body

quoteRequestIdstring

A universally unique ID for the overall quote request. (Each individual quote in this response has its own unique Quote Id)

Example: "d302cc08-323b-4ac6-897e-579a9abe0c88"

sourceCountrystring

2-letter country code for the Source Country

Example: "SG"

sourceCurrencystring

3-letter country code for the Source Country

Example: "SGD"

destinationCountrystring

2-letter country code for the Destination Country

Example: "TH"

destinationCurrencystring

3-letter country code for the Destination Country

Example: "THB"

amountCurrencystring

Source Currency if the Sender defined the amount to be sent. Destination Currency if the Sender defined the amount to be received by the Recipient.

Example: "SGD"

amountnumber

Example: 1000

quotesarray of object

quoteIdstring

The universally unique identifier (UUID) for this specific quote.

Example: "855cd802-8c7b-4fd2-8ce7-a456c1e12509"

issuedDateTimestring (date-time)

The date and time when the quote was issued.

Example: "2024-10-22T12:00:00Z"

fxpfinInstIdTypestring

The type of Financial Institution Id provided for the FXP eg BICFI, LEI

Example: "BICFI"

fxpfinInstIdstring

The FXP's Financial Institution identifier.

Example: "FXSGAAAA"

exchangeRatenumber

The exchange rate. Source Currency Amount * Exchange Rate = Destination Currency Amount

Example: 25

debtorAgentobject

interbankSettlementAmountobject

currencystring

3-letter currency code (will be the same as sourceCurrency above).

Example: "SGD"

amountnumber

The InterbankSettlementAmount (in the Source Currency) to be transferred from the Source PSP to the FXP's account at the Source SAP.

Example: 960

cappedToMaxAmountboolean

True if the requested amount exceeded the Source IPS's value cap (at the current exchange rate). If true, the amount above shows the actual amount that can be successfully transferred to the Destination PSP at the current exchange rate.

Example: false

nexusSchemeFeeobject

amountnumber

The Nexus Scheme Fee in the Source Currency, for the Source PSP's information. This is calculated to include both the nominal and percentage-based portion of the Nexus Scheme Fee.

Example: 1.5

currencystring

Same as Source Currency.

Example: "SGD"

intermediaryAgent1object

finInstIdobject

namestring

The name of the Source SAP.

Example: "DBS Bank Ltd"

BICFIstring

The BICFI code of the Source SAP.

Example: "DBSSSGSG"

LEIstring

The Legal Entity Identifier of the Source SAP.

Example: "ATUEL7OJR5057F2PV266"

clearingSystemMemberIdobject

clearingSystemIdstring

The Clearing System Identifier (as per ISO 20022).

memberIdstring

Clearing System Member Identifier (as per ISO 20022)

otherobject

idstring

Other type of financial institution identifier (as per ISO 20022)

intermediaryAgent1Accountobject

idstring

The account ID of the FXP's account at the Source SAP

Example: "2345678901"

intermediaryAgent2object

finInstIdobject

namestring

The name of the Destination SAP

Example: "Kasikornbank Public Company Limited"

BICFIstring

The BICFI code of the Destination SAP

Example: "KASITHBK"

LEIstring

The Legal Entity Identifier.

clearingSystemMemberIdobject

clearingSystemIdstring

Clearing System Identification (as per ISO 20022).

memberIdstring

Clearing System Member Identification (as per ISO 20022).

otherobject

idstring

Other type of financial institution identifier (as per ISO 20022)

intermediaryAgent2Accountobject

idstring

The account ID of the FXP's account at the Destination SAP

Example: "8881234569"

creditorAgentobject

interbankSettlementAmountobject

amountnumber

The InterbankSettlementAmount that must be transferred from the Destination SAP to the Destination PSP (CreditorAgent). Provided for information, but not used in the pacs.008 (as Nexus will recalculate this amount when it prepares the pacs.008 to be sent to the Destination IPS)

Example: 24000

currencystring

3-letter currency code. Same as Destination Currency.

Example: "THB"

cappedToMaxAmountboolean

True if the requested amount exceeded the Destination IPS's value cap (at the current exchange rate). If true, the amount above shows the actual amount that can be successfully transferred to the Destination PSP at the current exchange rate.

Example: false

chargesInformationobject

amountobject

amountnumber

The Destination PSP fee, as calculated according to the Nexus Scheme Fee.

Example: 100

currencystring

3-letter currency code. Same as Destination Currency.

Example: "THB"

creditorAccountAmountnumber

The exact amount that will be credited to the Recipient's account.

Example: 23900

Request

Response

Get quotes for a specific currency pair and amount

Retrieves a list of quotes for currency exchange based on the specified country/currency pair and the amount (denominated in either the source currency or destination currency)

GEThttp://localhost:3000/quotes/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}

Path parameters

sourceCountry*string

2-letter country code for the Source Country

Example: "SG"

sourceCurrency*string

3-letter currency code for the Source Currency

Example: "SGD"

destinationCountry*string

2-letter country code for the Destination Country

Example: "TH"

destinationCurrency*string

3-letter currency code for the Destination Currency

Example: "THB"

amountCurrency*string

Source Currency if the Sender defined the amount to be sent. Destination Currency if the Sender defined the amount to be received by the Recipient.

Example: "SGD"

amount*number

Example: 1000

Response

Quotes retrieved successfully

Body

quoteRequestIdstring

A universally unique ID for the overall quote request. (Each individual quote in this response has its own unique Quote Id)

Example: "d302cc08-323b-4ac6-897e-579a9abe0c88"

sourceCountrystring

2-letter country code for the Source Country

Example: "SG"

sourceCurrencystring

3-letter country code for the Source Country

Example: "SGD"

destinationCountrystring

2-letter country code for the Destination Country

Example: "TH"

destinationCurrencystring

3-letter country code for the Destination Country

Example: "THB"

amountCurrencystring

Source Currency if the Sender defined the amount to be sent. Destination Currency if the Sender defined the amount to be received by the Recipient.

Example: "SGD"

amountnumber

Example: 1000

quotesarray of object

quoteIdstring

The universally unique identifier (UUID) for this specific quote.

Example: "855cd802-8c7b-4fd2-8ce7-a456c1e12509"

issuedDateTimestring (date-time)

The date and time when the quote was issued.

Example: "2024-10-22T12:00:00Z"

fxpfinInstIdTypestring

The type of Financial Institution Id provided for the FXP eg BICFI, LEI

Example: "BICFI"

fxpfinInstIdstring

The FXP's Financial Institution identifier.

Example: "FXSGAAAA"

exchangeRatenumber

The exchange rate. Source Currency Amount * Exchange Rate = Destination Currency Amount

Example: 25

debtorAgentobject

interbankSettlementAmountobject

currencystring

3-letter currency code (will be the same as sourceCurrency above).

Example: "SGD"

amountnumber

The InterbankSettlementAmount (in the Source Currency) to be transferred from the Source PSP to the FXP's account at the Source SAP.

Example: 960

cappedToMaxAmountboolean

Example: false

nexusSchemeFeeobject

amountnumber

The Nexus Scheme Fee in the Source Currency, for the Source PSP's information. This is calculated to include both the nominal and percentage-based portion of the Nexus Scheme Fee.

Example: 1.5

currencystring

Same as Source Currency.

Example: "SGD"

intermediaryAgent1object

finInstIdobject

namestring

The name of the Source SAP.

Example: "DBS Bank Ltd"

BICFIstring

The BICFI code of the Source SAP.

Example: "DBSSSGSG"

LEIstring

The Legal Entity Identifier of the Source SAP.

Example: "ATUEL7OJR5057F2PV266"

clearingSystemMemberIdobject

clearingSystemIdstring

The Clearing System Identifier (as per ISO 20022).

memberIdstring

Clearing System Member Identifier (as per ISO 20022)

otherobject

idstring

Other type of financial institution identifier (as per ISO 20022)

intermediaryAgent1Accountobject

idstring

The account ID of the FXP's account at the Source SAP

Example: "2345678901"

intermediaryAgent2object

finInstIdobject

namestring

The name of the Destination SAP

Example: "Kasikornbank Public Company Limited"

BICFIstring

The BICFI code of the Destination SAP

Example: "KASITHBK"

LEIstring

The Legal Entity Identifier.

clearingSystemMemberIdobject

clearingSystemIdstring

Clearing System Identification (as per ISO 20022).

memberIdstring

Clearing System Member Identification (as per ISO 20022).

otherobject

idstring

Other type of financial institution identifier (as per ISO 20022)

intermediaryAgent2Accountobject

idstring

The account ID of the FXP's account at the Destination SAP

Example: "8881234569"

creditorAgentobject

interbankSettlementAmountobject

amountnumber

Example: 24000

currencystring

3-letter currency code. Same as Destination Currency.

Example: "THB"

cappedToMaxAmountboolean

Example: false

chargesInformationobject

amountobject

amountnumber

The Destination PSP fee, as calculated according to the Nexus Scheme Fee.

Example: 100

currencystring

3-letter currency code. Same as Destination Currency.

Example: "THB"

creditorAccountAmountnumber

The exact amount that will be credited to the Recipient's account.

Example: 23900

Request

Response

const response = await fetch('http://localhost:3000/quotes/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "quoteRequestId": "d302cc08-323b-4ac6-897e-579a9abe0c88",
  "sourceCountry": "SG",
  "sourceCurrency": "SGD",
  "destinationCountry": "TH",
  "destinationCurrency": "THB",
  "amountCurrency": "SGD",
  "amount": 1000,
  "quotes": [
    {
      "quoteId": "855cd802-8c7b-4fd2-8ce7-a456c1e12509",
      "issuedDateTime": "2024-10-22T12:00:00Z",
      "fxpfinInstIdType": "BICFI",
      "fxpfinInstId": "FXSGAAAA",
      "exchangeRate": 25,
      "debtorAgent": {
        "interbankSettlementAmount": {
          "currency": "SGD",
          "amount": 960,
          "cappedToMaxAmount": false
        },
        "nexusSchemeFee": {
          "amount": 1.5,
          "currency": "SGD"
        }
      },
      "intermediaryAgent1": {
        "finInstId": {
          "name": "DBS Bank Ltd",
          "BICFI": "DBSSSGSG",
          "LEI": "ATUEL7OJR5057F2PV266",
          "clearingSystemMemberId": {
            "clearingSystemId": null,
            "memberId": null
          },
          "other": {
            "id": null
          }
        }
      },
      "intermediaryAgent1Account": {
        "id": "2345678901"
      },
      "intermediaryAgent2": {
        "finInstId": {
          "name": "Kasikornbank Public Company Limited",
          "BICFI": "KASITHBK",
          "LEI": null,
          "clearingSystemMemberId": {
            "clearingSystemId": null,
            "memberId": null
          },
          "other": {
            "id": null
          }
        }
      },
      "intermediaryAgent2Account": {
        "id": "8881234569"
      },
      "creditorAgent": {
        "interbankSettlementAmount": {
          "amount": 24000,
          "currency": "THB",
          "cappedToMaxAmount": false
        },
        "chargesInformation": {
          "amount": {
            "amount": 100,
            "currency": "THB"
          }
        },
        "creditorAccountAmount": 23900
      }
    }
  ]
}