Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Transaction and Account Fees

Modify Merchant Specific Pricing

This operation enables the consumer to update their merchant-specific pricing setup, including transaction charges, account fees, or both. This endpoint can be utilized for the following purposes,

  1. To expire all existing active and future effective dated merchant-specific charges and create new future effective dated merchant-specific charges. In this scenario, the user must provide a list of default recordIdNumbers from the current tariff assigned to the merchant along with the fee values that need to be overridden.
  2. To expire all existing active and future effective dated merchant-specific charges and change the tariff assignment for the merchant, creating new future effective dated merchant-specific charges for the new tariff. In this case, the user must provide a list of default recordIdNumbers from the new tariff to be assigned to the merchant along with the fee values to be overridden. Note that if a merchant already has any future effective dated tariff change in place, adding another future effective tariff change is not permitted.
put/transaction-and-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

Example request

{
  "accountFees": {
    "serviceContractIndex": "497",
    "clientTariffIndex": "000321",
    "existingMsfFeeExpiryDate": "20251231",
    "individualFees": [
      {
        "recordIdNumber": "9999999999",
        "effectiveDate": "20200615",
        "expiryDate": "20251231",
        "feeMode": true,
        "feePercentage": "5.0",
        "feeBase": "100.0",
        "feeMinimum": "13.0",
        "feeMaximum": "13.0",
        "triggerHighValue": "250.0",
        "triggerVolumeHigh": "250"
      }
    ]
  },
  "transactionCharges": {
    "serviceContractIndex": "497",
    "existingMsfFeeExpiryDate": "20251231",
    "tierStructureIndex": "000",
    "individualFees": [
      {
        "serviceIndex": "101",
        "merchantTariffIndex": "000573",
        "recordIdNumber": "9999999999",
        "effectiveDate": "20200615",
        "expiryDate": "20251231",
        "feeMode": true,
        "feePercentage": "5.0",
        "feeBase": "250.0",
        "feeMinimum": "250.0",
        "feeMaximum": "250.0",
        "chargeCurrencyCode": "EUR"
      }
    ]
  }
}

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