Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Service Contract Specific Setup

Retrieve accounts per settlement method and posting tariff

Retrieves a paginated list of valid account types and currency per settlement method and posting tariff for a service contract.

The settlement method determines how the particular merchant account is settled. E.g. Daily based on the closing balance of the account via a SEPA funding file. The posting tariff determine where transactions are posted. E.g. All transaction gross amount will be posted to the "Payment Retail" account and all the associated transaction fees will be posted to the "Fee Collect" account.

This endpoint can be used during boring and maintenance to find for a selected service contract the valid settlement methods, and for the settlement method the valid posting tariff as well as the valid account types and currencies for the combination of settlement method and posting tariff. By default all possible combinations are returned; the list can be filtered by settlement method and/or posting tariff.

get/service-contracts/{serviceContractIndex}/account-settlement

Path parameters

serviceContractIndexstring required
Example:516

Service Contract id. List of valid values can be obtained from "GET /service-contracts"

Query parameters

settlementMethodIndexstring

The settlement method defines the frequency and grouping of transactions posted to makeup a payment as well as the funding channel.

Example:179
postingTariffIndexstring

The posting tariff determines how transactions and fees are posted to the merchant accounts.

offsetinteger

The number of items to skip before returning the results

limitinteger

The number of items to return

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.

Institution-Numberstring required
Example:00000099

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

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.

Response

OK

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"
        }
      }
    ]
  },
  "data": {
    "merchantStatus": {
      "merchantStatusIndex": "001"
    },
    "merchantStatusEffectiveDate": "20200615"
  },
  "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"
  }
}