Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Merchant Details

Update merchant contract details

Update the merchant future dated contract details.

put/merchant-details-scheduled

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

clientTariffIndexstring

The client tariff determines the set of account fees applicable to the merchant. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal clientTariffIndex when creating or editing an existing merchant profile.

postingTariffIndexstring

The posting tariff determines how transactions and fees are posted to the merchant accounts. For a list of valid posting tariffs use Acquirer Profile API get account-settlement endpoint when creating or editing an existing merchant profile.

settlementMethodIndexstring

The settlement method defines the frequency and grouping of transactions posted to makeup a payment as well as the funding channel. For a list of valid codes use Acquirer Profile API GET account-settlement endpoint when creating or editing an existing merchant profile.

tierStructureIndexstring

If tier pricing is active on the institutions this field indicates which is the Tier Structure assigned to the merchant, if not in use for the institution use 000=N/A for this field. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal tierStructureIndex when creating or editing an existing merchant profile.

effectiveDatestring

Effective date format YYYYMMDD

tierPricingFlagstring

Indicates whether tiered pricing is enabled and at which level. "002"(S) = sub-group level enabled, "001"(M) = member level enabled, "000"(N/A) = not enabled. Maintenance of this flag (i.e. changing from 'S' to another value or another value to 'S') is allowed only from Sub group level merchant where system updates the same value to all child merchants. This field is not allowed to be modified at member level merchant. For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter classification equal to tierPricingFlag.

Example request

{
  "clientTariffIndex": "000321",
  "postingTariffIndex": "503",
  "settlementMethodIndex": "179",
  "tierStructureIndex": "000",
  "effectiveDate": "20200615",
  "tierPricingFlag": "000"
}

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