Mastercard · Schema
Merchant
Merchant detail information
Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500
Properties
| Name | Type | Description |
|---|---|---|
| addressLine1 | string | Line 1 of the street address for the merchant location. Usually includes the street number and name. |
| addressLine2 | string | Line 2 of the street address usually an apartment number or suite number. |
| cashbackMaximumAmount | string | Maximum cashback amount permitted at the location. |
| category | string | The Merchant Category |
| countryCode | string | Two digit alpha country code as defined in ISO |
| countryName | string | Name of the country. |
| countrySubdivisionCode | string | Code of the state or province for a merchant location. |
| countrySubdivisionName | string | Name of the state or province for a merchant location. |
| city | string | The name of the city for a merchant location. |
| distance | number | This is the numerical value for the distance from the provided location to the selected merchant. |
| distanceUnit | string | This is the unit of measure value for the distance from the provided location to the selected merchant. Options are KM and MILE. |
| easySavingsMerchantOfferId | string | Merchant's Easy Savings Offer Id |
| geocodingResult | string | GeocodingResult for the merchant |
| id | integer | Numerical merchant identifier. |
| isPayPassConcession | boolean | Boolean value which indicates if the concession area is equipped with a PayPass card reader. |
| isPayPassPharmacy | boolean | Boolean value which indicates if the pharmacy is equipped with a PayPass card reader. |
| isPayPassFuelPump | boolean | Boolean value which indicates if the fuel pump is equipped with a PayPass card reader. |
| isPayPassTollBooth | boolean | Boolean value which indicates if the toll booth is equipped with a PayPass card reader. |
| isPayPassDriveThrough | boolean | Boolean value which indicates if the drive thru is equipped with a PayPass card reader. |
| isPayPassRegister | boolean | Boolean value which indicates if the register is equipped with a PayPass card reader. |
| isPayPassTicketing | boolean | Boolean value which indicates if the ticketing area is equipped with a PayPass card reader. |
| isPayPassVendingMachine | boolean | Boolean value which indicates if the vending machine is equipped with a PayPass card reader. |
| isRepowerByCardSwipeSupported | boolean | Boolean value which indicates if the repower card load type at this merchant supports Card Swipe. |
| isRepowerByMoneyPakSupported | boolean | Boolean value which indicates if the repower card load type at this merchant supports MoneyPak. |
| latitude | string | The latitude of the merchant |
| locationName | string | The name of the merchant |
| longitude | string | The longitude of the merchant. |
| phoneNumber | string | Merchant's phone number |
| postalCode | string | The postal code of the Merchant location. |
| websiteUrl | string | Merchant's website URL address |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Merchant",
"type": "object",
"description": "Merchant detail information",
"properties": {
"addressLine1": {
"type": "string",
"description": "Line 1 of the street address for the merchant location. Usually includes the street number and name."
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the street address usually an apartment number or suite number."
},
"cashbackMaximumAmount": {
"type": "string",
"description": "Maximum cashback amount permitted at the location."
},
"category": {
"type": "string",
"description": "The Merchant Category"
},
"countryCode": {
"type": "string",
"description": "Two digit alpha country code as defined in ISO"
},
"countryName": {
"type": "string",
"description": "Name of the country."
},
"countrySubdivisionCode": {
"type": "string",
"description": "Code of the state or province for a merchant location."
},
"countrySubdivisionName": {
"type": "string",
"description": "Name of the state or province for a merchant location."
},
"city": {
"type": "string",
"description": "The name of the city for a merchant location."
},
"distance": {
"type": "number",
"description": "This is the numerical value for the distance from the provided location to the selected merchant."
},
"distanceUnit": {
"type": "string",
"description": "This is the unit of measure value for the distance from the provided location to the selected merchant. Options are KM and MILE."
},
"easySavingsMerchantOfferId": {
"type": "string",
"description": "Merchant's Easy Savings Offer Id"
},
"geocodingResult": {
"type": "string",
"description": "GeocodingResult for the merchant"
},
"id": {
"type": "integer",
"description": "Numerical merchant identifier."
},
"isPayPassConcession": {
"type": "boolean",
"description": "Boolean value which indicates if the concession area is equipped with a PayPass card reader."
},
"isPayPassPharmacy": {
"type": "boolean",
"description": "Boolean value which indicates if the pharmacy is equipped with a PayPass card reader."
},
"isPayPassFuelPump": {
"type": "boolean",
"description": "Boolean value which indicates if the fuel pump is equipped with a PayPass card reader."
},
"isPayPassTollBooth": {
"type": "boolean",
"description": "Boolean value which indicates if the toll booth is equipped with a PayPass card reader."
},
"isPayPassDriveThrough": {
"type": "boolean",
"description": "Boolean value which indicates if the drive thru is equipped with a PayPass card reader."
},
"isPayPassRegister": {
"type": "boolean",
"description": "Boolean value which indicates if the register is equipped with a PayPass card reader."
},
"isPayPassTicketing": {
"type": "boolean",
"description": "Boolean value which indicates if the ticketing area is equipped with a PayPass card reader."
},
"isPayPassVendingMachine": {
"type": "boolean",
"description": "Boolean value which indicates if the vending machine is equipped with a PayPass card reader."
},
"isRepowerByCardSwipeSupported": {
"type": "boolean",
"description": "Boolean value which indicates if the repower card load type at this merchant supports Card Swipe."
},
"isRepowerByMoneyPakSupported": {
"type": "boolean",
"description": "Boolean value which indicates if the repower card load type at this merchant supports MoneyPak."
},
"latitude": {
"type": "string",
"description": "The latitude of the merchant"
},
"locationName": {
"type": "string",
"description": "The name of the merchant"
},
"longitude": {
"type": "string",
"description": "The longitude of the merchant."
},
"phoneNumber": {
"type": "string",
"description": "Merchant's phone number"
},
"postalCode": {
"type": "string",
"description": "The postal code of the Merchant location."
},
"websiteUrl": {
"type": "string",
"description": "Merchant's website URL address"
}
}
}