Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Multi-Currency Pricing Rate Lookup

Multi-Currency Pricing Rate Lookup

Performs a foreign currency exchange rate look-up, and secures that exchange rate for use in a subsequent Multi-Currency Pricing financial transaction. The exchange rate retrieved by this transaction request is represented in the response as the multiCurrencyPricingRateLookupId, and the underlying exchange rate is locked in for a limited time period.

post/multi-currency-pricing-rates

Request body

multiCurrencyPricingTransactionType'PAYMENT' | 'REFUND' required

Value representing the type of subsequent transaction request that the rate token will be used for

customDataCustomData nullable

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Example request

{
  "multiCurrencyPricingTransactionType": "PAYMENT",
  "multiCurrencyPricingRateInformationRequests": [
    {
      "amount": {
        "currency": "USD",
        "amount": 3000
      },
      "amountType": "CARDHOLDER"
    },
    {
      "amount": {
        "currency": "USD",
        "amount": 4015
      },
      "cardholderCurrency": "USD",
      "amountType": "MERCHANT_SETTLEMENT"
    }
  ]
}

Response

Multi-Currency Pricing (MCP) Rate lookup Response

multiCurrencyPricingRateLookupIdstring required

Used to identify API resources which may be required for future follow-on transactions; i.e. Refunds, Corrections, Completions, Reversals, etc.

multiCurrencyPricingTransactionType'PAYMENT' | 'REFUND' required

Value representing the type of subsequent transaction request that the rate token will be used for

rateValidityEndTimestring date-time required

Date & Time

customDataobject nullable

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

createdAtstring date-time required

Time at which the object was created

Example response

{
  "multiCurrencyPricingRateLookupId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "multiCurrencyPricingTransactionType": "PAYMENT",
  "rateValidityEndTime": "2019-07-30T06:43:40.252Z",
  "rateConversions": [
    {
      "cardholderAmount": {
        "amount": 3000,
        "currency": "USD"
      },
      "merchantSettlementAmount": {
        "amount": 4024,
        "currency": "CAD"
      },
      "multiCurrencyPricingExchangeRate": 1.3413,
      "multiCurrencyPricingStatusCode": 200,
      "multiCurrencyPricingStatusMessage": ""
    },
    {
      "cardholderAmount": {
        "amount": 2993,
        "currency": "USD"
      },
      "merchantSettlementAmount": {
        "amount": 4015,
        "currency": "CAD"
      },
      "multiCurrencyPricingExchangeRate": 1.3413,
      "multiCurrencyPricingStatusCode": 200,
      "multiCurrencyPricingStatusMessage": ""
    }
  ],
  "createdAt": "2019-07-30T06:43:40.252Z"
}