Retrieve merchant addresses

get https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/maintenance/api/v1/omnipay/addresses/{mid}

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

Responses

Response body

array of objects

object

status

string

enum

ACTIVE FUTURE ALL INACTIVE

merchantAddress

array of objects

merchantAddress

object

category

object

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 check the institution index file.

contactName

string

The contact name at the address location. UTF8 supported. Max length defined in bytes. Example: Joe Smith

groupSpecific

boolean

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

line1

string

length between 1 and 35

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.

line2

string

length between 0 and 35

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.

line3

string

length between 0 and 35

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.

line4

string

length between 0 and 35

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.

line5

string

length between 0 and 35

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.

postCode

string

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.

city

string

length between 1 and 35

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.

state

string

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.

countryCode

string

ISO-3166 alpha country code representing the country the address category is located in.

telephone

string

Telephone at the address

fax

string

Fax number

string

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

deliveryMethodIndex

object

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 check the institution index file.

effectiveDate

date

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.

lastUpdatedBy

string

Contact name of the person or system description that last updated the record.

lastUpdated

date

Last updated date

204

No register was found

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://cat-webfarm.1dc.com/boarding-ui-dev/external-api/maintenance/api/v1/omnipay/addresses/mid \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Successful operation

400Bad request

401Unauthorized request

403Forbidden request

404Record does not exist

500Internal Error