Mastercard

Mastercard Field Mapping API

The Field Mapping API from Mastercard — 1 operation(s) for field mapping.

Documentation GitHub OpenAPI

Operations 1

GET /fieldmappings Retrieving fieldmappings #

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-field-mapping-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 Commercial Event Notifications Field Mapping API
  description: Receive near real-time payment alerts enabling accurate completion and reconciliation of commercial payments
  version: 1.2.0
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
servers:
- url: https://api.mastercard.com/commercial-event-notifications
  description: Production server URL
- url: https://sandbox.api.mastercard.com/commercial-event-notifications
  description: Sandbox server URL
tags:
- name: Field Mapping
paths:
  /fieldmappings:
    get:
      summary: Retrieving fieldmappings
      description: Retrieve field information for notification message content, which can be used to set up subscription filter specifications for those notifications.
      tags:
      - Field Mapping
      operationId: getFieldMapping
      responses:
        '200':
          $ref: '#/components/responses/FieldMappingSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-400'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-403'
    FieldMappingSuccess:
      description: OK
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/FieldMapping'
          examples:
            BPC PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/FieldMappingBPCAuthorizationResponse'
            ICCP CLEARING:
              $ref: '#/components/examples/FieldMappingICCPClearingResponse'
            ICCP PAYMENT AUTHORIZATION:
              $ref: '#/components/examples/FieldMappingICCPAuthorizationResponse'
            ICMP TOKEN LIFECYCLE:
              $ref: '#/components/examples/FieldMappingICMPLifecycleResponse'
            ICMP TOKEN PROVISIONING:
              $ref: '#/components/examples/FieldMappingICMPProvisioningResponse'
  examples:
    FieldMappingICCPClearingResponse:
      value:
      - id: 135E59332C14BF9AE06368459E0ACEF0
        name: virtualPaymentCard.number
        displayName: virtual Card number
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C760225235E06368459E0AD1EA
        name: purchaseRequest.rcnAlias
        displayName: purchaseRequest rcnAlias
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C760235235E06368459E0AD1EA
        name: purchaseRequest.companyId
        displayName: purchaseRequest company Id
        subjectType: CLEARING
        contentType: INTEGER
      - id: 16E733C760245235E06368459E0AD1EA
        name: purchaseRequest.companyGuid
        displayName: purchaseRequest company Guid
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C760255235E06368459E0AD1EA
        name: purchaseRequest.issuerGuid
        displayName: purchaseRequest issuer Guid
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C75FE65235E06368459E0AD1EA
        name: acceptor.merchantCategoryCode
        displayName: acceptor merchantCategoryCode
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C760065235E06368459E0AD1EA
        name: isMatched
        displayName: isMatched
        subjectType: CLEARING
        contentType: TEXT
      - id: 16E733C7600B5235E06368459E0AD1EA
        name: type
        displayName: type
        subjectType: CLEARING
        contentType: TEXT
    FieldMappingICCPAuthorizationResponse:
      value:
      - id: 0CNS2cfa3d3977d6d991b7cd723570ba96bf6830ef4c4f897f4d00df0038e288f34c1556724071
        name: virtualPaymentCard.number
        displayName: Virtual card number
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNSa6d4a329d377bb296957df43e9f2f1ab5b35c997f88bcbc34939bc1525990be51556724071
        name: messageTypeIndicator
        displayName: Message type indicator
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNS05bb6badecddacf50a3c4c94184c6214f38e0980883b13bf7205165c7a74a8231556724071
        name: responseCode
        displayName: Response code
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNSddd4612f680dd452c61b945436e06f73e80786d7ebd6683d8cc0c7950bdd01211556724071
        name: inControlOnBehalfServiceResult.vcnServiceResultCode
        displayName: In Control VCN service result code
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNS14802eafac9cfe04d25da2a5944074eaa89bee5ca2136329e493399a27a39ccd1556724071
        name: purchaseRequest.rcnAlias
        displayName: Purchase request RCN alias
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNS0e2d81ac7109e23ee63d818f575d43e465ca193771eb510a4156d772fd98eb5a1556724071
        name: purchaseRequest.companyId
        displayName: Purchase request company id
        subjectType: PAYMENT_AUTHORIZATION
        contentType: INTEGER
      - id: 0CNS1fe7275144b16a3ef1cec8f8261598d7491491c2894015d549ec00e13ba961a31556724071
        name: purchaseRequest.companyGuid
        displayName: Purchase request company GUID
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 0CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724071
        name: purchaseRequest.issuerGuid
        displayName: Purchase request issuer GUID
        subjectType: PAYMENT_AUTHORIZATION
        contentType: TEXT
    FieldMappingBPCAuthorizationResponse:
      value:
      - id: 141747A087EADC9DE06368459E0AC116
        name: fundingSource.fundingSourceGuid
        displayName: Funding Source Guid
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087B1DC9DE06368459E0AC116
        name: messageTypeIndicator
        displayName: MessageTypeIndicator
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087B4DC9DE06368459E0AC116
        name: issuerGuid
        displayName: IssuerGuid
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087B5DC9DE06368459E0AC116
        name: corpGuid
        displayName: CorpGuid
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087B8DC9DE06368459E0AC116
        name: processor.responseCode
        displayName: Processor ResponseCode
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087BBDC9DE06368459E0AC116
        name: processor.onBehalfResult
        displayName: Processor OnBehalfResult
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087BFDC9DE06368459E0AC116
        name: realPaymentCard.accountGuid
        displayName: RealPaymentCard AccountGuid
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087C0DC9DE06368459E0AC116
        name: virtualPaymentCard.number
        displayName: VirtualPaymentCard Number
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
      - id: 141747A087C2DC9DE06368459E0AC116
        name: virtualPaymentCard.accountGuid
        displayName: VirtualPaymentCard AccountGuid
        subjectType: BPC_PAYMENT_AUTHORIZATION
        contentType: TEXT
    FieldMappingICMPProvisioningResponse:
      value:
      - id: 1AD42C3FCAE62726E06368459E0A9487
        name: vcnInfo.accountNumber
        displayName: VCN Account Number
        subjectType: TOKEN_PROVISIONING_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAE92726E06368459E0A9487
        name: vcnInfo.ownerInfo.issuerGuid
        displayName: VCN Issuer Guid
        subjectType: TOKEN_PROVISIONING_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAF12726E06368459E0A9487
        name: purchaseRequest.rcnAlias
        displayName: Purchase Request RCN Alias
        subjectType: TOKEN_PROVISIONING_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAF22726E06368459E0A9487
        name: purchaseRequest.companyId
        displayName: Purchase Request Company Id
        subjectType: TOKEN_PROVISIONING_EVENT
        contentType: INTEGER
    FieldMappingICMPLifecycleResponse:
      value:
      - id: 1AD42C3FCAE62726E06368459E0A9487
        name: vcnInfo.accountNumber
        displayName: VCN Account Number
        subjectType: TOKEN_LIFECYCLE_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAE92726E06368459E0A9487
        name: vcnInfo.ownerInfo.issuerGuid
        displayName: VCN Issuer Guid
        subjectType: TOKEN_LIFECYCLE_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAF12726E06368459E0A9487
        name: purchaseRequest.rcnAlias
        displayName: Purchase Request RCN Alias
        subjectType: TOKEN_LIFECYCLE_EVENT
        contentType: TEXT
      - id: 1AD42C3FCAF22726E06368459E0A9487
        name: purchaseRequest.companyId
        displayName: Purchase Request Company Id
        subjectType: TOKEN_LIFECYCLE_EVENT
        contentType: INTEGER
  schemas:
    Error-400:
      type: object
      required:
      - Errors
      properties:
        Errors:
          type: object
          required:
          - Error
          properties:
            Error:
              type: array
              description: An array of error objects giving information about relevant errors.
              items:
                type: object
                properties:
                  Source:
                    type: string
                    description: The origin of the error
                    example: Commercial Event Notifications
                  ReasonCode:
                    type: string
                    description: A unique error code representing the error that occurred
                    example: format.invalid
                  Description:
                    type: string
                    description: A developer-friendly description of the error that occurred
                    example: One or more fields contain invalid data
                  Recoverable:
                    type: boolean
                    description: Can the error be recovered by retrying the same request later?
                    example: false
                  Details:
                    type: string
                    description: Additional details regarding the error that occurred
                    example: Invalid content in request payload
    Error-403:
      type: object
      required:
      - Errors
      properties:
        Errors:
          type: object
          required:
          - Error
          properties:
            Error:
              type: array
              description: An array of error objects giving information about relevant errors.
              items:
                type: object
                properties:
                  Source:
                    type: string
                    description: The origin of the error
                    example: Commercial Event Notifications
                  ReasonCode:
                    type: string
                    description: A unique error code representing the error that occurred
                    example: subscriber.notAllowed
                  Description:
                    type: string
                    description: A developer-friendly description of the error that occurred
                    example: Access not allowed
                  Recoverable:
                    type: boolean
                    description: Can the error be recovered by retrying the same request later?
                    example: false
                  Details:
                    type: string
                    description: Additional details regarding the error that occurred
                    example: Subscriber with consumerKey 'INVALID_CONSUMER_KEY' doesn't have permissions to complete the request
    FieldMapping:
      description: A collection of field definitions any of which can be used to specify matching criteria when creating a subscription.
      type: object
      properties:
        id:
          description: Field mapping id
          type: string
          minLength: 1
          maxLength: 255
          readOnly: true
          example: CNSa91bf379b48a593fd17f07f431bad8fb296796498f4e9982ea134394c1fa4f071556724073
        name:
          description: The name used to refer to the field in the specification criteria.
          type: string
          minLength: 1
          maxLength: 255
          example: purchaseRequest.rcnAlias
        displayName:
          description: Descriptive name of the field
          type: string
          minLength: 1
          maxLength: 255
          example: Purchase request RCN alias
        subjectType:
          description: The type of subject to which the field refers. Currently allowed values are 'PAYMENT_AUTHORIZATION', 'PAYMENT_UPDATE', 'CLEARING', 'BPC_PAYMENT_AUTHORIZATION', 'TOKEN_PROVISIONING_EVENT' and 'TOKEN_LIFECYCLE_EVENT'.
          type: string
          minLength: 1
          maxLength: 50
          example: PAYMENT_AUTHORIZATION
        contentType:
          description: What type of information the field (and therefore the matching criteria for that field) will contain. Currently one of allowed values are 'INTEGER', 'number', 'TEXT', 'DATE', 'CURRENCY'.
          type: string
          default: TEXT
          example: TEXT

Mastercard Field Mapping API

Operations 1

Documentation

Specifications

Code Examples

Other Resources