Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Merchant Services

Add Merchant Acquiring Services

This operation allows to add one or more acquiring services to a memeber level merchant.

post/merchant-services

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

serviceIndexstring required

Code id for the acquiring service. Valid values depends on the institution configuration. For a list of valid codes use Acquirer Profile API get /service-contracts/{serviceContractIndex}/services-tariff.

tariffIndexstring required

Code ID for the tariff which drives the default transactions fees to be generated for the merchant per service. For a list of valid codes use Acquirer Profile API service-contracts/{serviceContractIndex}/services-tariff endpoint.

floorLimitstring

Floor limit for merchant service selected; for information purpose only

limitCurrencystring

The ISO 4217 currency code for the floor limit.

dinersCode'CONVEYANCE_CLEARING' | 'DINERS_AND_DISCOVER' | 'NA'

Processing model to be applied for the merchant for Diners and Discover. Required if the service id corresponds to a Diners/Discover service.

jcbStateCodeIndexstring

State code required to process and clear JCB transaction. Only required for JCB services. Value depends on the institution configuration. For a list of valid status codes use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal jcbStateCodeIndex.

jcbAreaCode1Indexstring

Area code 1 required to process and clear JCB transaction. Only required for JCB services. State and selected area codes should be as per institution specific list of values. For a list of valid status codes use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal jcbAreaCode1Index.

jcbArea2Indexstring

Area code 2 required to process and clear JCB transaction. Only required for JCB services. State and selected area codes should be as per institution specific list of values. For a list of valid status codes use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal jcbArea2Index.

merchantSubIdstring

Merchant sub id required to process and clear Ideal transaction. Required for Ideal service. Must not exist on an already boarded merchant under same institution.

acquirerNoOfInstallmentinteger

Indicates the maximum allowed number of acquirer installments per presentment per acquiring service (serviceIndex) for a merchant.

Example request

[
  {
    "serviceIndex": "101",
    "tariffIndex": "000573",
    "floorLimit": "000000000000000000",
    "limitCurrency": "EUR",
    "jcbStateCodeIndex": "TXT",
    "jcbAreaCode1Index": "01",
    "jcbArea2Index": "01",
    "merchantSubId": "000001",
    "acquirerNoOfInstallment": 4
  }
]

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