Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Service Contract Specific Setup

Retrieve auxiliary charges that may be applied to transactions

Retrieves default active auxiliary charges, e.g. Wire Fee, that can be assigned to a merchant (i.e default charges with the latest effective date compared to the current posting date). These are charges which are not related to a service. These charges are applicable to a merchant based on the Client Tariff assigned. Results can be filtered by Client Tariff, if omitted all configured Client Tariff are returned. List of active charges can include fees where the fee mode is set to suppressed.

get/service-contracts/{serviceContractIndex}/auxiliary-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

clientTariffIndexstring
Example:000321

Filter results for a specific client tariff index.

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

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": [
    {
      "transactionCurrency": "EUR",
      "effectiveDate": "20200615",
      "feeIdentifier": "DCC_CONV_VISA",
      "rateMargin": "12.0",
      "lastUpdated": "20210406",
      "lastUpdatedBy": "John Smith"
    }
  ],
  "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"
  }
}