Mastercard

Mastercard Widgets API

The Widgets API from Mastercard — 1 operation(s) for widgets.

Documentation GitHub OpenAPI

Operations 1

GET /widgets/access-tokens Generate Access Token #

Documentation

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-reference/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-reference/

https://developer.mastercard.com/doconomy-aland-index/documentation/getting-started/

https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#authentication

https://developer.mastercard.com/doconomy-aland-index/documentation/api-reference/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-reference/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/getting-started/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#authentication

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-reference/

https://developer.mastercard.com/merchant-self-services/documentation/api-reference/

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#authentication

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-reference/

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#authentication

https://developer.mastercard.com/fld-fraud-submission/documentation/api-reference/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-reference/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-reference/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-reference/

https://developer.mastercard.com/unified-installments/documentation/api-basics/#authentication

https://developer.mastercard.com/unified-installments/documentation/api-reference/

https://developer.mastercard.com/locations-merchants/documentation/quick-start-guide/

https://developer.mastercard.com/locations-merchants/documentation/api-reference/

https://developer.mastercard.com/locations/documentation/quick-start-guide/

https://developer.mastercard.com/locations/documentation/api-reference/

https://developer.mastercard.com/donations/documentation/getting-started/

https://developer.mastercard.com/donations/documentation/api-reference/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#authentication

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-reference/

https://developer.mastercard.com/card-issuance/documentation/getting-started/

https://developer.mastercard.com/card-issuance/documentation/api-basics/#authentication

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-reference/

https://developer.mastercard.com/user-account-management-service/documentation/api-reference/

Specifications

https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-widgets-api-openapi.yml

Code Examples

https://developer.mastercard.com/mastercard-id-for-tp/documentation/postman-collection/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/reference-app/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/reference-app/

https://developer.mastercard.com/doconomy-aland-index/documentation/reference-app/

https://developer.mastercard.com/doconomy-aland-index/documentation/postman-collection/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/reference-app/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/reference-app/

https://developer.mastercard.com/merchant-self-services/documentation/reference-app/

https://developer.mastercard.com/merchant-self-services/documentation/postman-collection/

https://developer.mastercard.com/fld-suspected-fraud/documentation/reference-app/

https://developer.mastercard.com/fld-fraud-submission/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/postman-collections/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/reference-app/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/postman-collection/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/reference-app/

https://developer.mastercard.com/unified-installments/documentation/reference-app/

https://developer.mastercard.com/unified-installments/documentation/postman-collection/

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#insomnia

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#postman

https://developer.mastercard.com/locations-merchants/documentation/reference-app/

https://developer.mastercard.com/locations/documentation/integration-and-testing/#insomnia

https://developer.mastercard.com/locations/documentation/integration-and-testing/#postman

https://developer.mastercard.com/locations/documentation/reference-app/

https://developer.mastercard.com/donations/documentation/reference_app/

https://developer.mastercard.com/donations/documentation/postman-collection/

https://developer.mastercard.com/card-issuance/documentation/reference-app/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/reference-app/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/postman-collection/

https://developer.mastercard.com/user-account-management-service/documentation/reference-app/

Other Resources

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#api-security

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#encryption

https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-id-for-tp/documentation/use-cases/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/release-history/

https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#faqs

https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#get-help

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#api-security

https://developer.mastercard.com/mastercard-id-for-idp/documentation/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-id-for-idp/documentation/use-cases/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/release-history/

https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#faqs

https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#help

https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#environments

https://developer.mastercard.com/doconomy-aland-index/documentation/use-cases/

https://developer.mastercard.com/doconomy-aland-index/documentation/tutorials-and-guides/

https://developer.mastercard.com/doconomy-aland-index/documentation/code-and-formats/

https://developer.mastercard.com/doconomy-aland-index/documentation/support/#faqs

https://developer.mastercard.com/doconomy-aland-index/documentation/support/#get-help

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/announcements/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#api-security

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#environments

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/tutorials-and-guides/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/use-cases/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/code-and-formats/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/#test-data

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/release-history/

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#faq

https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#get-help

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/announcements/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#encryption

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/use-cases/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/tutorials-and-guides/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/code-and-formats/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/testing/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/release-history/

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#faq

https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#get-help

https://developer.mastercard.com/merchant-self-services/documentation/announcements/

https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#api-security

https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#environments

https://developer.mastercard.com/merchant-self-services/documentation/use-cases/

https://developer.mastercard.com/merchant-self-services/documentation/tutorials-and-guides/

https://developer.mastercard.com/merchant-self-services/documentation/code-and-formats/

