Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Transaction Charges

Reprice future dated merchant transaction charges

Reprice one or more future-effective individual merchant transaction charges.

Records for the repricing are identified by record id number, which must be a valid future individual charge ( having effective date later than current posting date).

This endpoint will update expiry date,fee mode,fee percentage,fee base,fee minimum and fee maximum

put/transaction-charges

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

recordIdNumberstring required

Record id of the transaction fee to be overwritten. For a list of valid record ids use transaction-charges GET endpoint in Merchant Maintenance API.

effectiveDatestring required

Effective date of the transaction charge. It should be greater than the Institution current posting date. 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

feeModeboolean

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.

feePercentagestring

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

feeBasestring

Charge base amount to be applied.

feeMinimumstring

Minimum charge amount.

feeMaximumstring

Maximum charge amount.

chargeCurrencyCodestring

The ISO 4217 currency code for the charge base, minimum and maximun amounts. Values are restricted by institution configuration. For a list of valid codes refer accountCurrency classification in reference-data endpoint in Acquirer Profile API.

Example request

[
  {
    "recordIdNumber": "9999999999",
    "effectiveDate": "20200615",
    "expiryDate": "99991231",
    "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"
  }
}