{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Card API", "version": "1.0" }, "items": [ { "info": { "name": "Card", "type": "folder" }, "items": [ { "info": { "name": "Delete a Payment Card", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/service-providers/payment-cards/:payment_card_id", "params": [ { "name": "payment_card_id", "value": "83c0711e-1851-4771-950a-055dded7f168", "type": "path", "description": "Unique ID provided in the response while registering a payment card." } ] }, "docs": "Allows a registered Service Provider to delete single Payment Card at a time from its profile. Any data associated with a requested paymentCardId will also be deleted permanently.\n\nOn the successful response from the server, a Service Provider should remove all the requested paymentCardIds from the system.\n\nOnce a request has been received from a Service Provider, data deletion will happen immediately." }, { "info": { "name": "Fetches Historical Transactions and its Transaction Footprints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/payment-cards/:payment_card_id/transaction-footprints", "params": [ { "name": "payment_card_id", "value": "83c0711e-1851-4771-950a-055dded7f168", "type": "path", "description": "Unique ID provided in the response while registering a payment card." }, { "name": "from_date", "value": "2018-05-07", "type": "query", "description": "Start date for searching transaction (Format- YYYY-MM-DD)." }, { "name": "to_date", "value": "2021-05-07", "type": "query", "description": "End date for searching transaction (Format- YYYY-MM-DD)." }, { "name": "offset", "value": "50", "type": "query", "description": "The number of items you need the start of the list to be offset from." }, { "name": "limit", "value": "50", "type": "query", "description": "The number of items you asked the list to be limited to." } ] }, "docs": "Allows a Service Provider to fetch historical transactions for a payment card. Note that a maximum of one year of transactions can be retrieved using this API. Also, the payment card has to be registered first using /payment-cards service." }, { "info": { "name": "Batch Registration of Payment Cards (to be deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/payment-card-enrolments", "body": { "type": "json", "data": "{}" } }, "docs": "Allows a registered Service Provider to add a list of new Payment Cards **(at most maximum of 100 payment cards)** to its profile. This endpoint uses [Mastercard payload encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/#mastercard-encryption). Refer to the [Payload Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encr" }, { "info": { "name": "Delete one or more Payment Cards (to be deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/payment-card-deletions", "body": { "type": "json", "data": "{}" } }, "docs": "Allows a registered Service Provider to delete one or more Payment Cards from its profile. Any data associated with a requested paymentCardId will also be deleted permanently.\n\nOn the successful response from the server, a Service Provider should remove all the requested paymentCardIds from the system.\n\nOnce a request has been received from a Service Provider, data deletion will happen immediately.\n" }, { "info": { "name": "Mastercard Get Sub-merchant Card Acceptor Id Configs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" }, { "name": "acquirer_reference_id", "value": "123456", "type": "query", "description": "BIN that a partner currently services under their portfolio." }, { "name": "card_acceptor_id", "value": "card_acceptor1", "type": "query", "description": "Identifies the card acceptor ID assigned by the acquirer. This ID must represent a unique identifier for each merchant name/location within the acquirer BIN." }, { "name": "offset", "value": "25", "type": "query", "description": "Number of items per page" }, { "name": "page_number", "value": "1", "type": "query", "description": "Current page number" } ] }, "docs": "Returns sub-merchant card acceptor id config details." }, { "info": { "name": "Mastercard Create Sub-merchant Card Acceptor Id Config.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns created sub-merchant card acceptor id config details." }, { "info": { "name": "Mastercard Delete Sub-merchant Card Acceptor Id Config.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-ids", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" }, { "name": "merchant_identifier_config_id", "value": "88ca4b15-72a6-41dd-8127-573d4b07875c", "type": "query", "description": "The Configuration ID for acquirer reference ID or card acceptor ID or card acceptor name configurations." } ] }, "docs": "Returns 200 if sub-merchant card acceptor id configs gets deleted." }, { "info": { "name": "Mastercard Get Sub-merchant Card Acceptor Name Configs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-names", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" }, { "name": "card_acceptor_name", "value": "Acceptor 1", "type": "query", "description": "A sub-element of the merchant descriptor that contains the merchant's name or doing business as name as it appears on the cardholder's billing statement." }, { "name": "offset", "value": "25", "type": "query", "description": "Number of items per page" }, { "name": "page_number", "value": "1", "type": "query", "description": "Current page number" } ] }, "docs": "Returns sub-merchant card acceptor name config details." }, { "info": { "name": "Mastercard Create Sub-merchant Card Acceptor Name Config.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-names", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns created sub-merchant card acceptor name config details." }, { "info": { "name": "Mastercard Delete Sub-merchant Card Acceptor Name Config.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/card-acceptor-names", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "member_id", "value": "99ca4b15-72a6-41dd-8127-573d4b07669c", "type": "path", "description": "Merchant member ID (parent of the sub-merchant)" }, { "name": "sub_merchant_id", "value": "cc2cac41-d127-4c06-9646-c0f2ad76c444", "type": "path", "description": "Sub-merchant member ID" }, { "name": "merchant_identifier_config_id", "value": "88ca4b15-72a6-41dd-8127-573d4b07875c", "type": "query", "description": "The Configuration ID for acquirer reference ID or card acceptor ID or card acceptor name configurations." } ] }, "docs": "Returns 200 if sub-merchant card acceptor name configs gets deleted." }, { "info": { "name": "Mastercard Get Card Acceptor Names", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/card-acceptor-names", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "guid", "value": "jK2dA5aybhQQBq6C", "type": "path", "description": "Consumer Clarity internal merchant's GUID" }, { "name": "location_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of location" }, { "name": "offset", "value": "", "type": "query", "description": "The number of items to skip before starting to collect the result set" }, { "name": "page_number", "value": "2", "type": "query", "description": "current page number" }, { "name": "sort_direction", "value": "", "type": "query", "description": "Direction to sort the data using sort_field in response" }, { "name": "sort_field", "value": "modifiedDateTime", "type": "query", "description": "Field to Sort data in response" }, { "name": "search_text", "value": "Test", "type": "query", "description": "Input field used as wild search against Card Acceptor. \nThe service searches for substring, following the %search_text% pattern.\n" } ] }, "docs": "Returns Card Acceptor Names with pagination metadata" }, { "info": { "name": "Mastercard Add Card Acceptor Names", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/card-acceptor-names", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "guid", "value": "jK2dA5aybhQQBq6C", "type": "path", "description": "Consumer Clarity internal merchant's GUID" }, { "name": "location_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of location" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates card acceptor names under a location of an existing sub-merchant" }, { "info": { "name": "Mastercard Get Card Acceptor Name by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/card-acceptor-names/:id", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "guid", "value": "jK2dA5aybhQQBq6C", "type": "path", "description": "Consumer Clarity internal merchant's GUID" }, { "name": "location_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of location" }, { "name": "id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of the card acceptor name." } ] }, "docs": "Returns card acceptor name object" }, { "info": { "name": "Mastercard Update Card Acceptor Name by Id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/card-acceptor-names/:id", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" }, { "name": "If-Match", "value": "\"842DFBC17F921E7716642B9164F3B22B\"" } ], "params": [ { "name": "guid", "value": "jK2dA5aybhQQBq6C", "type": "path", "description": "Consumer Clarity internal merchant's GUID" }, { "name": "location_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of location" }, { "name": "id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of the card acceptor name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates card acceptor name object" }, { "info": { "name": "Mastercard Delete Existing Card Acceptor Name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/card-acceptor-names/:id", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "params": [ { "name": "guid", "value": "jK2dA5aybhQQBq6C", "type": "path", "description": "Consumer Clarity internal merchant's GUID" }, { "name": "location_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of location" }, { "name": "id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of the card acceptor name." } ] }, "docs": "Returns 204 status code if Card Acceptor Name deleted successfully" }, { "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": "Retrieve a list of all virtual cards linked to a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" } ] }, "docs": "This endpoint allows users to retrieve a list of all virtual cards linked to a user" }, { "info": { "name": "Register a virtual card linked to a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows users to register a virtual card linked to a user" }, { "info": { "name": "Retrieve virtual card account details linked to a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" } ] }, "docs": "This endpoint allows users to retrieve virtual card account details linked to a user" }, { "info": { "name": "Update virtual card account details linked to a user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows users to update virtual card account details linked to a user" }, { "info": { "name": "Delete a virtual card account linked to a user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" } ] }, "docs": "This endpoint allows users to delete a virtual card account linked to a user" }, { "info": { "name": "Delete all virtual cards linked to a real card", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/real-card-accounts/:account_guid", "params": [ { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" } ] }, "docs": "This endpoint allows users to delete all virtual cards linked to a real card account_guid" }, { "info": { "name": "Register a token linked to a user and a virtual card", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid/tokens", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows users to register a token linked to a user and a virtual card" }, { "info": { "name": "Retrieve token details linked to a user and a virtual card", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid/tokens/:token_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" }, { "name": "token_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the token being queried" } ] }, "docs": "This endpoint allows users to retrieve token details linked to a user and a virtual card" }, { "info": { "name": "Update a token linked to a user and a virtual card", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid/tokens/:token_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" }, { "name": "token_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the token being queried" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows users to update a token linked to a user and a virtual card" }, { "info": { "name": "Delete a token linked to a user and a virtual card", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_guid/virtual-card-accounts/:account_guid/tokens/:token_guid", "params": [ { "name": "user_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the user being queried" }, { "name": "account_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the card being queried" }, { "name": "token_guid", "value": "8f242496-b71a-11eb-8529-0242ac130003", "type": "path", "description": "The globally unique identifier of the token being queried" } ] }, "docs": "This endpoint allows users to delete a token linked to a user and a virtual card" } ] } ], "bundled": true }