{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:mastercard-personalized-loyalty-offers/post-activatestatementcreditoffer":{"post":{"operationId":"open_data_mastercard_personalized_loyalty_offers_post_activatestatementcreditoffer","summary":"Make Statement Credit Offer Available Redeemable","description":"POST /activatestatementcreditoffer","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FId","UserToken","OfferId"],"properties":{"FId":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"UserToken":{"type":"string","description":"Session identifier as returned by the UserToken resource."},"OfferId":{"type":"string","description":"System-wide identifier for the campaign, not intended for end-user display."}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:mastercard-personalized-loyalty-offers/get-matchedoffers":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_matchedoffers","summary":"Returns Matched Offers","description":"GET /matchedoffers","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"UserToken","in":"query","required":true,"description":"Session identifier as returned by the UserToken resource.","schema":{"type":"string","description":"Session identifier as returned by the UserToken resource."}},{"name":"Lang","in":"query","required":false,"description":"When utilized with a multi-lingual implementation, may be the tongue and country of the user in ISO 639-1, underscore, ISO 3166-1 alpha-2…","schema":{"type":"string","description":"When utilized with a multi-lingual implementation, may be the tongue and country of the user in ISO 639-1, underscore, ISO 3166-1 alpha-2…"},"example":"en_US"},{"name":"MerchantName","in":"query","required":false,"description":"Fuzzy term to search retailers with offers for the user. In general, searching of Matched Offers is not advised as users generally have a…","schema":{"type":"string","description":"Fuzzy term to search retailers with offers for the user. In general, searching of Matched Offers is not advised as users generally have a…"},"example":"Example.com"},{"name":"Category","in":"query","required":false,"description":"Offer Categories.","schema":{"type":"string","description":"Offer Categories."},"example":"DEPARTMENTSTORE"},{"name":"OfferType","in":"query","required":false,"description":"The kind of deal. POSTPAIDCREDIT- Statement Credit Offer, which is a discount that is automatically applied to the card linked to the user…","schema":{"type":"string","description":"The kind of deal. POSTPAIDCREDIT- Statement Credit Offer, which is a discount that is automatically applied to the card linked to the user…"},"example":"POSTPAIDCREDIT"},{"name":"PageNumber","in":"query","required":false,"description":"Segment of offers to return.","schema":{"type":"integer","description":"Segment of offers to return."},"example":1},{"name":"ItemsPerPage","in":"query","required":false,"description":"Segment size of offer to be returned. Default is 25.","schema":{"type":"integer","description":"Segment size of offer to be returned. Default is 25."},"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-personalized-loyalty-offers/get-offerdetails":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_offerdetails","summary":"Returns Information on an Offer","description":"GET /offerdetails","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"UserToken","in":"query","required":true,"description":"Session identifier as returned by the UserToken resource.","schema":{"type":"string","description":"Session identifier as returned by the UserToken resource."},"example":"mh3WonUm5xmE"},{"name":"OfferId","in":"query","required":true,"description":"System-wide identifier for the campaign, not intended for end-user display.","schema":{"type":"string","description":"System-wide identifier for the campaign, not intended for end-user display."},"example":"c7dcfca7-cf35-36b0-9e67-d4f363d643e0"}],"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-personalized-loyalty-offers/get-redeemedoffers":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_redeemedoffers","summary":"Returns Redeemed Offers","description":"GET /redeemedoffers","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"UserToken","in":"query","required":true,"description":"Session identifier as returned by the UserToken resource.","schema":{"type":"string","description":"Session identifier as returned by the UserToken resource."}},{"name":"Lang","in":"query","required":false,"description":"When utilized with a multi-lingual implementation, may be the tongue and country of the user in ISO 639-1, underscore, ISO 3166-1 alpha-2…","schema":{"type":"string","description":"When utilized with a multi-lingual implementation, may be the tongue and country of the user in ISO 639-1, underscore, ISO 3166-1 alpha-2…"},"example":"en_US"},{"name":"PageNumber","in":"query","required":false,"description":"Segment of offers to return.","schema":{"type":"integer","description":"Segment of offers to return."},"example":1},{"name":"ItemsPerPage","in":"query","required":false,"description":"Segment size of offer to be returned. Default is 25.","schema":{"type":"integer","description":"Segment size of offer to be returned. Default is 25."},"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-personalized-loyalty-offers/get-statementcreditactivationdetail":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_statementcreditactivationdetail","summary":"Returns Information About Redeemable Postpaid Credit Offer","description":"GET /statementcreditactivationdetail","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"UserToken","in":"query","required":true,"description":"Session identifier as returned by the UserToken resource.","schema":{"type":"string","description":"Session identifier as returned by the UserToken resource."}},{"name":"ActivationId","in":"query","required":true,"description":"Distinct identifier for the offer being available for redemption by the user as returned by Activate Statement Credit Offer or Redeemed…","schema":{"type":"string","description":"Distinct identifier for the offer being available for redemption by the user as returned by Activate Statement Credit Offer or Redeemed…"},"example":"TRU_1000136"}],"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-personalized-loyalty-offers/post-userfeedback":{"post":{"operationId":"open_data_mastercard_personalized_loyalty_offers_post_userfeedback","summary":"Provide User Feedback on Offer","description":"POST /userfeedback","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FId","UserToken","OfferId","Feedback"],"properties":{"FId":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"UserToken":{"type":"string","description":"Session identifier as returned by the UserToken resource."},"OfferId":{"type":"string","description":"System-wide identifier for the campaign, not intended for end-user display."},"Feedback":{"type":"integer","description":"User response to the offer. 0- Dislike offer. 1- Like offer."}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:mastercard-personalized-loyalty-offers/get-usersavings":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_usersavings","summary":"Returns Savings for the User","description":"GET /usersavings","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"UserToken","in":"query","required":true,"description":"Session identifier as returned by the UserToken resource.","schema":{"type":"string","description":"Session identifier as returned by the UserToken resource."}}],"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-personalized-loyalty-offers/get-usertoken":{"get":{"operationId":"open_data_mastercard_personalized_loyalty_offers_get_usertoken","summary":"Returns User Session Token","description":"GET /usertoken","tags":["open-data"],"parameters":[{"name":"FId","in":"query","required":true,"description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.","schema":{"type":"string","description":"Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation."},"example":"999999"},{"name":"AuthInfo","in":"query","required":true,"description":"Authorization Information. AES 128-bit encrypted concatenation of \"User ID as specified in enrollment:FI ID as provided by…","schema":{"type":"string","description":"Authorization Information. AES 128-bit encrypted concatenation of \"User ID as specified in enrollment:FI ID as provided by…"}}],"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"}}}}}}}