Retrieves merchant transaction charges

Retrieves a paginated list of transaction charges assigned to the merchant id.

Can be filtered by charge status (default: ACTIVE) and the merchant's enabled acquiring service ( default: all). Filtering can be used together or independently.

chargeStatus'ACTIVE' | 'FUTURE' | 'ALL' | 'INACTIVE'

Active - returns the most effective transaction charges for the current posting date. Future - returns all transaction charges whose effective date is greater than the current posting date. Inactive - returns all transaction charges that has been overridden by a more effective record or having the expiry date earlier than current posting date. All - returns active, future and inactive transaction charges

serviceIndexstring

Example:101

Returns the transaction charges filtered by the service index. By default it returns all services.

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.

chargeModel'INDIVIDUAL' | 'DEFAULT'

Default - Is part of a set of transaction charges that are not linked to any particular merchant, but linked to a client tariff. Individual - Is part of a set of transaction charges that are assigned directly to a merchant. Individual tariffs superceeds defaults. A merchant can either be on a set of default or individual transaction charges.

limitinteger

The number of items to return

offsetinteger

The number of items to skip before returning the results

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.

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.

Institution-Numberstring required

Example:00000099

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

Internal-Merchant-Idstring required

OPY Internal Client Number

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": [
    {
      "recordIdNumber": "9999999999",
      "effectiveDate": "20200615",
      "expiryDate": "99991231",
      "feePercentage": "5.0",
      "feeBase": "250.0",
      "feeMinimum": "250.0",
      "feeMaximum": "250.0",
      "chargeCurrencyCode": "EUR",
      "chargeTierLevel": "Not Applicable",
      "lastUpdatedBy": "John Smith",
      "lastUpdated": "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"
  }
}

v1

Retrieves merchant transaction charges

Query parameters

Headers

Response

Example response