Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Transaction and Account Fees

Add Merchant Specific Promotional Pricing

This operation enables the consumer apply time bound promotional pricing including transaction charges, account fees, or both. Hence that pricing automatically reverts to the previous standard pricing when the promotion ends. Example scenarios:

  1. Apply a temporary discounted price for a merchant on default or merchant-specific pricing; existing pricing resumes after the promotion.
  2. Apply an additional promotion for a merchant that already has a promotion (same or different period); existing pricing resumes after the new promotion. Note that existing promotion is not modified until the effective date and expiry date for the new promotion overrides the existing promotion. Note that system clones the default recordIdNumbers and applies the overrides from the payload. Hence consumer must provide all default recordIdNumbers that they want to set to the different pricing.
post/promotional-pricing

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": {
    "effectiveDate": "20251231",
    "expiryDate": "20251231",
    "individualFees": [
      {
        "recordIdNumber": "9999999999",
        "feeMode": true,
        "feePercentage": "5.0",
        "feeBase": "100.0",
        "feeMinimum": "13.0",
        "feeMaximum": "13.0",
        "triggerHighValue": "250.0",
        "triggerVolumeHigh": "250"
      }
    ]
  },
  "transactionCharges": {
    "effectiveDate": "20251231",
    "expiryDate": "20251231",
    "individualFees": [
      {
        "recordIdNumber": "9999999999",
        "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"
  }
}