{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Merchants API", "version": "1.0" }, "items": [ { "info": { "name": "Merchants", "type": "folder" }, "items": [ { "info": { "name": "Provide Supported MCCs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/supported-merchant-categories" }, "docs": "Provides a list of merchant category codes supported by the application. While sending transaction data in the Transaction object, 'mcc' should be from one of the supported merchant categories. It is recommended to cache this list and use it for checking before sending transactions for footprint calculation. Generally this list doesn't change that often, but it is recommended to refresh this data every 24-hours." }, { "info": { "name": "Provides status of merchant participation updates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/merchants/participations", "params": [ { "name": "request_id", "value": "7223372036854776000", "type": "query", "description": "The request ID is obtained by calling POST /merchants/participations API." }, { "name": "offset", "value": "100", "type": "query", "description": "Determines the number of items needed in the start of the list, to retrieve the list starting from the offset." }, { "name": "limit", "value": "100", "type": "query", "description": "Controls the maximum number of items in the list." } ] }, "docs": "Allows registered partners to fetch a list of merchants with participation details whose participation request is completed successfully. If query parameter 'request_id' is supplied then the response will be limited to only those merchant objects with any status (PENDING, COMPLETED) that were part of that particular request.

For details on mandatory fields in response, please consult the description section of the POST: /merchants/participations endpoint.

In case of request fai" }, { "info": { "name": "Allows a registered partner to create or update merchant participation details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/merchants/participations", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint enables registered partners to manage merchant participation details, indicating whether a merchant has opted into or out of Buy Now Pay Later. A unique MAID-based merchant is identified by a combination of acquirerICA, merchantLegalName, and countryCode.

It facilitates the creation of a merchant with participation and allows updates to existing participation information, such as adding more MIDs, toggling opt-in flags, modifying address fields, and updating wallet informa" }, { "info": { "name": "Allows registered partners to search merchant participation information.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/merchants/searches", "params": [ { "name": "offset", "value": "100", "type": "query", "description": "Determines the number of items needed in the start of the list, to retrieve the list starting from the offset." }, { "name": "limit", "value": "100", "type": "query", "description": "Controls the maximum number of items in the list." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows registered partners to search merchant objects, enabled for Acquirers and Installment Payment Providers (IPP).

Additionally, customers can search MAID merchant based on maid.

At least one parameter is required in the request.

For previously onboarded customers to API both `nonMerchantNegotiatedParticipation` and `optIn` will be visible. The field `nonMerchantNegotiatedParticipation` will be deprecated.

For previously onboarded customers to API both `ac" }, { "info": { "name": "Allows registered partners (Acquirers only) to search only specific merchant participation information.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/merchants/mids/searches", "params": [ { "name": "offset", "value": "100", "type": "query", "description": "Determines the number of items needed in the start of the list, to retrieve the list starting from the offset." }, { "name": "limit", "value": "100", "type": "query", "description": "Controls the maximum number of items in the list." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows registered partners to search mids for a given merchant. A combination of `merchantLegalName`, `countryCode`, and `acquirerICA` is required in the request.

For previously onboarded customers to API both `nonMerchantNegotiatedParticipation` and `optIn` will be visible. The field `nonMerchantNegotiatedParticipation` will be deprecated.\n" }, { "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 Create a Sub-merchant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sub-merchants", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns sub-merchant object with status." }, { "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 Details of Organization Profiles.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/org-profiles", "headers": [ { "name": "User-Id", "value": "princess.diana" }, { "name": "Submitter-First-Name", "value": "Diana" }, { "name": "Submitter-Last-Name", "value": "Princess" } ] }, "docs": "Returns organization profile details containing member name, id and type." }, { "info": { "name": "Mastercard Get Acquirer Reference Id Configs.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-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": "acquirer_reference_id", "value": "123456", "type": "query", "description": "BIN that a partner currently services under their portfolio." }, { "name": "card_scheme", "value": "MASTERCARD", "type": "query", "description": "Name of card scheme may be one of - MASTERCARD, VISA or any other supported schemes" }, { "name": "offset", "value": "25", "type": "query", "description": "Number of items per page" }, { "name": "page_number", "value": "1", "type": "query", "description": "Current page number" } ] }, "docs": "Get the acquirer reference id configs filtered by acquirer reference id and card scheme." }, { "info": { "name": "Mastercard Create Acquirer Reference Id Config.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-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)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an acquirer reference id configuration." }, { "info": { "name": "Mastercard Update Acquirer Reference Id Config.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-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": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an acquirer reference id configuration." }, { "info": { "name": "Mastercard Delete Acquirer Reference Id Config.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/alerts/merchants/:member_id/acquirer-reference-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": "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": "Delete an acquirer reference id configuration." }, { "info": { "name": "Mastercard Get a List of Sub-merchants.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants", "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": "name", "value": "Merchant 1", "type": "query", "description": "The name of the merchant" }, { "name": "status", "value": "ACTIVATED", "type": "query", "description": "The status of the merchant" }, { "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-merchants matching multiple criteria." }, { "info": { "name": "Mastercard Create a Sub-merchant.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants", "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)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns created sub-merchant details." }, { "info": { "name": "Mastercard Get a Sub-merchant.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id", "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" } ] }, "docs": "Returns sub-merchant details with matching ID." }, { "info": { "name": "Mastercard Update a Sub-merchant.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id", "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 updated sub-merchant details." }, { "info": { "name": "Mastercard Change Sub-merchant Status.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/alerts/merchants/:member_id/sub-merchants/:sub_merchant_id/status-changes", "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 sub-merchant details with updated status." }, { "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": "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": "Mastercard Get a List of Merchant Details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/searches", "params": [ { "name": "limit", "value": "25", "type": "query", "description": "The number of items to be retrieved" }, { "name": "offset", "value": "1", "type": "query", "description": "The page offset used for the query" }, { "name": "distance", "value": "5", "type": "query", "description": "Distance measurement for calculating the radius search. Optional The length of distance from the centroid point. Value string(<25). The default will be 5 units" }, { "name": "distance_unit", "value": "MILE", "type": "query", "description": "Unit of measurement for calculating the radius search. Optional. Measurement of distance unit in miles or kilometers. Value string (MILE or KM)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns detailed information on merchants based on the provided query parameters" } ] } ], "bundled": true }