Retrieve account fees

Retrieves a paginated list of merchant account fees. By default only active fees are returned, the results can be fitered by fee status and fee model.

feeStatus'ACTIVE' | 'FUTURE' | 'ALL' | 'INACTIVE'

Example:ACTIVE

Active - returns all active account fees. Can be a mix of default and individual fees. Future - returns fees that are set to become effective in the future, having effectiveDate later than current posting date. Inactive - Fees that has been overriden by a more recent effective fee. All - returns all active, future and expired fees. By default active charges are returned.

feeModel'DEFAULT' | 'INDIVIDUAL' | 'ALL'

Default - returns the fees configured to the Client Tariff that are applicable to the merchant. Individual - Retrieves merchant customized fees. All - returns both default and individual fees. By default All are returned.

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",
      "accountCurrencyCode": "EUR",
      "effectiveDate": "20200615",
      "expiryDate": "99991231",
      "feeBaseCurrencyCode": "EUR",
      "feePercentage": "5.0",
      "feeBase": "100.0",
      "feeMinimum": "13.0",
      "feeMaximum": "13.0",
      "triggerHighValue": "250.0",
      "triggerLowValue": "0.10",
      "triggerVolumeHigh": "250",
      "triggerVolumeLow": "250",
      "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"
  }
}

v1

Retrieve account fees

Query parameters

Headers

Response

Example response