{"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-match/post-fraud-merchant-v3-add-merchant":{"post":{"operationId":"open_data_mastercard_match_post_fraud_merchant_v3_add_merchant","summary":"Used by Acquirers to add a terminated a merchant in the MATCH system. Merchant information, and up to five…","description":"POST /fraud/merchant/v3/add-merchant","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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-match/post-fraud-merchant-v3-common-contact-details":{"post":{"operationId":"open_data_mastercard_match_post_fraud_merchant_v3_common_contact_details","summary":"Returns the contact information for the acquirer id requested. When MATCH returns a possible merchant match,…","description":"POST /fraud/merchant/v3/common/contact-details","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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-match/post-fraud-merchant-v3-retro-retro-inquiry-details":{"post":{"operationId":"open_data_mastercard_match_post_fraud_merchant_v3_retro_retro_inquiry_details","summary":"Returns detailed information about Merchants, URLs and up to five principal owners, that have been…","description":"POST /fraud/merchant/v3/retro/retro-inquiry-details","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AcquirerId","body"],"properties":{"AcquirerId":{"type":"string","description":"The Member ICA number which is used to validate that the application has permission to hit the MATCH database. This number must be…"},"body":{"type":"object","description":"JSON request body"}}}}}},"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-match/post-fraud-merchant-v3-retro-retro-list":{"post":{"operationId":"open_data_mastercard_match_post_fraud_merchant_v3_retro_retro_list","summary":"Returns the summary of Retro matches for the given Acquirer Id. This resource will return the summary of…","description":"POST /fraud/merchant/v3/retro/retro-list","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"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-match/post-fraud-merchant-v3-termination-inquiry":{"post":{"operationId":"open_data_mastercard_match_post_fraud_merchant_v3_termination_inquiry","summary":"Returns information on merchants that have been terminated and merchants that have inquired upon. Provides…","description":"POST /fraud/merchant/v3/termination-inquiry","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageOffset","PageLength","body"],"properties":{"PageOffset":{"type":"number","description":"The zero-based offset to start at. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the…"},"PageLength":{"type":"number","description":"The maximum number of items to retrieve within the current \"page\" of results."},"body":{"type":"object","description":"JSON request body"}}}}}},"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-match/get-fraud-merchant-v3-termination-inquiry-irn":{"get":{"operationId":"open_data_mastercard_match_get_fraud_merchant_v3_termination_inquiry_irn","summary":"Returns information about Merchants, URLs and up to five principal owners, that have been terminated by an…","description":"GET /fraud/merchant/v3/termination-inquiry/{IRN}","tags":["open-data"],"parameters":[{"name":"PageOffset","in":"query","required":true,"description":"The zero-based offset to start at. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the…","schema":{"type":"number","description":"The zero-based offset to start at. The actual start position is this value +1. An offset of 10 starts at item 11. Combined with the…"},"example":0},{"name":"PageLength","in":"query","required":true,"description":"The maximum number of items to retrieve within the current \"page\" of results.","schema":{"type":"number","description":"The maximum number of items to retrieve within the current \"page\" of results."},"example":10},{"name":"AcquirerId","in":"query","required":true,"description":"The Member ICA number which is used to validate that the application has permission to hit the MATCH database. This number must be…","schema":{"type":"string","description":"The Member ICA number which is used to validate that the application has permission to hit the MATCH database. This number must be…"},"example":1996},{"name":"IRN","in":"query","required":true,"description":"Inquiry Reference Number (IRN) A unique identifier generated by the MATCH system that is returned in the original, previously submitted…","schema":{"type":"string","description":"Inquiry Reference Number (IRN) A unique identifier generated by the MATCH system that is returned in the original, previously submitted…"},"example":19962016070500348}],"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"}}}}}}}