https://developer.mastercard.com/merchant-self-services/documentation/testing/

https://developer.mastercard.com/merchant-self-services/documentation/release-history/

https://developer.mastercard.com/merchant-self-services/documentation/support/#faq

https://developer.mastercard.com/merchant-self-services/documentation/support/#get-help

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#encryption

https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/fld-suspected-fraud/documentation/use-cases/

https://developer.mastercard.com/fld-suspected-fraud/documentation/tutorials/

https://developer.mastercard.com/fld-suspected-fraud/documentation/code-and-formats/

https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#faq

https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#get-help

https://developer.mastercard.com/fld-fraud-submission/documentation/announcements/

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#encryption

https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/

https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/testing/

https://developer.mastercard.com/fld-fraud-submission/documentation/tutorials/

https://developer.mastercard.com/fld-fraud-submission/documentation/code-and-formats/

https://developer.mastercard.com/fld-fraud-submission/documentation/support/#faq

https://developer.mastercard.com/fld-fraud-submission/documentation/support/#get-help

https://developer.mastercard.com/identity-insights-for-accounts/documentation/announcements/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#api-security

https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#environments

https://developer.mastercard.com/identity-insights-for-accounts/documentation/use-cases/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/tutorials-and-guides/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/code-and-formats/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/testing/

https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#faq

https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#get-help

https://developer.mastercard.com/identity-insights-for-transactions/documentation/announcements/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#api-security

https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#environments

https://developer.mastercard.com/identity-insights-for-transactions/documentation/use-cases/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/tutorials-and-guides/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/code-and-formats/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/testing/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/release-history/

https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#faq

https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#get-help

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#api-security

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#environments

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/use-cases/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/tutorials-and-guides/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/testing/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/code-and-formats/

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#frequently-asked-questions

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#get-help

https://developer.mastercard.com/in-control-for-mobile-payments/documentation/glossary/

https://developer.mastercard.com/unified-installments/documentation/release-history/

https://developer.mastercard.com/unified-installments/documentation/api-basics/#api-security

https://developer.mastercard.com/unified-installments/documentation/api-basics/#encryption

https://developer.mastercard.com/unified-installments/documentation/api-basics/#environments

https://developer.mastercard.com/unified-installments/documentation/use-cases/mastercard-installments-program-with-merchant-participation/

https://developer.mastercard.com/unified-installments/documentation/tutorials-and-guides/

https://developer.mastercard.com/unified-installments/documentation/code-and-formats/

https://developer.mastercard.com/unified-installments/documentation/testing/

https://developer.mastercard.com/unified-installments/documentation/support/

https://developer.mastercard.com/locations-merchants/documentation/api-basics/#api-security

https://developer.mastercard.com/locations-merchants/documentation/api-basics/#environments

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/

https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#sandbox-test-data

https://developer.mastercard.com/locations-merchants/documentation/use-cases/

https://developer.mastercard.com/locations-merchants/documentation/code-and-formats/

https://developer.mastercard.com/locations-merchants/documentation/support/#faq

https://developer.mastercard.com/locations-merchants/documentation/support/#get-help

https://developer.mastercard.com/locations-merchants/documentation/announcements/

https://developer.mastercard.com/locations-merchants/documentation/release-history/

https://developer.mastercard.com/locations/documentation/api-basics/#api-security

https://developer.mastercard.com/locations/documentation/api-basics/#environments

https://developer.mastercard.com/locations/documentation/integration-and-testing/

https://developer.mastercard.com/locations/documentation/integration-and-testing/#sandbox-test-data

https://developer.mastercard.com/locations/documentation/use-cases/

https://developer.mastercard.com/locations/documentation/code-and-formats/

https://developer.mastercard.com/locations/documentation/support/#faq

https://developer.mastercard.com/locations/documentation/support/#get-help

https://developer.mastercard.com/locations/documentation/announcements/

https://developer.mastercard.com/locations/documentation/release-history/

https://developer.mastercard.com/donations/documentation/use-cases/

https://developer.mastercard.com/donations/documentation/api-basics/#environment-descriptions

https://developer.mastercard.com/donations/documentation/code-and-formats/

https://developer.mastercard.com/donations/documentation/support/#faqs

https://developer.mastercard.com/donations/documentation/support/#get-help

https://developer.mastercard.com/donations/documentation/support/#guides

https://developer.mastercard.com/donations/documentation/tutorials/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#encryption

https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#environments

https://developer.mastercard.com/mastercard-insurance-programs/documentation/use-cases/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/tutorials-and-guides/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/code-and-formats/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/testing/

