Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Generic Acquirer Setup

Retrieve institution posting date

This endpoint provides the current institution posting date on the environment in YYYYMMDD format.

get/institution-posting-date

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": [
    {
      "sourceAccount": {
        "accountTypeIndex": "470",
        "accountCurrencyCode": "GBP"
      },
      "destinationAccount": {
        "accountTypeIndex": "470",
        "accountCurrencyCode": "GBP"
      },
      "instructionType": {
        "instructionTypeIndex": "001"
      },
      "status": "ACTIVE",
      "instructionIdNumber": "0000000010",
      "deductionStartDate": "20201030",
      "deductionEndDate": "20201030",
      "deductionPercentage": "5.0",
      "deductionMinAmount": "250.0",
      "deductionMaxAmount": "250.0",
      "deductionBaseAmount": "250.0",
      "deductionTotalCnt": "100000",
      "deductionTotalAmount": "100000",
      "factorAgent": "James Kirk",
      "note": "Free text to leave any extra notes",
      "deductionFrequency": "Daily",
      "lastExecutionDate": "20201030",
      "executionCount": "10",
      "amountPaid": "10000.50",
      "lastUpdatedBy": "John Smith",
      "lastUpdatedDate": "20210406"
    }
  ],
  "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"
  }
}