Quote Resource

The Quote resource contains rate details for all payments in a given batch. When a request to Quote a batch is received, all payments are aggregated by currency pair. Each pair is quoted using live rates and returned with trade amount, settlement amount, and conversion details.

Below are a list of the possible statuses for a quote resource.

Quote Status	Description
Created	Quote has been created
Expired	Quote has exceeded the 120 second timeout limit. A new quote must be generated
Committed	Quote has been used for booking an order

Quote Resource

{
    "id": string,
    "customerId": string,
    "partnerReference": string,
    "expirationIntervalInSec": 0,
    "createdOn": string,
    "status": string,
    "lastUpdatedOn": string,
    "quotedItems": [
        {
            "isDirectRate": true,
            "rate": 0,
            "rateInverted": 0,
            "decimalsDirect": 0,
            "decimalsIndirect": 0,
            "incomingOrderId": string,
            "tradeAmount": 0,
            "settlementAmount": 0,
            "tradeCurrency": string,
            "settlementCurrency": string
        }
    ]
}

Sample Input

//POST Holding Quote

{
    "customerId": "Customer_123",
    "partnerReference": "",
    "itemsToQuote":[
        {
            "amount": 2500,
            "isAmountSettlement":false,
            "tradeCurrency":"ZAR",
            "settlementCurrency":"GBP"
        }
    ]
}

Sample Response

{
    "expirationIntervalInSec": 120,
    "createdOn": "2022-02-02T15:09:15Z",
    "status": "Created",
    "lastUpdatedOn": "2022-02-02T15:09:15Z",
    "quotedItems": [
        {
            "isDirectRate": true,
            "rate": 1.2529,
            "rateInverted": 0.7981687898089171974522292994,
            "decimalsDirect": 4,
            "decimalsIndirect": 28,
            "incomingOrderId": "Order123",
            "tradeAmount": 10025,
            "settlementAmount": 12560,
            "tradeCurrency": "USD",
            "settlementCurrency": "CAD"
        }
    ]
}