{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Guid API", "version": "1.0" }, "items": [ { "info": { "name": "Guid", "type": "folder" }, "items": [ { "info": { "name": "Mastercard Get the Logo for an Existing Merchant.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/merchants/:guid/logos", "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" } ] }, "docs": "Returns base64 encoded image, status and messages (if any validation failures) related to the logo of a sub-merchant." }, { "info": { "name": "Mastercard Create a Logo for an Existing Merchant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/merchants/:guid/logos", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns status and messages (if any validation failures) related to the logo of a sub-merchant." }, { "info": { "name": "Mastercard Update a Logo for an Existing Merchant.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/merchants/:guid/logos", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns status and messages (if any validation failures) related to the logo of a sub-merchant." }, { "info": { "name": "Mastercard Delete a Logo for an Existing Merchant.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/merchants/:guid/logos", "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" } ] }, "docs": "Returns 204 status code if logo deleted successfully." }, { "info": { "name": "Mastercard Get Sub-merchant by Guid.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid", "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" } ] }, "docs": "Returns sub-merchant object with status." }, { "info": { "name": "Mastercard Update a Sub-merchant.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sub-merchants/:guid", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns sub-merchant object with status." }, { "info": { "name": "Mastercard Activate/deactivate a Sub-merchant.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sub-merchants/:guid/states", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns 204 if merchant is activated/deactivated successfully. It takes a state attribute with two possible values:\n\n - INACTIVE\n - For LIVE and LOCKED_FOR_EDIT merchants, this endpoint changes the merchant to INACTIVE status.\n - For CONFIGURATION merchants, it physically deletes the merchant, rather than deactivating it.\n\n - ACTIVE\n - Reactivates an INACTIVE merchant by placing it in CONFIGURATION status. From there, the flow follows the onboarding process where the merchant is in CO" }, { "info": { "name": "Mastercard Get Sub-merchant's Locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid/locations", "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": "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": "Toronto", "type": "query", "description": "Input field used as wild search in region/city/country like regex %search_text%" } ] }, "docs": "Returns sub-merchant's locations with pagination metadata" }, { "info": { "name": "Mastercard Add a Unique Set of Sub-merchant's Locations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sub-merchants/:guid/locations", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates locations under an existing sub-merchant" }, { "info": { "name": "Mastercard Get Location by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_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" } ] }, "docs": "Returns location object" }, { "info": { "name": "Mastercard Update an Existing Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a location object" }, { "info": { "name": "Mastercard Delete an Existing Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_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" } ] }, "docs": "Returns 204 status code if Location deleted successfully" }, { "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": "Mastercard Get Accepted Acquirer Reference Id and Card Acceptor Id Pairs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/acquirer-merchant-ids", "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": "acquirerReferenceId", "type": "query", "description": "Field to Sort data in response" }, { "name": "search_text", "value": "Test", "type": "query", "description": "Input field used as wild search against Acquirer Reference ID and Card Acceptor\nID. The service searches for substring, following the %search_text% pattern.\n" } ] }, "docs": "Returns accepted Acquirer Reference ID and CardAcceptor ID pairs with pagination metadata" }, { "info": { "name": "Mastercard Add Acquirer Reference Id and Card Acceptor Id Pairs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/acquirer-merchant-ids", "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": "Returns added pairs of Acquirer Reference ID and Card Acceptor ID. Non unique pairs are placed in the rejected list." }, { "info": { "name": "Mastercard Delete Existing Acquirer Reference Id and Card Acceptor Id Pair", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sub-merchants/:guid/locations/:location_id/acquirer-merchant-ids/:acquirer_merchant_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": "acquirer_merchant_id", "value": "Mxyz123", "type": "path", "description": "Unique identifier of Acquirer Reference Id and Card Acceptor Id Pair" } ] }, "docs": "Returns 204 status code if acquirer reference ID and card acceptor ID pair deleted successfully" }, { "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": "Retrieve user details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:user_guid", "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 details of a particular user" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users/:user_guid", "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 update details of a particular user" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/users/:user_guid", "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 delete a particular 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 }