v1
latestOpenAPI 3.0.02026-07-2480677847.6 KBRetrieve FX Rates
"This endpoint provides the FX Rate details for an institution that are available on the Fiserv OmniPay database."
Query parameters
Effective date from when the rates applied. Format YYYYMMDD. To extract FX rates for a specific time period, consumers must provide both 'effectiveDateAfter' and 'effectiveDateBefore'. The allowed range is a maximum of 1 month. Dates older than 13 months from the current system date are not permitted. Future date from the current system date are not permitted. If either 'effectiveDateAfter' or 'effectiveDateBefore' is provided, the system will return FX rates for the specified effective date only. If both 'effectiveDateAfter' and 'effectiveDateBefore' are provided then 'effectiveDateAfter' should be less than or equal to 'effectiveDateBefore'.
Effective date to when the rates applied. Format YYYYMMDD. To extract FX rates for a specific time period, consumers must provide both 'effectiveDateAfter' and 'effectiveDateBefore'. The allowed range is a maximum of 1 month. Dates older than 13 months from the current system date are not permitted. Future date from the current system date are not permitted. If either 'effectiveDateAfter' or 'effectiveDateBefore' is provided, the system will return FX rates for the specified effective date only. If both 'effectiveDateAfter' and 'effectiveDateBefore' are provided then 'effectiveDateAfter' should be less than or equal to 'effectiveDateBefore'.
Index of the FX Category belongs to the Scheme. If not populated, all Scheme's related FX rates defined for the institution will be returned in the response. For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter classification equal to 'fxCategory'.
The ISO 4217 alpha currency code defined for the counter currency. The ISO 4217 alpha currency code defined for the counter currency. To extract FX rates for a specific time period, consumers must provide this field along with 'effectiveDateAfter' and 'effectiveDateBefore'.
The number of items to return.
The number of items to skip before returning the results
Headers
Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.
An RFC4122 UUID used as to trace requests.
Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.
For test environment, specific test environment name should be passed (e.g. "bwu15"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value "prod" should be populated.
Response
OK
Example response
{
"meta": {
"paging": {
"count": 100,
"totalPages": 10,
"currentOffset": 1,
"currentNumberOfRetrievedRecords": 10,
"maxLimit": 10,
"hasMoreRecords": true,
"pageNumber": 1
},
"sorting": {
"sort": "name,-startDate"
},
"messages": [
{
"id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
"code": "ACCOUNT_NUMBER_NOT_FOUND",
"title": "The authorization credentials required for this request are invalid.",
"detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
"source": {
"pointer": "/dogs/name",
"parameter": "type",
"header": "type"
}
}
]
},
"data": [
{
"externalTerminalId": "54999530",
"serialNumber": "123456789",
"contactName": "John Doe",
"terminalLocation": "Munich",
"terminalCountry": {
"countryCode": "IRE"
},
"city": "Valletta",
"telephone": "003531123456",
"schemaId": "000000",
"accountCurrencyCode": "EUR",
"systemBatchId": "234234",
"serviceProvider": {
"serviceProviderIndex": "001"
},
"acquiringProfile": {
"acquiringProfileIndex": "000"
},
"templateId": "C234",
"clientFee": {
"clientFeeIndex": "402"
},
"feeEffectiveDate": "20200615",
"feeExpiryDate": "20200615",
"lastFeeDate": "20200615",
"configOfTerminal": {
"configOfTerminalIndex": "001"
},
"terminalType": {
"terminalTypeIndex": "000"
},
"emv": true,
"installDate": "20200615",
"activeDate": "20200615",
"terminationDate": "20200615",
"terminalPassword": "password",
"workStation": "Terminal WONO",
"amexDetails": {
"amexPhoneNo1": "00012458754865148",
"amexPhoneNo2": "00012458754865148",
"relatedTId": "FreeText"
},
"scheduleOfChargeDetails": {
"socCode": "00054214",
"waiver": "waiver02",
"setupFee": "3232000",
"gprsRental": "Monthly",
"gprsRentalAmount": "325",
"installed": "Installed"
},
"lastUpdatedBy": "John Smith",
"lastUpdatedDate": "20210406"
}
],
"errors": [
{
"id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
"code": "ACCOUNT_NUMBER_NOT_FOUND",
"title": "The authorization credentials required for this request are invalid.",
"detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
"source": {
"pointer": "/dogs/name",
"parameter": "type",
"header": "type"
}
}
],
"links": {
"self": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=3&limit=10",
"first": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=1&limit=10",
"last": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=10&limit=10",
"prev": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=2&limit=10",
"next": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=4&limit=10"
}
}