{"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-masterpassqr/create-merchant-transfer":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_merchant_transfer","summary":"Initiates a Mastercard Merchant Presented QR purchase transaction by securing funds from a consumer’s…","description":"POST /send/","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId","body"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special [a-zA-Z0-9_-], Length: 32"},"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-masterpassqr/get-merchant-transfer-by-ref":{"get":{"operationId":"open_data_mastercard_masterpassqr_get_merchant_transfer_by_ref","summary":"Purpose of this service is to retrieve the Transfer resource associated with a specified transfer_reference…","description":"GET /send/","tags":["open-data"],"parameters":[{"name":"partnerId","in":"query","required":true,"description":"Path Param - Provider assigned partner id. Details - string, 32","schema":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"}},{"name":"ref","in":"query","required":true,"description":"Query Param - Is the client specified transfer reference when initiating the transfer. Allowable characters are alphanumeric and * , - . _…","schema":{"type":"string","description":"Query Param - Is the client specified transfer reference when initiating the transfer. Allowable characters are alphanumeric and * , - . _…"}}],"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-masterpassqr/create-merchant-payment":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_merchant_payment","summary":"Initiates a Mastercard Merchant Presented QR purchase transaction by pushing funds to a merchant account.","description":"POST /send/","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"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-masterpassqr/create-merchant-refund":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_merchant_refund","summary":"Initiates a Mastercard Merchant Presented QR Refund transaction by pushing funds from a merchant account…","description":"POST /send/","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"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-masterpassqr/get-merchant-transfer-by-id":{"get":{"operationId":"open_data_mastercard_masterpassqr_get_merchant_transfer_by_id","summary":"Purpose of this service is to retrieve the Transfer resource associated with the specified transfer-id.","description":"GET /send/","tags":["open-data"],"parameters":[{"name":"partnerId","in":"query","required":true,"description":"Path Param - Provider assigned partner id. Details - string, 32","schema":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"}},{"name":"transferId","in":"query","required":true,"description":"Path Param - Valid transfer id","schema":{"type":"string","description":"Path Param - Valid transfer id"}}],"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-masterpassqr/create-funding-reversal":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_funding_reversal","summary":"Funding Reversals must be submitted within 30 minutes of the funding transfer request, and should only be…","description":"POST /send/v1/partners/{partner-id}/transfers/{transfer-id}/transactions/{transaction-id}/reversals","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partner-id","transfer-id","transaction-id"],"properties":{"partner-id":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"transfer-id":{"type":"string","description":"Valid transfer id"},"transaction-id":{"type":"string","description":"Valid transaction id"},"body":{"type":"string","description":"XML request body (string)"}}}}}},"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-masterpassqr/send-notification-payment-retry":{"post":{"operationId":"open_data_mastercard_masterpassqr_send_notification_payment_retry","summary":"Client can simulate a Mastercard Merchant Presented QR Payment notification to the registered URL endpoint.","description":"POST /send/v1/partners/{partnerId}/events/generate/payment","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"body":{"type":"string","description":"XML request body (string)"}}}}}},"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-masterpassqr/send-notification-refund-retry":{"post":{"operationId":"open_data_mastercard_masterpassqr_send_notification_refund_retry","summary":"Client can simulate a Mastercard Merchant Presented QR Refund notification to the registered URL endpoint.","description":"POST /send/v1/partners/{partnerId}/events/generate/refund","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"body":{"type":"string","description":"XML request body (string)"}}}}}},"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-masterpassqr/create-transfer-notification-registration":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_transfer_notification_registration","summary":"This service allows Mastercard Merchant QR originating and receiving partners to register a PAN and service…","description":"POST /send/v1/partners/{partnerId}/notification-registries","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40"},"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-masterpassqr/notification-registration-apiread-by":{"get":{"operationId":"open_data_mastercard_masterpassqr_notification_registration_apiread_by","summary":"This service allows Mastercard Merchant QR originating and receiving partners to retrieve the service…","description":"GET /send/v1/partners/{partnerId}/notification-registries/{account-reg-ref}","tags":["open-data"],"parameters":[{"name":"partnerId","in":"query","required":true,"description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40","schema":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40"},"example":"ptnr_A37V2q91WUqSonkfEG29Q-Bf4s9"},{"name":"account-reg-ref","in":"query","required":true,"description":"Path Param - System generated unique account registration identifier. Type: Alphanumberic Special Length: 40","schema":{"type":"string","description":"Path Param - System generated unique account registration identifier. Type: Alphanumberic Special Length: 40"},"example":"areg_GDVUiwh1bXzA_xVdDXn4ctJEKOF"}],"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-masterpassqr/notification-registration-apiupdate":{"post":{"operationId":"open_data_mastercard_masterpassqr_notification_registration_apiupdate","summary":"This service allows Mastercard Merchant QR originating and receiving partners to update the notitification…","description":"PUT /send/v1/partners/{partnerId}/notification-registries/{account-reg-ref}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId","account-reg-ref"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40"},"account-reg-ref":{"type":"string","description":"Path Param - System generated unique account registration identifier. Type: Alphanumeric Special Length: 40"},"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-masterpassqr/delete-transfer-notification-registration":{"post":{"operationId":"open_data_mastercard_masterpassqr_delete_transfer_notification_registration","summary":"This service allows Mastercard Merchant QR originating and receiving partners to delete a registered PAN for…","description":"DELETE /send/v1/partners/{partnerId}/notification-registries/{account-reg-ref}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId","account-reg-ref"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special Length: 40"},"account-reg-ref":{"type":"string","description":"Path Param - System generated unique account registration identifier. Type: Alphanumeric Special Length: 40"}}}}}},"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-masterpassqr/create-funding":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_funding","summary":"The Funding Transaction enables the 'pull' of money from the sender's card to the Transaction Originator who…","description":"POST /send/v1/partners/{partnerId}/transfers/funding","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"body":{"type":"string","description":"XML request body (string)"}}}}}},"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-masterpassqr/create-digital-accnt-ref-num":{"post":{"operationId":"open_data_mastercard_masterpassqr_create_digital_accnt_ref_num","summary":"Used to create a digital account reference number from Incontrol","description":"POST /send/v1/{partnerId}/digital-account","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Type: Alphanumeric Special [a-zA-Z0-9_-], Length: 32"},"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-masterpassqr/retrieve-digital-accnt-ref-num-list":{"post":{"operationId":"open_data_mastercard_masterpassqr_retrieve_digital_accnt_ref_num_list","summary":"Used to retreive a digital account reference list from Incontrol","description":"POST /send/v1/{partnerId}/digital-account/search","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partnerId"],"properties":{"partnerId":{"type":"string","description":"Path Param - Provider assigned partner id. Details - string, 32"},"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"}}},"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"}}}}}}}