Quote API
Attribute | Type | Condition | Description |
Source Currency | String | Mandatory | From Currency |
Destination Currency | String | Mandatory | To Currency |
Attribute | Type | Condition | Description |
Source Liquidity Provider | String | Mandatory | Liquidity Provider in the Source IPS |
Destination Liquidity Provider | String | Mandatory | Liquidity Provider in the Destination IPS |
Rate | String | Mandatory | Exchange rate offered |
Public | Boolean | Mandatory | Boolean to indicate whether the rate is limited or publicly available |
Timestamp | DateTime | Optional | Valid from timestamp |
Allowed Source Bank | Array | Conditional | If Public is N, a finite list of banks allowed to query this rate |
Source Bank ID | String | Conditional | BIC (or equivalent) of the Source Bank (repetitive) |
Attribute | Type | Condition | Description |
Rate ID | UUID | Mandatory | Unique ID of the rate |
Rates | Array | Mandatory | |
| String | Mandatory | Rates for this currency pair currently being offered |
Attribute | Type | Condition | Description |
Source Currency | String | Mandatory | Sender’s currency |
Destination Currency | String | Mandatory | Recipient’s currency |
Attribute | Type | Condition | Description |
Type | String | Mandatory | Best, List or Nominated |
Nominated FX Provider ID | String | Conditional (mandatory if Type is Nominated) | ID of FXP in case of dedicated request |
Attribute | Type | Condition | Description |
Rates | Array | Mandatory | |
| UUID | Conditional | Unique quote ID |
| String | Conditional | Rate |
| String | Conditional | UUID of FXP |
| String | Conditional | BIC (or equivalent) of the Source Liquidity Provider |
New quotes using the Update Quote will automatically overwrite old quotes, so Delete Quote is not usually needed. However, an FX Provider who has issued a private quote visible to specific banks may wish to retract that quote and could use Delete Quote to do so.
Deleted quotes will be set to expire 5 minutes after the delete request was received by Nexus.
DELETE /v1/quote/{quote_id}
Attribute | Type | Condition | Description |
N/A | | | |
Attribute | Type | Condition | Description |
Quote ID | UUID | Mandatory | |
Expiry DateTime | ISODateTime | Mandatory | Timestamp when quote will expire |
https://<customerDefinedHost:Port>/webhook
This template will be triggered during the account validation process to inform the FX Provider of an FX quote being given to a Sender.
Fields | Description | Type |
Amount | The amount of the quote | String |
Source Currency | The currency of the Source country | String |
Destination Currency | The currency of the Destination country | String |
Rate | The exchange rate for the payment | String |
Quote ID | The unique ID of the original quote | UUID |
Expiry Date Time | Timestamp until the quote is valid | ISODateTime |