Quotes

Get quotes for a specific currency pair and amount

get

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

/v1/quotes

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)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sourceCountrystringRequired

2-letter country code for the Source Country

Example: SG

sourceCurrencystringRequired

3-letter currency code for the Source Currency

Example: SGD

destinationCountrystringRequired

2-letter country code for the Destination Country

Example: TH

destinationCurrencystringRequired

3-letter currency code for the Destination Currency

Example: THB

amountCurrencystringRequired

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

amountnumberRequired

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

finInstIdTypestringRequired

Type ID of the financial institution.

finInstIdstringRequired

ID of the financial institution.

destFinInstIdTypestringOptional

Type ID of the destination financial institution.

destFinInstIdstringOptional

ID of the destination financial institution.

Responses

200

Quotes retrieved successfully

application/json

quoteRequestIdstringOptional

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

sourceCountrystringOptional

2-letter country code for the Source Country

Example: SG

sourceCurrencystringOptional

3-letter country code for the Source Country

Example: SGD

destinationCountrystringOptional

2-letter country code for the Destination Country

Example: TH

destinationCurrencystringOptional

3-letter country code for the Destination Country

Example: THB

amountCurrencystringOptional

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

amountnumberOptional

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

400

Invalid request. Applicable reason codes: TE001 INVALID_REQUEST, BE007 QUOTE_SAME_CURRENCY, BE008 QUOTE_DESTINATION_PSP_REQUIRED.

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

No FX Provider has registered an active currency pair matching the request. Reason code BE009 QUOTE_CURRENCY_PAIR_NOT_CONFIGURED.

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/quotes

HTTPcURLJavaScriptPython

GET /v1/quotes?sourceCountry=text&sourceCurrency=text&destinationCountry=text&destinationCurrency=text&amountCurrency=text&amount=1&finInstIdType=text&finInstId=text HTTP/1.1
Host: localhost:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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",
      "expiryDateTime": "2024-10-22T12:10:00Z",
      "fxpFinInstIdType": "BICFI",
      "fxpFinInstId": "FXSGAAAA",
      "exchangeRate": 25,
      "debtorAgent": {
        "interbankSettlementAmount": {
          "currency": "SGD",
          "amount": 960,
          "cappedToMaxAmount": false
        }
      },
      "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
      }
    }
  ]
}