Quotes

Get quotes for a specific currency pair and amount

get

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)

Path 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
Query parameters
finInstIdTypestringRequired

Type ID of the financial institution.

finInstIdstringRequired

ID of the financial institution.

Responses
200
Quotes retrieved successfully
application/json
get
GET /quotes/{sourceCountry}/{sourceCurrency}/{destinationCountry}/{destinationCurrency}/{amountCurrency}/{amount} HTTP/1.1
Host: localhost:3000
Accept: */*
200

Quotes retrieved successfully

{
  "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": 1000,
          "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": 25000,
          "currency": "THB",
          "cappedToMaxAmount": false
        },
        "chargesInformation": {
          "amount": {
            "amount": 100,
            "currency": "THB"
          }
        },
        "creditorAccountAmount": 24900
      }
    }
  ]
}

Get Intermediary Agents for a specified quote

get

Retrieve intermediary agents (ie Settlement Access Providers) associated with a specified quote, as identified by quoteId.

Path parameters
quoteIdstringRequired

ID of the quote

Example: 9fa1e78d-b3d0-4d68-8032-d39d414a7366
Responses
200
Successful response
application/json
get
GET /quotes/{quoteId}/intermediary-agents HTTP/1.1
Host: localhost:3000
Accept: */*
{
  "intermediaryAgent1": {
    "name": "DBS Bank Ltd",
    "countryCode": "SG",
    "currencyCode": "SGD",
    "finInstId": {
      "BICFI": [
        "DBSSSGSG"
      ],
      "LEI": "ATUEL7OJR5057F2PV266",
      "otherId": null
    },
    "account": {
      "otherId": "2345678901"
    }
  },
  "intermediaryAgent2": {
    "name": "Kasikornbank Public Company Limited",
    "countryCode": "TH",
    "currencyCode": "THB",
    "finInstId": {
      "BICFI": [
        "KASITHBK"
      ],
      "LEI": null,
      "otherId": null
    },
    "account": {
      "otherId": "8881234569"
    }
  }
}

Last updated