v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB

Addresses

Modify future effective addresses

Allows updating of one or more existent merchant addresses.

The record to be updated is identified by the category and effective date and all fields except for the ones identifying the record can be updated.

put/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

Request body

categoryIndexstring required

The category of the address to be added. It can be a mandatory or optional category, defined per Institution. For a list of valid codes in the institution use the Acquirer Profile service-contracts/{serviceContractIndex}/addressCategories endpoint.

contactNamestring

The contact name at the address location. Any extended ASCII characters contains 2 bytes. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

groupSpecificboolean

Only applicable if a merchant is in a hierarchy. Indicates if the address is to be used for all merchants within the group.

line1string

Merchant address line 1 for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

line2string

Merchant address line 2 for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

line3string

Merchant address line 3 for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

line4string

Merchant address line 4 for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

line5string

Merchant address line 5 for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

postCodestring

Merchant address post code or zip code for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

citystring

Merchant city for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

statestring

Merchant state for the specified address category. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

countryCodestring

ISO-3166 alpha country code representing the country the address category is located in, the values are restricted based on institutions configuration. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal countryCode.

telephonestring

Telephone at the specified address category

faxstring

Fax at the specified address category

emailstring

Email address (with extended length capacity) for the specified address category

deliveryMethodIndexstring

Delivery method code of correspondence to this address; however, it is dependent on the delivery solutions in place for the given institution. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal deliveryMethodIndex.

effectiveDatestring required

Effective date of the address. When selecting address information on the Omnipay platform, the system will automatically choose the most recently effective address. To maintain accurate audit records, merchant addresses cannot be deleted after they become effective. Therefore, effective dates in the format of YYYYMMDD are used for all addresses. When adding address in merchant maintenance, the effective date must be on or after the current institution posting date. If no effective date is provided, the default will be the current institution posting date.

Example request

[
  {
    "categoryIndex": "001",
    "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",
    "deliveryMethodIndex": "200",
    "effectiveDate": "20201010"
  }
]

Response

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