https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#faq

https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#get-help

https://developer.mastercard.com/card-issuance/documentation/getting-started/#glossary

https://developer.mastercard.com/card-issuance/documentation/api-basics/#encryption

https://developer.mastercard.com/card-issuance/documentation/api-basics/#environments

https://developer.mastercard.com/card-issuance/documentation/use-cases/

https://developer.mastercard.com/card-issuance/documentation/tutorials-and-guides/

https://developer.mastercard.com/card-issuance/documentation/code-and-formats/

https://developer.mastercard.com/card-issuance/documentation/support/#faqs

https://developer.mastercard.com/card-issuance/documentation/support/#get-help

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#api-security

https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#environments

https://developer.mastercard.com/traditional-fulfillment-service/documentation/use-cases/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/tutorials-and-guides/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/code-and-formats/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/release-history/

https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#faq

https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#get-help

https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#api-security

https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#environments

https://developer.mastercard.com/user-account-management-service/documentation/use-cases/

https://developer.mastercard.com/user-account-management-service/documentation/tutorials-and-guides/

https://developer.mastercard.com/user-account-management-service/documentation/glossary/

https://developer.mastercard.com/user-account-management-service/documentation/code-and-formats/

https://developer.mastercard.com/user-account-management-service/documentation/release-history/

https://developer.mastercard.com/user-account-management-service/documentation/support/#faq

https://developer.mastercard.com/user-account-management-service/documentation/support/#get-help

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mastercard-widgets-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mastercard Benefit Eligibility Service Widgets API
  version: 1.0.1
  description: This API is for third-parties who want to enable eligibility checks based on input criteria including card number. The Eligibility API is a PAN (Primary Account Number) level verification service designed to promote targeted distribution of Mastercard card level benefits. This service enables merchants and third-party developers to use a PAN to check the eligibility and access rights to the benefits for those cardholders.
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
servers:
- url: https://api.mastercard.com/loyalty/eligibility
  description: Production server
- url: https://sandbox.api.mastercard.com/loyalty/eligibility
  description: Sandbox server
tags:
- name: Widgets
paths:
  /widgets/access-tokens:
    get:
      tags:
      - Widgets
      description: Generate a new access token for the vendor site.
      summary: Generate Access Token
      operationId: generateBenefitsAccessToken
      responses:
        '200':
          $ref: '#/components/responses/AccessToken'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  schemas:
    Error:
      description: A single error
      type: object
      properties:
        Source:
          type: string
          minLength: 0
          maxLength: 200
          description: Information about where the error happened
          example: ELIGIBILITY_BENEFITS_API
        ReasonCode:
          type: string
          minLength: 0
          maxLength: 200
          description: An error code
          example: BAD_REQUEST
        Description:
          type: string
          minLength: 0
          maxLength: 10000
          description: A description of the error
          example: We couldn't handle your request
        Recoverable:
          type: boolean
          description: Indicates if the request can be presented again for processing
          example: false
        Details:
          type: string
          minLength: 0
          maxLength: 10000
          description: More details about the error
          example: Invalid JSON payload
    Errors:
      description: Object that contains the list of errors
      type: object
      required:
      - Error
      properties:
        Error:
          $ref: '#/components/schemas/ErrorList'
    ErrorList:
      description: The list of errors
      type: array
      minItems: 1
      items:
        $ref: '#/components/schemas/Error'
    BenefitsAccessToken:
      type: object
      properties:
        accessToken:
          description: The String (text) representation of Benefits Access Token
          type: string
          example: hereeyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyMDIzMTIxMjA5MjMzNC1zdGFnZS1iZW5lZml0cy1hY2Nlc3MtbWFzdGVyY2FyZC1jb20iLCJ0ZXN0IjoidGVzdCIsImV4cCI6MTcwNTkxNjUzNiwiaWF0IjoxNzA1OTEyOTM2fQ.6NGFRgiy_7TayB366Eupz-xmro6Sb9kpwLY35IHoQDs
    ErrorWrapper:
      description: A top level object for errors
      type: object
      required:
      - Errors
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
  responses:
    AccessToken:
      description: Returns Token for cardholder
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BenefitsAccessToken'
    UnauthorizedError:
      description: Unauthorized - Access Not Granted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            UnauthorizedExample:
              $ref: '#/components/examples/UnauthorizedExample'
  examples:
    UnauthorizedExample:
      value:
        Errors:
          Error:
          - Source: Gateway
            ReasonCode: DECLINED
            Description: Unauthorized - Access Not Granted
            Recoverable: false
            Details: null