openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 9.43 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"name":"openapi@mastercard.com"},"description":"Mastercard ABU API","license":{"name":"Mastercard","url":"http://www.mastercard.com"},"title":"MasterCard ABU API","version":"1.1.0","x-artifactId":"maws","x-origin":[{"format":"swagger","url":"https://developer.mastercard.com/devzone/api/portal/swagger/automatic-billing-updater-abu","version":"2.0"}],"x-providerName":"mastercard.com","x-serviceName":"MAWS"},"paths":{"/v1/maws":{"post":{"description":"<ul>\n <li>Pull model:\n \n To receive information for a given PAN, the customer sends a request and will receive a response with the most up to date information.\n In this page, customers can execute samples of requests to explore the pattern of the API responses. However, once the customer decides to start using the SDK, it is necessary to be fully onboarded to ABU API Pull model.\n </li>\n \n <li>Push model:\n \n Customers can choose to automatically receive ABU account update notifications on a designated endpoint. This means that a customer can subscribe to each PAN in order to receive updates, so that when these PANs have any changes, the customer will receive the updates via notifications on the designated endpoint.\n Different fields on the API are mandatory to use this model.In order to complete a full end-to-end test scenario (including the notifications), it is necessary to be fully onboarded on ABU API Push model:\n - An endpoint provided by the customer must be registered with Mastercard so that notifications can be pro-actively sent out to the customer.\n - A certificate provided by Mastercard representative must be used by the customer to receive notifications on the designated endpoint.\n \n * For customers who are already enrolled to ABU API Pull model and want to start using ABU API Push model, it is necessary to perform a technical enrollment that involves a certificate exchange and must be registered as an ABU API Push model user.\n \n For more details on how to proceed with onboarding for ABU API push model contact abu_push_onboarding@mastercard.com.Note: This email is for ABU API push onboarding only. For general ABU API inquiry questions contact api_support@mastercard.com and for general ABU questions contact abu_helpdesk@mastercard.com.\n </li>\n</ul>","operationId":"abuPost","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ABU"}}},"description":"Request for ABU API","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuResponse"}}}},"400":{"description":"Possible causes: Validation failure or System error."},"401":{"description":"Possible causes: ClientID not provisioned. "},"500":{"description":"System error."}},"summary":"Access methods for merchants to ABU program.","tags":["ABU"],"x-action":"post","x-samples":[{"name":"ABU_sample_request","request":{"application/json":"{\n \"jsonrpc\":\"2.0\",\n \"method\":\"abu\",\n \"params\": {\n \"merchantId\":\"000111222333456\",\n \"ica\": \"1111\",\n \"oldAccountNumber\":\"5573491171027315\",\n \"oldExpirationDate\":\"0714\",\n \"discretionaryData\":\"RandomData\",\n \"subMerchantId\":\"000000000000001\",\n \"subscribe\":\"subscribe\"\n },\n \"id\":\"a1234567890\"\n}"},"response":{"application/json":"{\n \"jsonrpc\": \"2.0\",\n \"id\": \"a1234567890\",\n \"result\": {\n \"merchantId\": \"000111222333456\",\n \"ica\": \"1111\",\n \"oldAccountNumber\": \"5573491171027315\",\n \"oldExpirationDate\": \"0714\",\n \"discretionaryData\": \"RandomData\",\n \"subMerchantId\": \"000000000000001\",\n \"newAccountNumber\": \"5573491171027315\",\n \"newExpirationDate\": \"0318\",\n \"reasonIdentifier\": \"EXPIRY\",\n \"subscriptionIndicator\":\"S\",\n \"subscriptionIdentifier\":\"Successfully subscribed\"\n },\n \"status\": true\n}"}}]}}},"servers":[{"url":"https://api.mastercard.com/maws"}],"components":{"schemas":{"ABU":{"properties":{"id":{"description":"An identifier established by the Client that MUST contain a String, Number, or NULL value if included.","example":"a1234567890","type":"string","x-explorer":true},"jsonrpc":{"description":"A String specifying the version of the JSON-RPC protocol. MUST be exactly \"2.0\".","example":"2.0","type":"string","x-explorer":true},"method":{"description":"A String containing the name of the method to be invoked.","example":"abu","type":"string","x-explorer":true},"params":{"$ref":"#/components/schemas/AbuDTO"}},"required":["method","id","params"],"type":"object"},"AbuDTO":{"properties":{"discretionaryData":{"description":"Optional data that can be used by the requested for matching to the original inquiry.","example":"RandomData","maxLength":10,"minLength":0,"type":"string","x-explorer":true},"ica":{"description":"[This field is required when the multiple ICAs are registered under the same client key.]Data that can be used to inform the ICA number: Interbank Card Association.","example":"1111","maxLength":11,"minLength":0,"type":"string","x-explorer":true},"merchantId":{"description":"Registered merchant ID that is mapped to the Customer ID.","example":"000111222333456","maxLength":15,"minLength":15,"type":"string","x-explorer":true},"oldAccountNumber":{"description":"Account number on file provided by merchant.","example":"5573491171027312","maxLength":19,"minLength":16,"type":"string","x-explorer":true},"oldExpirationDate":{"description":"Account number expiration date on file provided by merchant that must be in MMYY format.","example":"0714","maxLength":4,"minLength":4,"type":"string","x-explorer":true},"subMerchantId":{"description":"Optionally populated when the merchant ID is actually a previously populated payment facilitator or payment aggregator.","example":"000000000000001","maxLength":15,"minLength":15,"type":"string","x-explorer":true},"subscribe":{"description":"[Field used by Push Model only - REQUIRED]Optional data that can be used to subscribe, un-subscribe or query subscription status for PAN updates. Valid values are \"subscribe\", \"un-subscribe\" and \"query\".","example":"subscribe","maxLength":12,"minLength":0,"type":"string","x-explorer":true}},"required":["merchantId","oldAccountNumber","oldExpirationDate"],"type":"object"},"AbuResponse":{"properties":{"id":{"description":"An identifier established by the Client that MUST contain a String, Number, or NULL value if included.","example":"a1234567890","type":"string"},"jsonrpc":{"description":"A String specifying the version of the JSON-RPC protocol. MUST be exactly \"2.0\".","example":"2.0","type":"string"},"result":{"$ref":"#/components/schemas/AbuResultDTO"},"status":{"description":"The Service Status, success (true) or failure (false).","example":true,"type":"boolean"}},"type":"object"},"AbuResultDTO":{"properties":{"discretionaryData":{"description":"Discretionary data as in the request.","example":"RandomData","maxLength":10,"minLength":0,"type":"string"},"ica":{"description":"ICA number as in the request.","example":"1111","maxLength":11,"minLength":0,"type":"string","x-explorer":true},"merchantId":{"description":"Merchant ID as in the request.","example":"000111222333456","maxLength":15,"minLength":15,"type":"string"},"newAccountNumber":{"description":"New account number.","example":"5573491171027318","maxLength":19,"minLength":16,"type":"string"},"newExpirationDate":{"description":"New account number expiration date, in MMYY format.","example":"1218","maxLength":4,"minLength":4,"type":"string"},"oldAccountNumber":{"description":"Account number on file as in the request.","example":"5573491171027318","maxLength":19,"minLength":16,"type":"string"},"oldExpirationDate":{"description":"Expiration date on file as in the request.","example":"0714","maxLength":4,"minLength":4,"type":"string"},"reasonIdentifier":{"description":"Response Type based on requested account.","example":"EXPIRY","maxLength":6,"type":"string"},"responseIndicator":{"description":"One character additional data, returned bases on reasonIdentifier.(Note- ResponseIndicator displayed only when ReasonIdentifier is VALID or UNKNWN)","example":"P","maxLength":1,"minLength":1,"type":"string"},"subMerchantId":{"description":"SubMerchantID as in the request.","example":"000000000000001","maxLength":15,"minLength":15,"type":"string"},"subscriptionIdentifier":{"description":"[Field used by Push Model only] Response Type based on the status of subscribe/un-subscribe or query subscription status for PAN.","example":"Successfully subscribed","maxLength":70,"type":"string"},"subscriptionIndicator":{"description":"[Field used by Push Model only] One character additional data, returned based on subscriptionIdentifier:<ul><li>\"S\" for success</li><li>\"F\" for failures</li><li>\"T\" for token results.</li></ul>","example":"S","maxLength":1,"minLength":1,"type":"string"}},"type":"object"}}}}