Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Account Fees

Override active account fees

This endpoint can be used to override one or more individual fees or default fees to individuals. In both cases the effective date should be in the future.

The body of the request will include the list of fees that need to be overridden. Only the values to be overridden should be passed, fields that are not passed will inherit their original value.

post/account-fees

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.

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

Request body

feeModel'DEFAULT' | 'INDIVIDUAL' required

Indicates if it is a merchant individual fee or default fee. Default fees are a set of fees that apply to a group of merchants falling under the same service contract. Individual fees are fees forming part of the default set that are customised for a particular merchant.

recordIdNumberstring required

Record id of the client account fee to be overwritten. The corresponding id should belong to the client tariff id selected on the merchant contract details and the merchant accounts with account currency assigned to the merchant. For a list of valid codes use account-fees GET endpoint in merchant maintenance API.

effectiveDatestring required

Effective date of the fee. For auditing reasons merchant fees can not be deleted after it has become effective hence the use of effective dates for fees. Format YYYYMMDD

expiryDatestring required

Expiry date for fee if defined or set to or future date 99991231. Format YYYYMMDD. The date should be in future

feePercentagestring required

Fee percentage to be applied. Valid value as per the Format NNNNNN.NNNN

feeBasestring required

Fee base to be applied. Valid value as per the Format NNNNNN.NNNN

feeMinimumstring required

Fee minimum to be applied. Valid value as per the Format NNNNNN.NNNN

feeMaximumstring required

Fee minimum to be applied. Valid value as per the Format NNNNNN.NNNN

feeModeboolean required

Indicates if the fee is being generated (true) or suppressed (false). Suppressing a fee in effect is the same as setting the fee's pricing to zero, i.e. no fee will be charged.

triggerHighValuestring

Indicates the upper threshold limit set in terms of value of transaction that is used as a trigger for fee calculation. If populated, it will override current active value to the merchant specific value submitted on payload. This field is allowed to be overridden as merchant specific only for certain account fees.

triggerVolumeHighstring

Indicates the upper threshold limit set in terms of volume of transactions that is used as a trigger for fee calculation. If populated, it will override current active volume to the merchant specific volume submitted on payload. This field is allowed to be overridden as merchant specific only for certain account fees.

Example request

[
  {
    "recordIdNumber": "9999999999",
    "effectiveDate": "20201231",
    "expiryDate": "99991231",
    "feePercentage": "5.0",
    "feeBase": "100.0",
    "feeMinimum": "13.0",
    "feeMaximum": "13.0",
    "triggerHighValue": "250.0",
    "triggerVolumeHigh": "250"
  }
]

Response

OK

dataobject[]

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

Use this object only when respnse type is an array.

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