Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Service Contract Specific Setup

Retrieve transaction charges for services

Retrieves active default transaction charges per service contract (i.e. Default charges with the latest effective date compared to the current posting date). Results can be filtered by Merchant Tariff or Service ID. If Merchant Tariff or Service ID are not selected, charges for all services and tariffs are returned. List of active charges can include fees where the fee mode is set to suppressed.

get/service-contracts/{serviceContractIndex}/service-transaction-charges

Path parameters

serviceContractIndexstring required
Example:516

Service Contract id. List of valid values can be obtained from "GET /service-contracts"

Query parameters

offsetinteger

The number of items to skip before returning the results

limitinteger

The number of items to return

serviceIndexstring
Example:101

Code id for the acquiring service. Filter results by specific service id.

tariffIndexstring
Example:000287

Code Id for specific merchat tariff. Filter results by merchant tariff.

recordIdNumberstring
Example:9999999999

Record id number of the transaction fee.

chargeTierLevelstring
Example:Tier 1

The tier assigned to the transaction fee which will drive the merchant tiered pricing.

chargeCurrencyCodestring
Example:EUR

The ISO 4217 currency code defined for the fee base, minimum and maximun amounts of the transaction fee.

Headers

Content-Type'application/json' | 'application/json;charset=UTF-8' required

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.

FSV-Interaction-Idstring required
Example:9591e6d8-0d70-11ea-8d71-362b9e155667

An RFC4122 UUID used as to trace requests.

Institution-Numberstring required
Example:00000099

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

Environmentstring required

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

dataobject

"Contains the primary data to be returned as the API response.

This object is used only when a single a single item is returned like It will not be returned in case of error."

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"
        }
      }
    ]
  },
  "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"
  }
}