Skip to content

CurrencyConversionApi.md

Latest commit

 

History

History
70 lines (48 loc) · 4.2 KB

CurrencyConversionApi.md

File metadata and controls

70 lines (48 loc) · 4.2 KB

OpenapiClient::CurrencyConversionApi

All URIs are relative to https://cert.api.firstdata.com/gateway/v2

Method HTTP request Description
get_exchange_rate POST /exchange-rates Generate dynamic currency conversion transactions.

get_exchange_rate

ExchangeRateResponse get_exchange_rate(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts)

Generate dynamic currency conversion transactions.

Sale, return and lookup exchange rate with dynamic currency conversion option.

Example

# load the gem
require 'openapi_client'

api_instance = OpenapiClient::CurrencyConversionApi.new
content_type = 'application/json' # String | Content type.
client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
exchange_rate_request = OpenapiClient::ExchangeRateRequest.new # ExchangeRateRequest | Accepted request types: DCCExchangeRateRequest and DynamicPricingExchangeRateRequest.
opts = {
  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
}

begin
  #Generate dynamic currency conversion transactions.
  result = api_instance.get_exchange_rate(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling CurrencyConversionApi->get_exchange_rate: #{e}"
end

Parameters

Name Type Description Notes
content_type String Content type. [default to 'application/json']
client_request_id String A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
api_key String Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
timestamp Integer Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
exchange_rate_request ExchangeRateRequest Accepted request types: DCCExchangeRateRequest and DynamicPricingExchangeRateRequest.
message_signature String Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. [optional]
region String Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. [optional]

Return type

ExchangeRateResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json