{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mastercard Carbon Calculator Experience API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Issuer",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Mastercard Fetches the Issuer Details.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mastercard.com/cts/issuers"
          },
          "docs": "Allows fetching the Issuer details onboarded on the Carbon Calculator Experience. This API returns the Issuer's available details like a supported account range, currency code, and country code along with the color theme."
        },
        {
          "info": {
            "name": "Mastercard Allows Issuer to Update the Issuer Details to the Carbon Calculator Experience Platform.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mastercard.com/cts/issuers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows a registered Issuer to update the configuration details to the Carbon Calculator Experience API."
        },
        {
          "info": {
            "name": "Mastercard Allows Issuer to Enroll Cardholders to the Carbon Calculator Experience Platform.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mastercard.com/cts/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": "https://api.mastercard.com/cts/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": "Dashboards",
        "type": "folder"
      },
      "items": [
        {
          "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": "https://api.mastercard.com/cts/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": "Aggregate",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Mastercard Fetches Monthly Aggregate Carbon Score for the Transactions Made for the Current Month.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mastercard.com/cts/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": "Deletions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Mastercard Delete One or More Users.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mastercard.com/cts/issuers/user-deletions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<ul><li>Allows a registered Service Provider to delete one or more users.</li> <li>Payment cards associated with the user will also be deleted.</li> <li>On a successful response from the Server, the Service Provider should remove all the requested users and associated payment cards from the system.</li></ul>"
        }
      ]
    }
  ],
  "bundled": true
}