{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Donor API", "version": "1.0" }, "items": [ { "info": { "name": "Donor", "type": "folder" }, "items": [ { "info": { "name": "Get Donor API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/donors/:donor_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "This API will be used for fetching user on platform. Entire response body is encrypted and it should be decrypted to view the actual response." }, { "info": { "name": "Update Donor API", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/donors/:donor_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API will be used for updating user on platform. Entire request body should be encrypted." }, { "info": { "name": "Delete Donor API", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/donors/:donor_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "This API will be used for deleting user on platform" }, { "info": { "name": "Get All Cards API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/donors/:donor_id/cards", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "Fetches all the cards for given donor. Entire response body is encrypted and it should be decrypted to view the actual response." }, { "info": { "name": "Add Card API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/donors/:donor_id/cards", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Donor can add his/her card onto platform by calling this API, so that next time he/she wants to donate, he/she don't have to provide card details.A card will be added once. Second time, the initial card Id will be returned.Entire request body should be encrypted." }, { "info": { "name": "Search Card API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/donors/:donor_id/cards/searches", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search card by pan or user id passed. Entire request body should be encrypted." }, { "info": { "name": "Retrieve Card API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/donors/:donor_id/cards/:card_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "card_id", "value": "", "type": "path", "description": "card_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "Retrieves card by card id passed. Entire response body is encrypted and it should be decrypted to view the actual response." }, { "info": { "name": "Update Card API", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/donors/:donor_id/cards/:card_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "card_id", "value": "", "type": "path", "description": "card_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Donor can update his/her already added card by providing new card informatin along with cardId. Entire request body should be encrypted." }, { "info": { "name": "Delete Card API", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/donors/:donor_id/cards/:card_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "card_id", "value": "", "type": "path", "description": "card_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "Donor can delete his/her saved card from Donation platform." }, { "info": { "name": "Get All Recurring Donation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/donors/:donor_id/setups", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" }, { "name": "limit", "value": "", "type": "query", "description": "limit" }, { "name": "offset", "value": "", "type": "query", "description": "offset" } ] }, "docs": "Fetches the setup Ids pertaining to a donor" }, { "info": { "name": "Setup Donation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/donors/:donor_id/setups", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Setup Monthly, Micro or Round-Up donation for a registered user. Encrypting request body is not required." }, { "info": { "name": "Get Recurring Donation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donation_setup_id", "value": "", "type": "path", "description": "donation_setup_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "Retrieve donation setup details by setupid" }, { "info": { "name": "Update Recurring Donation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donation_setup_id", "value": "", "type": "path", "description": "donation_setup_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Monthly, Micro or Round-up donation for a registered user. Encrypting request body is not required." }, { "info": { "name": "Delete Recurring Donation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donation_setup_id", "value": "", "type": "path", "description": "donation_setup_id" }, { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" } ] }, "docs": "Delete Monthly, Micro or Round-up donation for a registered user" }, { "info": { "name": "Donation History API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/donors/:donor_id/transactions", "headers": [ { "name": "x-openapi-clientid", "value": "" }, { "name": "x-correlation-id", "value": "" }, { "name": "ProgramId", "value": "" } ], "params": [ { "name": "donor_id", "value": "", "type": "path", "description": "donor_id" }, { "name": "limit", "value": "", "type": "query", "description": "limit" }, { "name": "offset", "value": "", "type": "query", "description": "offset" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get Donation History based on given request.\"cardID\", \"charityID\" and \"donationType\" are optional fields. If a Micro donation is setup, it won't show up in Donation History until the end of the month when the transaction happen. Encrypting request body is not required." } ] } ], "bundled": true }