{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:mastercard-locations/get-atms-v1-atm":{"get":{"operationId":"open_data_mastercard_locations_get_atms_v1_atm","summary":"Returns detailed information about an ATM location. This information can be used to display ATMs on a map,…","description":"GET /atms/v1/atm","tags":["open-data"],"parameters":[{"name":"PageOffset","in":"query","required":true,"description":"Zero-based offset where the response will start. The actual start position is this value +1. An offset of 10 starts at item 11. Combined…","schema":{"type":"integer","description":"Zero-based offset where the response will start. The actual start position is this value +1. An offset of 10 starts at item 11. Combined…"},"example":"0"},{"name":"PageLength","in":"query","required":true,"description":"Maximum number of items to retrieve within the current \"page\" of results.","schema":{"type":"integer","description":"Maximum number of items to retrieve within the current \"page\" of results."},"example":"5"},{"name":"AddressLine1","in":"query","required":false,"description":"Line 1 of the street address for the merchant location. Usually includes the street number and name. This parameter is ignored if latitude…","schema":{"type":"string","description":"Line 1 of the street address for the merchant location. Usually includes the street number and name. This parameter is ignored if latitude…"},"example":"114 Fifth Avenue"},{"name":"AddressLine2","in":"query","required":false,"description":"Line 2 of the street address usually an apartment number or suite number. This parameter is used rarely and is ignored if latitude and…","schema":{"type":"string","description":"Line 2 of the street address usually an apartment number or suite number. This parameter is used rarely and is ignored if latitude and…"},"example":"Apartment 1"},{"name":"City","in":"query","required":false,"description":"The name of the city for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…","schema":{"type":"string","description":"The name of the city for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…"},"example":"New York City"},{"name":"CountrySubdivision","in":"query","required":false,"description":"The state or province for a merchant location (only supported for US and Canada locations). This parameter is ignored if latitude and…","schema":{"type":"string","description":"The state or province for a merchant location (only supported for US and Canada locations). This parameter is ignored if latitude and…"},"example":"NY"},{"name":"PostalCode","in":"query","required":false,"description":"The zip code or postal code for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…","schema":{"type":"string","description":"The zip code or postal code for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…"},"example":"11101"},{"name":"Country","in":"query","required":false,"description":"Any three digit country code for an ATM location. Valid values are Three digit alpha country code as defined in ISO 3166-1. This parameter…","schema":{"type":"string","description":"Any three digit country code for an ATM location. Valid values are Three digit alpha country code as defined in ISO 3166-1. This parameter…"},"example":"USA"},{"name":"Latitude","in":"query","required":false,"description":"The latitude of a merchant location. If latitude is provided longitude must also be provided.","schema":{"type":"number","description":"The latitude of a merchant location. If latitude is provided longitude must also be provided."},"example":"38.76006576913497"},{"name":"Longitude","in":"query","required":false,"description":"The longitude of a merchant location. If longitude is provided latitude must also be provided.","schema":{"type":"number","description":"The longitude of a merchant location. If longitude is provided latitude must also be provided."},"example":"-90.74615107952418"},{"name":"DistanceUnit","in":"query","required":false,"description":"Indicates the unit for the radius as well as the units of the distance of each location from the basepoint in the response.","schema":{"type":"string","description":"Indicates the unit for the radius as well as the units of the distance of each location from the basepoint in the response."},"example":"MILE"},{"name":"Radius","in":"query","required":false,"description":"This is the radius from the search point in the distance unit you set. For example if you want to search for locations within 50 miles of…","schema":{"type":"integer","description":"This is the radius from the search point in the distance unit you set. For example if you want to search for locations within 50 miles of…"},"example":"25"},{"name":"SupportEMV","in":"query","required":false,"description":"This indicates whether the ATM should have the ability to read chip cards or not.","schema":{"type":"integer","description":"This indicates whether the ATM should have the ability to read chip cards or not."},"example":"1"},{"name":"InternationalMaestroAccepted","in":"query","required":false,"description":"This field will provide ATM Terminals which can still process Maestro transactions but are not yet EMV chip reader enabled. Information…","schema":{"type":"integer","description":"This field will provide ATM Terminals which can still process Maestro transactions but are not yet EMV chip reader enabled. Information…"},"example":"1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-atms-v1-country":{"get":{"operationId":"open_data_mastercard_locations_get_atms_v1_country","summary":"Returns countries with valid ATM locations.","description":"GET /atms/v1/country","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-atms-v1-countrysubdivision":{"get":{"operationId":"open_data_mastercard_locations_get_atms_v1_countrysubdivision","summary":"Returns country subdivisions that have ATM locations. A country subdivision is a segment within a country…","description":"GET /atms/v1/countrysubdivision","tags":["open-data"],"parameters":[{"name":"Country","in":"query","required":true,"description":"Any three digit country code as defined in ISO 3166-1. \"USA\" or \"CAN\"","schema":{"type":"string","description":"Any three digit country code as defined in ISO 3166-1. \"USA\" or \"CAN\""},"example":"USA"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-merchants-v1-category":{"get":{"operationId":"open_data_mastercard_locations_get_merchants_v1_category","summary":"Returns a list of all merchant categories for contactless and cash back merchants (example: Airline, Retail,…","description":"GET /merchants/v1/category","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-merchants-v1-country":{"get":{"operationId":"open_data_mastercard_locations_get_merchants_v1_country","summary":"Returns countries that have Merchants offering the following services: accept contactless-enabled cards and…","description":"GET /merchants/v1/country","tags":["open-data"],"parameters":[{"name":"details","in":"query","required":true,"description":"This is the type of merchant location. Options \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" and \"offers.easysavings\"","schema":{"type":"string","description":"This is the type of merchant location. Options \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" and \"offers.easysavings\""},"example":"acceptance.paypass"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-merchants-v1-countrysubdivision":{"get":{"operationId":"open_data_mastercard_locations_get_merchants_v1_countrysubdivision","summary":"Returns country subdivisions that have Merchants offering the following services: accept contactless-enabled…","description":"GET /merchants/v1/countrysubdivision","tags":["open-data"],"parameters":[{"name":"details","in":"query","required":true,"description":"This is the type of merchant location. Options \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" and \"offers.easysavings\"","schema":{"type":"string","description":"This is the type of merchant location. Options \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" and \"offers.easysavings\""},"example":"topup.repower"},{"name":"country","in":"query","required":true,"description":"Any three digit country code as defined in ISO 3166-1. For example \"USA or \"CAN\"","schema":{"type":"string","description":"Any three digit country code as defined in ISO 3166-1. For example \"USA or \"CAN\""},"example":"USA"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-locations/get-merchants-v1-merchant":{"get":{"operationId":"open_data_mastercard_locations_get_merchants_v1_merchant","summary":"Returns merchant location information for merchants offering the following services: accept…","description":"GET /merchants/v1/merchant","tags":["open-data"],"parameters":[{"name":"Details","in":"query","required":true,"description":"Type of merchant location. Options are \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" \"offers.easysavings\" and…","schema":{"type":"string","description":"Type of merchant location. Options are \"acceptance.paypass\" \"topup.repower\" \"products.prepaidtravelcard\" \"offers.easysavings\" and…"},"example":"acceptance.paypass"},{"name":"PageOffset","in":"query","required":true,"description":"Zero-based offset where the response will start. The actual start position is this value +1. An offset of 10 starts at item 11. Combined…","schema":{"type":"integer","description":"Zero-based offset where the response will start. The actual start position is this value +1. An offset of 10 starts at item 11. Combined…"},"example":"0"},{"name":"PageLength","in":"query","required":true,"description":"Maximum number of items to retrieve within the current \"page\" of results.","schema":{"type":"integer","description":"Maximum number of items to retrieve within the current \"page\" of results."},"example":"5"},{"name":"Category","in":"query","required":false,"description":"Category of the merchant location. See the Categories (Merchant) resource for a list of valid categories. This parameter is only valid for…","schema":{"type":"string","description":"Category of the merchant location. See the Categories (Merchant) resource for a list of valid categories. This parameter is only valid for…"},"example":"features.cashback"},{"name":"AddressLine1","in":"query","required":false,"description":"Line 1 of the street address for the merchant location. Usually includes the street number and name. This parameter is ignored if latitude…","schema":{"type":"string","description":"Line 1 of the street address for the merchant location. Usually includes the street number and name. This parameter is ignored if latitude…"},"example":"42 Elm Street"},{"name":"AddressLine2","in":"query","required":false,"description":"Line 2 of the street address usually an apartment number or suite number. This parameter is used rarely and is ignored if latitude and…","schema":{"type":"string","description":"Line 2 of the street address usually an apartment number or suite number. This parameter is used rarely and is ignored if latitude and…"},"example":"Suite 101"},{"name":"City","in":"query","required":false,"description":"Name of the city for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this parameter…","schema":{"type":"string","description":"Name of the city for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this parameter…"},"example":"New York"},{"name":"CountrySubdivision","in":"query","required":false,"description":"State or province for a merchant location (only supported for US and Canada locations). This parameter is ignored if latitude and…","schema":{"type":"string","description":"State or province for a merchant location (only supported for US and Canada locations). This parameter is ignored if latitude and…"},"example":"NY"},{"name":"PostalCode","in":"query","required":false,"description":"Zip code or postal code for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…","schema":{"type":"string","description":"Zip code or postal code for a merchant location. This parameter is ignored if latitude and longitude are provided. If you provide this…"},"example":"11001"},{"name":"Country","in":"query","required":false,"description":"Any three digit country code for an ATM location. Valid values are Three digit alpha country code as defined in ISO 3166-1. This parameter…","schema":{"type":"string","description":"Any three digit country code for an ATM location. Valid values are Three digit alpha country code as defined in ISO 3166-1. This parameter…"},"example":"USA"},{"name":"Latitude","in":"query","required":false,"description":"Latitude of a merchant location. If latitude is provided longitude must also be provided.","schema":{"type":"number","description":"Latitude of a merchant location. If latitude is provided longitude must also be provided."},"example":"38.53463"},{"name":"Longitude","in":"query","required":false,"description":"Longitude of a merchant location. If longitude is provided latitude must also be provided.","schema":{"type":"number","description":"Longitude of a merchant location. If longitude is provided latitude must also be provided."},"example":"-90.286781"},{"name":"DistanceUnit","in":"query","required":false,"description":"Indicates the unit for the radius as well as the units of the distance of each location from the basepoint in the response.","schema":{"type":"string","description":"Indicates the unit for the radius as well as the units of the distance of each location from the basepoint in the response."},"example":"MILE"},{"name":"Radius","in":"query","required":false,"description":"This is the radius from the search point in the distance unit you set. For example if you want to search for locations within 50 miles of…","schema":{"type":"integer","description":"This is the radius from the search point in the distance unit you set. For example if you want to search for locations within 50 miles of…"},"example":"25"},{"name":"OfferMerchantID","in":"query","required":false,"description":"Unique identifier that represents the merhcant sponsor of an offer. Any valid merchant ID.","schema":{"type":"string","description":"Unique identifier that represents the merhcant sponsor of an offer. Any valid merchant ID."},"example":"34760"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}