Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Addresses

Retrieve merchant addresses

Returns the addresses assigned to the merchant.

Can be filtered by address category and status.

By default, if no value is passed for the address category index, it returns all the address categories that are active for the merchant. The list can be filtered by address category and/or address status.

get/addresses

Query parameters

categoryIndexstring

One or multple 3 digit values for categoryIndex code. If no value is passed, all addressCategories will be returned

addressStatus'FUTURE' | 'ACTIVE' | 'ALL'

Active - returns all addresses associated with internalMerchantId that have an effective date less than or equal to posting date. Future - returns all addresses associated with merchant id that have an effective date greater than posting date. All - returns both future and active addresses.

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

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": [
    {
      "merchantAddress": [
        {
          "contactName": "Joe Smith",
          "line1": "15 Beach Street",
          "line2": "4th Zone",
          "line3": "Bremen",
          "line4": "Saxony",
          "line5": "Ireland",
          "postCode": "D18 R219",
          "city": "Frankfurt",
          "state": "TX2",
          "countryCode": "IRE",
          "telephone": "00353112345678",
          "fax": "5351456789",
          "email": "abc@omnipay.com",
          "effectiveDate": "20201010",
          "lastUpdatedBy": "John Smith",
          "lastUpdated": "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"
  }
}