{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Users API", "version": "1.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "View an Identity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-profiles/identity-searches", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve decrypted identities along with rotated PDS to present the user\nwith the registered identity in the TP app. Does not require a minimum authentication standard. \n**This API is mandatory.**\n" }, { "info": { "name": "Create a new user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-profiles", "body": { "type": "json", "data": "{}" } }, "docs": "- This endpoint registers a user profile using the given\n`user profile ID`.\n\n- An error will be returned if the user profile already exists. \n**This API is mandatory.**\n" }, { "info": { "name": "Delete an Identity.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/user-profiles", "params": [ { "name": "user_profile_id", "value": "ee13a7ec-5a5a-4618-a55d-5e1ed016ccd5", "type": "query", "description": "UUID identifying the user, which the TP App generates using the MIDS Core SDK." }, { "name": "user_consent", "value": "ACCEPT", "type": "query", "description": "Confirmation provided by the TP that the user has consented that the ID-Network can have access to their identity for the purposes of the API call. Should be ACCEPT, a forbidden exception will be thrown if it is any other value." } ] }, "docs": "Enable TP app to mark user account as deleted on Mastercard ID Network. Requires GPA authentication. \n**This API is mandatory.**\n" }, { "info": { "name": "Delete Document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-profiles/identity-attribute-deletions", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an identity attribute from a PDS and update the affected assurance levels. Requires GPA authentication. \n**This API is mandatory.**\n" }, { "info": { "name": "View identity lifecycle activities which have occurred in a time period.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-account-activity-searches", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve decrypted user activities and present them to the user in the\nTP app. Does not require a minimum authentication standard.\n**This API is mandatory.**\n" }, { "info": { "name": "Share an Identity with an External RP - Provide the PDS to enable ID for TP to determine if these satisfy an RPs scope request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/claims/user-data-extractions", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the user information from the PDS that is requested by the\nRelying Party based on the ARID. Does not require a minimum authentication standard.\n**This API is mandatory.**\n" }, { "info": { "name": "Share an Identity with an External RP - Provide consent to share the identity attributes which satisfy an RPs scope request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/claims/user-consents", "body": { "type": "json", "data": "{}" } }, "docs": "Inform the Trust Party about the user consent. If the consent is given,\nthe identity attributes will be shared with Relying Party. Does not require a minimum authentication standard. \n**This API is mandatory.**\n" }, { "info": { "name": "Register a new user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows users to register a new user" }, { "info": { "name": "Updates personal information for currently enrolled users (cardholders), including their name, contact information, security question, and more.\n", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/users", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing user's demographic information." }, { "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": "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" }, { "info": { "name": "Verifies user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users/:id/verifications", "params": [ { "name": "id", "value": "268810378058708149455458707247", "type": "path", "description": "The unique identifier for the given user." }, { "name": "user_id_type", "value": "RANCU", "type": "query", "description": "Determines the type of user or account identification. Supported identifiers are RANAC or RANCU." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify user based on answers to the security questions." }, { "info": { "name": "Retrieves a cardholder's information, including their name, address, communication preferences, and more.\nUsers are unique cardholders, as compared to Accounts that are unique cards. Each User can have multiple Accounts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:id", "params": [ { "name": "id", "value": "268810378058708149455458707247", "type": "path", "description": "The unique identifier for the given user." }, { "name": "user_id_type", "value": "RANCU", "type": "query", "description": "Determines the type of user or account identification. Supported identifiers are RANAC or RANCU." }, { "name": "include_verification_details", "value": "true", "type": "query", "description": "Cardholder verification details are included in the response if true." }, { "name": "language", "value": "en_US", "type": "query", "description": "Cardholder verification details are returned in the language requested." } ] }, "docs": "Retrieves Cardholder information." }, { "info": { "name": "Retrieve user consent by an identifier", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/user-consents/:user_consent_id", "params": [ { "name": "user_consent_id", "value": "2c0743c0-fe6a-41a6-88c4-2c94786fb9c2", "type": "path", "description": "User Consent Identifier" } ] }, "docs": "Retrieve the user consent by an identifier. A Merchants/PSP can use this API to check whether the user consent for the user_consent_id exist or not." }, { "info": { "name": "Revoke user consent using an identifier", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/user-consents/:user_consent_id", "params": [ { "name": "user_consent_id", "value": "2c0743c0-fe6a-41a6-88c4-2c94786fb9c2", "type": "path", "description": "User Consent Identifier" } ] }, "docs": "A merchant/PSP can use this API to revoke the user consent for a user consent identifier (user_consent_id). Once the user consent is revoked (deleted), it will not be available via Retrieve User-Consent request." }, { "info": { "name": "Mastercard Allows Issuer to Enroll Cardholders to the Carbon Calculator Experience Platform.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/users", "body": { "type": "json", "data": "{}" } }, "docs": "Used to enroll users for the Carbon Calculator Experience API so that\nthey can track the carbon usage for their transactions and provides\nthem with an option to donate towards tree plantation.\n\n**Note-**\n* If the issuer has opted for the Donation feature then the fields - *name, billing address, email, locale, cardholder name, card number, card base currency and card expiry date* fields are **mandatory** in the payload.\n* This endpoint uses the Mastercard payload\n encryption. Refer to the **[Pa" }, { "info": { "name": "Mastercard Allows Issuer to Update Enrolled User Information Onto Carbon Calculator Experience Platform.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/issuers/users/:userid", "params": [ { "name": "userid", "value": "f5d88571-ac15-465a-a0d8-1ad1327b9a06", "type": "path", "description": "Unique identifier for a user enrolled into Carbon Calculator Experience platform." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to update the user's information for Carbon Calculator Experience." }, { "info": { "name": "Mastercard Used to Retrieve the Short-lived Url of a User's Dashboard to View Their Carbon Footprints and Contributions to Priceless Planet.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/users/:userid/dashboards", "params": [ { "name": "userid", "value": "f5d88571-ac15-465a-a0d8-1ad1327b9a06", "type": "path", "description": "Unique identifier for a user enrolled into Carbon Calculator Experience platform." }, { "name": "lang", "value": "en-US", "type": "query", "description": "Language preference (en-US - English, es-cr - Spanish (Costa Rica), es-cl - Spanish (Chile), sv - Swedish, pl-PL - Polish (Poland))" } ] }, "docs": "It allows issuers to retrieve a short-lived URL for an enrolled user. An Issuer needs to load this URL within their application so that the user can view the dashboard in their preferred language. Currently, four languages are supported, including English, Spanish (Latin America), Swedish, and Polish." }, { "info": { "name": "Mastercard Fetches Monthly Aggregate Carbon Score for the Transactions Made for the Current Month.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/issuers/users/:userid/aggregate-carbon-scores", "params": [ { "name": "userid", "value": "f5d88571-ac15-465a-a0d8-1ad1327b9a06", "type": "path", "description": "Unique identifier for a user enrolled into Carbon Calculator Experience platform." } ] }, "docs": "Allows Issuers to retrieve an aggregate carbon footprint for the transactions done by a user." }, { "info": { "name": "Mastercard Delete One or More Users.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/issuers/user-deletions", "body": { "type": "json", "data": "{}" } }, "docs": "" }, { "info": { "name": "Mastercard Create a User Data Token Which Is Used in the Redirection Url That Redirects the Cardholder to the Website for Submitting a New Claim.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-data-tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Create a user data token for submitting claim." } ] } ], "bundled": true }