Nexus API
Merchants Overview
Merchants represent businesses or entities where transactions occur, providing enhanced transaction details beyond the raw description.
Merchants will have the same guid on the MX integration and production environments.
The logo_url follows a pattern. It has a base URL and the filename will be the merchant_guid with a .png extension. The logo returned will be a 100 pixel by 100 pixel png file.
The current merchant logo base URL is: https://content.mx.com/logos/merchants/. MX may need to change this base URL from time to time, but in such cases partners will be notified and a redirect will be set up for the previous base URL.
Merchant Fields
| Field name | Data type | Description |
|---|---|---|
created_at | string | Date and time the merchant record was created, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00). |
guid | string | Unique identifier for the merchant. Defined by MX. |
logo_url | string | A URL which will return the merchant's logo. |
logo_updated_at | string | The date and time the logo associated with this merchant was last updated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00). |
name | string | The name of the merchant. |
updated_at | string | Date and time the merchant record was updated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00). |
website_url | string | The URL of the merchant's website. |
Merchant Locations
| Field | Data Type | Definition |
|---|---|---|
city | String | The city in which the merchant is located. |
country | String | The country in which the merchant is located. |
guid | String | The unique identifier for the merchant location. Defined by MX. |
latitude | Decimal | The latitude of the merchant location. This number is a signed decimal (e.g., Rio de Janeiro’s latitude is -22.9027800 and Tokyo’s latitude is 35.689488). |
longitude | Decimal | The longitude of the merchant location. This number is a signed decimal (e.g., Rio de Janeiro's longitude is -43.2075000 and Tokyo's longitude is 139.691706). |
merchant_guid | String | The unique identifier for the merchant to which this location belongs. Defined by MX. |
phone_number | String | The phone number for the merchant location. |
postal_code | String | The postal code in which the merchant is located. |
region_code | String | The region in which the merchant is located; e.g., a U.S. state code such as UT. |
street_address | String | The street address at which the merchant is located. |
updated_at | String | Date and time the merchant record was updated, represented in ISO 8601 format with timestamp (e.g., 2015-04-13T12:01:23-00:00). |