Mastercard Notifications API

Notification Operations - Retrieving collection of generated notifications

Documentation

📖
Documentation
https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/doconomy-aland-index/documentation/getting-started/
📖
Authentication
https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/doconomy-aland-index/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/getting-started/
📖
Authentication
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#authentication
📖
Documentation
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/merchant-self-services/documentation/api-reference/
📖
Authentication
https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/fld-suspected-fraud/documentation/api-reference/
📖
Authentication
https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/fld-fraud-submission/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-reference/
📖
Authentication
https://developer.mastercard.com/unified-installments/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/unified-installments/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/locations-merchants/documentation/quick-start-guide/
📖
Documentation
https://developer.mastercard.com/locations-merchants/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/locations/documentation/quick-start-guide/
📖
Documentation
https://developer.mastercard.com/locations/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/donations/documentation/getting-started/
📖
Documentation
https://developer.mastercard.com/donations/documentation/api-reference/
📖
Authentication
https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-reference/
📖
GettingStarted
https://developer.mastercard.com/card-issuance/documentation/getting-started/
📖
Authentication
https://developer.mastercard.com/card-issuance/documentation/api-basics/#authentication
📖
Documentation
https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-reference/
📖
Documentation
https://developer.mastercard.com/user-account-management-service/documentation/api-reference/

Specifications

Code Examples

💻
CodeExamples
https://developer.mastercard.com/mastercard-id-for-tp/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/mastercard-id-for-tp/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/mastercard-id-for-idp/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/doconomy-aland-index/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/doconomy-aland-index/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/merchant-self-services/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/merchant-self-services/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/fld-suspected-fraud/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/fld-fraud-submission/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/identity-insights-for-accounts/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/identity-insights-for-accounts/documentation/postman-collections/
💻
CodeExamples
https://developer.mastercard.com/identity-insights-for-transactions/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/identity-insights-for-transactions/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/unified-installments/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/unified-installments/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#insomnia
💻
CodeExamples
https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#postman
💻
CodeExamples
https://developer.mastercard.com/locations-merchants/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/locations/documentation/integration-and-testing/#insomnia
💻
CodeExamples
https://developer.mastercard.com/locations/documentation/integration-and-testing/#postman
💻
CodeExamples
https://developer.mastercard.com/locations/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/donations/documentation/reference_app/
💻
CodeExamples
https://developer.mastercard.com/donations/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/card-issuance/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/traditional-fulfillment-service/documentation/reference-app/
💻
CodeExamples
https://developer.mastercard.com/traditional-fulfillment-service/documentation/postman-collection/
💻
CodeExamples
https://developer.mastercard.com/user-account-management-service/documentation/reference-app/

Other Resources

🔗
Security
https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#api-security
🔗
Security
https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/mastercard-id-for-tp/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/mastercard-id-for-tp/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/mastercard-id-for-tp/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/mastercard-id-for-tp/documentation/code-and-formats/
🔗
ChangeLog
https://developer.mastercard.com/mastercard-id-for-tp/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#faqs
🔗
Support
https://developer.mastercard.com/mastercard-id-for-tp/documentation/support/#get-help
🔗
Security
https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#api-security
🔗
Security
https://developer.mastercard.com/mastercard-id-for-idp/documentation/
🔗
Sandbox
https://developer.mastercard.com/mastercard-id-for-idp/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/mastercard-id-for-idp/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/mastercard-id-for-idp/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/mastercard-id-for-idp/documentation/code-and-formats/
🔗
ChangeLog
https://developer.mastercard.com/mastercard-id-for-idp/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#faqs
🔗
Support
https://developer.mastercard.com/mastercard-id-for-idp/documentation/support/#help
🔗
Sandbox
https://developer.mastercard.com/doconomy-aland-index/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/doconomy-aland-index/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/doconomy-aland-index/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/doconomy-aland-index/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/doconomy-aland-index/documentation/support/#faqs
🔗
Support
https://developer.mastercard.com/doconomy-aland-index/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/announcements/
🔗
Security
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/api-basics/#environments
🔗
Tutorials
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/tutorials-and-guides/
🔗
UseCases
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/use-cases/
🔗
ErrorCodes
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/
🔗
Sandbox
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/testing/#test-data
🔗
ChangeLog
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/ethoca-alerts-for-merchants/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/announcements/
🔗
Security
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/api-basics/authentication-and-encryption/#encryption
🔗
UseCases
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/testing/
🔗
ChangeLog
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/ethoca-consumer-clarity-for-merchants/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/merchant-self-services/documentation/announcements/
🔗
Security
https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/merchant-self-services/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/merchant-self-services/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/merchant-self-services/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/merchant-self-services/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/merchant-self-services/documentation/testing/
🔗
ChangeLog
https://developer.mastercard.com/merchant-self-services/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/merchant-self-services/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/merchant-self-services/documentation/support/#get-help
🔗
Security
https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/fld-suspected-fraud/documentation/api-basics/#environment-descriptions
🔗
UseCases
https://developer.mastercard.com/fld-suspected-fraud/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/fld-suspected-fraud/documentation/tutorials/
🔗
ErrorCodes
https://developer.mastercard.com/fld-suspected-fraud/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/fld-suspected-fraud/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/fld-fraud-submission/documentation/announcements/
🔗
Security
https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/fld-fraud-submission/documentation/api-basics/#environment-descriptions
🔗
UseCases
https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/
🔗
Sandbox
https://developer.mastercard.com/fld-fraud-submission/documentation/use-cases/testing/
🔗
Tutorials
https://developer.mastercard.com/fld-fraud-submission/documentation/tutorials/
🔗
ErrorCodes
https://developer.mastercard.com/fld-fraud-submission/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/fld-fraud-submission/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/fld-fraud-submission/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/identity-insights-for-accounts/documentation/announcements/
🔗
Security
https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/identity-insights-for-accounts/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/identity-insights-for-accounts/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/identity-insights-for-accounts/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/identity-insights-for-accounts/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/identity-insights-for-accounts/documentation/testing/
🔗
FAQ
https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/identity-insights-for-accounts/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/identity-insights-for-transactions/documentation/announcements/
🔗
Security
https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/identity-insights-for-transactions/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/identity-insights-for-transactions/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/identity-insights-for-transactions/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/identity-insights-for-transactions/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/identity-insights-for-transactions/documentation/testing/
🔗
ChangeLog
https://developer.mastercard.com/identity-insights-for-transactions/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/identity-insights-for-transactions/documentation/support/#get-help
🔗
Security
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/tutorials-and-guides/
🔗
Sandbox
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/testing/
🔗
ErrorCodes
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#frequently-asked-questions
🔗
Support
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/support/#get-help
🔗
Glossary
https://developer.mastercard.com/in-control-for-mobile-payments/documentation/glossary/
🔗
ChangeLog
https://developer.mastercard.com/unified-installments/documentation/release-history/
🔗
Security
https://developer.mastercard.com/unified-installments/documentation/api-basics/#api-security
🔗
Security
https://developer.mastercard.com/unified-installments/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/unified-installments/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/unified-installments/documentation/use-cases/mastercard-installments-program-with-merchant-participation/
🔗
Tutorials
https://developer.mastercard.com/unified-installments/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/unified-installments/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/unified-installments/documentation/testing/
🔗
Support
https://developer.mastercard.com/unified-installments/documentation/support/
🔗
Security
https://developer.mastercard.com/locations-merchants/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/locations-merchants/documentation/api-basics/#environments
🔗
Sandbox
https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/
🔗
Sandbox
https://developer.mastercard.com/locations-merchants/documentation/integration-and-testing/#sandbox-test-data
🔗
UseCases
https://developer.mastercard.com/locations-merchants/documentation/use-cases/
🔗
ErrorCodes
https://developer.mastercard.com/locations-merchants/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/locations-merchants/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/locations-merchants/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/locations-merchants/documentation/announcements/
🔗
ChangeLog
https://developer.mastercard.com/locations-merchants/documentation/release-history/
🔗
Security
https://developer.mastercard.com/locations/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/locations/documentation/api-basics/#environments
🔗
Sandbox
https://developer.mastercard.com/locations/documentation/integration-and-testing/
🔗
Sandbox
https://developer.mastercard.com/locations/documentation/integration-and-testing/#sandbox-test-data
🔗
UseCases
https://developer.mastercard.com/locations/documentation/use-cases/
🔗
ErrorCodes
https://developer.mastercard.com/locations/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/locations/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/locations/documentation/support/#get-help
🔗
ReleaseNotes
https://developer.mastercard.com/locations/documentation/announcements/
🔗
ChangeLog
https://developer.mastercard.com/locations/documentation/release-history/
🔗
UseCases
https://developer.mastercard.com/donations/documentation/use-cases/
🔗
Sandbox
https://developer.mastercard.com/donations/documentation/api-basics/#environment-descriptions
🔗
ErrorCodes
https://developer.mastercard.com/donations/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/donations/documentation/support/#faqs
🔗
Support
https://developer.mastercard.com/donations/documentation/support/#get-help
🔗
Tutorials
https://developer.mastercard.com/donations/documentation/support/#guides
🔗
Tutorials
https://developer.mastercard.com/donations/documentation/tutorials/
🔗
Security
https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/mastercard-insurance-programs/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/mastercard-insurance-programs/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/mastercard-insurance-programs/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/mastercard-insurance-programs/documentation/code-and-formats/
🔗
Sandbox
https://developer.mastercard.com/mastercard-insurance-programs/documentation/testing/
🔗
FAQ
https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/mastercard-insurance-programs/documentation/support/#get-help
🔗
Glossary
https://developer.mastercard.com/card-issuance/documentation/getting-started/#glossary
🔗
Sandbox
https://developer.mastercard.com/card-issuance/documentation/api-basics/#encryption
🔗
Sandbox
https://developer.mastercard.com/card-issuance/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/card-issuance/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/card-issuance/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/card-issuance/documentation/code-and-formats/
🔗
FAQ
https://developer.mastercard.com/card-issuance/documentation/support/#faqs
🔗
Support
https://developer.mastercard.com/card-issuance/documentation/support/#get-help
🔗
Security
https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/traditional-fulfillment-service/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/traditional-fulfillment-service/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/traditional-fulfillment-service/documentation/tutorials-and-guides/
🔗
ErrorCodes
https://developer.mastercard.com/traditional-fulfillment-service/documentation/code-and-formats/
🔗
ChangeLog
https://developer.mastercard.com/traditional-fulfillment-service/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/traditional-fulfillment-service/documentation/support/#get-help
🔗
Security
https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#api-security
🔗
Sandbox
https://developer.mastercard.com/user-account-management-service/documentation/api-basics/#environments
🔗
UseCases
https://developer.mastercard.com/user-account-management-service/documentation/use-cases/
🔗
Tutorials
https://developer.mastercard.com/user-account-management-service/documentation/tutorials-and-guides/
🔗
Glossary
https://developer.mastercard.com/user-account-management-service/documentation/glossary/
🔗
ErrorCodes
https://developer.mastercard.com/user-account-management-service/documentation/code-and-formats/
🔗
ChangeLog
https://developer.mastercard.com/user-account-management-service/documentation/release-history/
🔗
FAQ
https://developer.mastercard.com/user-account-management-service/documentation/support/#faq
🔗
Support
https://developer.mastercard.com/user-account-management-service/documentation/support/#get-help

OpenAPI Specification

mastercard-notifications-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Notifications API
  description: This service is provided on behalf of the Mastercard Remote Payment and Presentment (RPPS) Bill Payment Processing Network, which supports consumer to business "push" bill payments (i.e. those which are not funded by debit/credit card transactions) in the U.S.
  version: '1.0'
  x-artifactId: billpay-api
  contact:
    name: Bill Pay Development Support
    email: Bill_Pay_Development_Support@mastercard.com
host: sandbox.api.mastercard.com
basePath: /billpayAPI/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Notifications
  description: Notification Operations - Retrieving collection of generated notifications
paths:
  /notifications:
    get:
      summary: Getting notifications
      description: 'This endpoint represents the collection of notifications that have been generated for the client within the retention period for notifications. A GET on this endpoint retrieves the notifications in a paginated manner.

        '
      tags:
      - Notifications
      operationId: getNotifications
      parameters:
      - $ref: '#/components/parameters/startDateParam'
      - $ref: '#/components/parameters/endDateParam'
      - $ref: '#/components/parameters/subscriptionNameParam'
      - $ref: '#/components/parameters/subjectNameParam'
      - $ref: '#/components/parameters/pushStatusParam'
      - $ref: '#/components/parameters/notificationsOffsetParam'
      - $ref: '#/components/parameters/notificationsLimitParam'
      responses:
        '200':
          $ref: '#/components/responses/GetNotificationResponse'
        '400':
          $ref: '#/components/responses/NotFound'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Notifications
      description: This is an outbound notification from Mastercard Installments to customers API endpoint, to notify about an installment offer availed by a cardholder. This is an optional notification as per Issuers selection, which is configured as part of customer onboarding on Mastercard Installment program. This endpoint requires partial request payload encryption to encrypt sensitive data, consumers primary account number as part of encryptedValues field. Please refer to request specification for more details. The encryption/decryption needs to be performed using [JWE payload encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/#jwe-encryption). Please refer to the [Securing Sensitive Data Using Payload Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/) sections for implementation details.
      operationId: notifyPlan
      parameters:
      - $ref: '#/components/parameters/PlanNotifCorrelationIdHeaderParameter'
      requestBody:
        $ref: '#/components/requestBodies/PlanProcessorRequestBody'
      responses:
        '201':
          $ref: '#/components/responses/PlanNotifSuccessResponse'
        '400':
          $ref: '#/components/responses/PlanNotifBadRequestError'
        '401':
          $ref: '#/components/responses/PlanNotifUnauthorizedError'
        '403':
          $ref: '#/components/responses/PlanNotifForbiddenError'
        '404':
          $ref: '#/components/responses/PlanNotifNotFoundError'
        '429':
          $ref: '#/components/responses/PlanNotifTooManyRequestError'
      summary: Notifies Issuer or Processor about an Installment offer availed by a cardholder.
components:
  schemas:
    ICCPAuthorizationNotificationContent:
      description: The content of the notification, the structure of which depends on the subject.
      type: object
      properties:
        messageTypeIndicator:
          description: 'Message Type Identifier. Following are the possible values for messageTypeIndicator: 0110 (Authorization Response), 0120 (Authorization Advice), 0400 (Reversal Request) and 0420 (Reversal Advice).'
          type: string
          minLength: 4
          maxLength: 4
          example: '0110'
        systemTraceAuditNumber:
          description: Systems Trace Audit Number (STAN) is a number a message initiator assigns to uniquely identify a transaction. This value is derived from DE 11.
          type: string
          minLength: 1
          maxLength: 255
          example: '011174'
        financialNetworkCode:
          description: Financial network code derived from DE 63, subfield 1 identifies the specific program or service (for example, the financial network, financial program, or card program) with which the transaction is associated.
          type: string
          example: MCC
        banknetReferenceNumber:
          description: Banknet reference number derived from DE 63, subfield 2 is generated by the Authorization Platform for each originating message it routes. The reference number is guaranteed to be a unique value for any transaction within the specified financial network on any processing day.
          type: string
          example: Q4A91A
        transactionAmount:
          description: The transaction amount represented in minor units, which are the smallest units of a currency. The value is determined by the number of decimal places associated with the currency. Refers to DE 63, subfield 2.
          type: number
          example: 7550
        transactionCurrencyCode:
          description: Currency of the transaction (merchant currency) refers to DE 49.
          type: string
          example: USD
        billingAmount:
          description: Cardholder billing amount (DE 6) indicates the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees and is represented in minor units, which are the smallest units of a currency. The value is determined by the number of decimal places associated with the currency.
          type: number
          example: 7550
        billingCurrencyCode:
          description: The currency code of the cardholder billing defines the currency of DE 6 (Amount, Cardholder Billing).
          type: string
          example: USD
        responseCode:
          description: DE 39 (Response Code) defines the disposition of a previous message or an action taken as a result of receipt of a previous message. Response codes also are used to indicate approval or decline of a transaction. In the event an authorization is declined, the response code indicates the reason for rejection and may indicate an action to be taken at the card acceptor (for example, capture card).
          type: string
          example: '00'
        authorizationCode:
          description: DE 38 (Authorization ID Response) contains the online authorization code provided by the issuer on the original authorization response. It is a transaction response ID code that the authorizing institution assigns. DE 38 is used to transmit a card issuers authorization code for Authorization transactions. In general, the authorization code used in DE 38 may be any combination of alphanumeric characters.
          type: string
          example: '502359'
        transmissionRawDate:
          description: DE 7, subfield 1 (Date) is the date (UTC) that the message was entered into the Mastercard Network in the format MMDD.
          type: string
          example: '1103'
        transmissionRawTime:
          description: DE 7, subfield 2 (Time) is the time (UTC) that the message was entered into the Mastercard Network in the format HHmmss.
          type: string
          example: '101611'
        settlementDate:
          description: Referring to DE 15, the reporting date to which a transaction applies in the format MMDD. This is the UTC date that the authorization is processed, not the date on which settlement will occur.
          type: string
          example: 0930
        cardHolderTransactionTypeCode:
          description: DE 3, subfield 1 describes the specific transaction type.
          type: string
          example: '00'
        posTransactionStatus:
          description: 'DE 61, subfield 7 indicates the purpose or status of the request. Following are the possible values for posTransactionStatus:  0 (Normal request [original presentment]),  2 (Identity Check Phone Order),  3 (ATM Installment Inquiry),  4 (Preauthorization request),  5 (Time Based Payment Authorization RequestBrazil domestic transactions),  6 (ATC Update),  8 (Account Status Inquiry Service (ASI)),  9 (Tokenization Request/Notification).'
          type: string
          example: '0'
        traceId:
          description: Contains data from DE 63 (Network Data), subfield 1 (Financial Network Code) and subfield 2 (Banknet Reference Number) and DE 15 (Date, Settlement) that is in the original Authorization Request Response/0110 message.
          type: string
          example: 'MCC9999991231  '
        merchant:
          description: Merchant details
          type: object
          properties:
            merchantId:
              description: DE 42 (Card Acceptor ID Code) identifies the card acceptor that defines the point of the transaction in both local and interchange environments. DE 42 is used as a merchant ID to uniquely identify the merchant in a POS transaction.
              type: string
              example: '497520000000000'
            categoryCode:
              description: DE 18 (Merchant Type) is the classification (card acceptor business code/merchant category code [MCC]) of the merchants type of business or service.
              type: string
              example: '5542'
            name:
              description: DE 43 (Acceptor Name and Location), subfield 1 (Acceptor Name) contains the merchant name against the merchant id. Merchant name is the merchant doing business as name.
              type: string
              example: JASPERHITECH
            city:
              description: ContainsDE 43 (Acceptor Name and Location), subfield 3 (Acceptor City) indicates the city of the merchant.
              type: string
              example: Jasper
            stateOrCountryCode:
              description: DE 43, subfield 5 contains the ISO 3166-1 country code of the merchant.
              type: string
              example: TN
        realPaymentCard:
          description: Real Payment Card Details
          type: object
          properties:
            number:
              description: DE 2 (Primary Account Number [PAN]) is a series of digits (represented masked) used to identify a customer account or relationship.
              type: string
              example: '************0112'
            expiryMonth:
              description: DE 14 (Date, Expiration) specifies the year and month after which an issuer assigns a cardholders card to be expired.
              type: string
              example: '12'
            expiryYear:
              description: DE 14 (Year, Expiration) specifies the year and month after which an issuer assigns a cardholders card to be expired.
              type: string
              example: '24'
        virtualPaymentCard:
          description: Virtual Payment Card Details
          type: object
          properties:
            number:
              description: DE 48, subelement 33, subfield 2 (Account Number) indicates the PAN (represented masked) mapping account number.
              type: string
              example: '************6213'
            expiryMonth:
              description: DE 48, subelement 33, subfield 3 (Expiration Date) indicates the expiration date of the PAN mapping account in format YYMM.
              type: string
              example: 09
            expiryYear:
              description: DE 48, subelement 33, subfield 3 (Expiration Date) indicates the expiration date of the PAN mapping account in format YYMM.
              type: string
              example: '27'
        inControlOnBehalfServiceResult:
          description: In Control Service Result details, derived from DE 48 (Additional DataPrivate Use). DE 48 is reserved for private organizations to define data unique to specific networks or specific programs and services. DE 48 provides other supplemental data in a message when a specific ISO-designated data element is not available. It is a free-format, variable-length data element that may be used for multiple purposes.
          type: object
          properties:
            rcnServiceResultCode:
              description: In Control RCN Spend Control Service (generally will be null). DE 48, subelement 71 (On-behalf [OB] Services) notifies the issuer of the On-behalf Service performed on the transaction and the results. Subelement 71 will support up to ten services for a transaction.
              type: string
              example: ''
            vcnServiceResultCode:
              description: VCN Service Result Code. DE 48, subelement 71 (On-behalf [OB] Services) notifies the issuer of the On-behalf Service performed on the transaction and the results. Subelement 71 will support up to ten services for a transaction.
              type: string
              example: V
        originalMessage:
          description: Original message identifying information, in the case of a follow-up message. DE 90 (Original Data Elements) is the data elements in the original message, intended to identify a transaction for correction or reversal.
          type: object
          properties:
            messageTypeIndicator:
              description: DE 90, subfield 1 (Original Message Type Identifier) indicates the Message Type Identifier (MTI) of the original message.
              type: string
              minLength: 4
              maxLength: 4
              example: '0110'
            systemTraceAuditNumber:
              description: DE 90, subfield 2 (Original DE 11 [Systems Trace Audit Number]) indicates the Systems Trace Audit Number (STAN) that was in DE 11 of the original message.
              type: string
              example: '11174'
            transmissionRawDateTime:
              description: DE 90, subfield 3 (Original DE 7 [Transmission Date and Time]) indicates the Transmission Date and Time that was in DE 7 of the original message.
              type: string
              example: '1029112800'
        advice:
          description: Advice information (valid for advice messages only, MTI=04xx).
          type: object
          properties:
            reasonCode:
              description: DE 60, subfield 1 (Advice Reason Code) indicates to the receiver of an Advice message the specific reason for the transmission of the Advice message.
              type: string
              example: '650'
        replacementAmounts:
          description: Replacement amounts, applicable for reversals, indicate the new values that replace the amounts in the original transaction. These amounts are represented in minor units, which are the smallest unit of a currency and vary depending on the number of decimal places used by the currency.
          type: object
          properties:
            transactionAmount:
              description: DE 95, subfield 1 (Actual Amount, Transaction) indicates the actual transaction amount. The amount for the replacement transaction represented in minor units, which are the smallest units of a currency. The value is determined by the number of decimal places associated with the currency.
              type: number
              example: 1200
            settlementAmount:
              description: DE 95, subfield 2 (Actual Amount, Settlement) indicates the actual settlement amount in the settlement currency. The amount for the settlement transaction represented in minor units, which are the smallest units of a currency. The value is determined by the number of decimal places associated with the currency.
              type: number
              example: 1200
            billingAmount:
              description: DE 95, subfield 3 (Actual Amount, Cardholder Billing) the actual amount in the issuer currency represented in minor units, which are the smallest units of a currency. The value is determined by the number of decimal places associated with the currency.
              type: number
              example: 1200
        purchaseRequest:
          description: Purchase Request Details
          type: object
          properties:
            purchaseRequestId:
              description: ICCP Purchase Request ID - uniquely identifies the purchase request and VCN
              type: integer
              example: 5213
            rcnAlias:
              description: Real card number alias
              type: string
              example: Travel Expense RCN
            companyId:
              description: ICCP Company ID - uniquely identifies the company that created the VCN
              type: integer
              example: 233191
            companyGuid:
              description: ICCP Company GUID - alternative ID to uniquely identify the company that created the VCN
              type: string
              example: SENTTY9951972A6FC0206CB494B560E5E6DC5D02A2BD21D89612EF4A18358ECC777DCF1494921797
            issuerGuid:
              description: ICCP Issuer GUID - uniquely identifies the issuer of the RCN funding the VCN
              type: string
              example: SENTTY5E4C4B4E0D1BF5991E64A1E0745F40A85B2510CE48EB537011DCED3C483669D61494938440
    ICCPClearingNotificationContent:
      description: The content of the notification, the structure of which depends on the subject.
      type: object
      properties:
        clearingTransactionId:
          description: Specifies the Clearing Incontrol transaction id.
          type: integer
          example: 123
        type:
          description: Incontrol specific field indicating if its a D(Debit) or C(Credit)
          type: string
          example: C
        acquirerReferenceData:
          description: The twenty-three-character alphanumeric acquirer Reference Data is data an acquirer supplies in an acquirer-originated message that may be required for an issuer to return to the acquirer in a subsequent message. DE 31 (Acquirer Reference Data) is data an acquirer supplies in an acquirer-originated message that may be required for an issuer to return to the acquirer in a subsequent message.
          type: string
          example: '39663858658842283834864'
        functionCode:
          description: The three-digit numeric function Code indicates a message specific purpose. DE 24 (Network International ID) identifies a single international network of card issuers.
          type: integer
          example: 200
        messageTypeId:
          description: 'Four-digit numeric field describing the type of message being interchanged. Possible values are: 1240-Presentment,  1442-Chargeback,  1644-Administrative,  1740-Fee Collection'
          type: integer
          example: 1240
        txnType:
          description: Specifies the ICCP derived field from Message Type.
          type: string
          example: First Presentment
        isMastercardSwitched:
          description: Specifies the flag used to indicate if transaction is to or from issuer. Possible values are T(True) or F(False), where T = To Issuer (switched), F = From Issuer (non-switched).
          type: string
          example: T
        receiverId:
          description: Identifies the transaction destination institution. DE 100 (Receiving Institution ID Code) is the identity of the institution receiving a Request or Advice message in an interchange system if not the same as identified in DE 2 (Primary Account Number [PAN]) or DE 34 (Primary Account Number [PAN], Extended).
          type: string
          example: '105678'
        messageReasonCode:
          description: The four-digit numeric code provides the message receiver with the reason for sending the message. DE 25 (Point-of-Service [POS] Condition Code) is an ID of the condition under which the transaction takes place at the point of interaction.
          type: integer
          example: 1401
        originalTransactionId:
          description: Specifies the In Control identifier for linked transaction. In Control txn ID of an original message.
          type: integer
          example: 127
        conversionRateCardholderBilling:
          description: Transaction exchange rate. DE 10 (Conversion Rate, Cardholder Billing) is the factor used in the conversion from transaction to cardholder billing amount. DE 4 (Amount, Transaction) is multiplied by DE 10 to determine DE 6 (Amount, Cardholder Billing).
          type: number
          example: 2
        authCode:
          description: The six-digit alphanumeric code used as authorization approval code of the issuer. DE 38 (Authorization ID Response) is a transaction response ID code that the authorizing institution assigns. DE 38 is used to transmit a card issuers authorization code for Authorization transactions.
          type: string
          example: '111111'
        processingCode:
          description: The processing Code. DE 3 (Processing Code) describes the effect of a transaction on the customer account and the type of accounts affected.
          type: string
          example: '010000'
        tokenPan:
          description: Specifies the PAN associated with the token, with digits 0-9, where minimum length is 12, and maximum  length is 19.
          type: string
          example: '1234567891011'
        posEntryMode:
          description: Codes that identify terminal capability, terminal environment, and point-of-interaction (POI) security data. DE 22 (Point-of-Service [POS] Entry Mode) indicates the method used for PAN entry to initiate a transaction and the PIN entry capabilities.
          type: string
          example: 099999B99001
        dateTimeTransactionLocal:
          description: Transaction timestamp is a string type which indicates the Datetime at which the transaction takes place at the card acceptor location. It should be in ISO Date Time with Offset format yyyy-MM-ddTHH:mm:ssXXX. It is combination of DE 12 and DE 13. DE12 - DE 12 (Time, Local Transaction) is the local time at which the transaction takes place at the point of card acceptor location. DE 13 - DE 13 (Date, Local Transaction) is the local month and day on which the transaction takes place at the point of card acceptor location.
          type: string
          example: '2020-07-16T11:09:42.10+01:00'
        settlementAmount:
          description: Specifies the amount of funds to be transferred between the acquirer and the issuer
          type: object
          properties:
            amount:
              description: DE 5 (Amount, Settlement) is the amount of funds to be transferred between the acquirer and the issuer equal to DE 4 (Amount, Transaction) in the settlement currency. Mastercard programs and services use U.S. dollars as the currency of settlement.
              type: number
              example: 1234.56
            currencyCode:
              description: Specifies the currency code of funds to be transferred between the acquirer and the issuer.
              type: string
              example: '840'
            currencyCodeAlphabetic:
              description: Specifies the currency name of funds to be transferred between the acquirer and the issuer.
              type: string
              example: USD
        reversalIndicator:
          description: Flag which indicates the Reversal of a clearing. Supported values are true if this is a reversal, false otherwise.
          type: boolean
          example: 'false'
        isMatched:
          description: 'Status of the transaction. Values: S - Settled, F - Fraudulent. Incontrol specific status Clearing event should have only True or False value for this attribute. When value for event is Settled - S, it should be translated as True or else False.'
          type: string
          example: 'true'
        originalOrLinked:
          description: Determines if it is an Original or linked transaction. Possible values can be O (Original), or L (Linked)
          type: string
          example: L
        controlsAppliedDateTime:
          description: Specifies the Settlement date, and should be in ISO Date Time with Offset format "yyyy-MM-dd'T'HH:mm:ssXXX". Defaults to System Date if not written by Settlement Process in Incontrol.
          type: string
          example: '2019-07-03T11:09:42.10+01:00'
        banknetReferenceNumber:
          description: Banknet Reference Number is generated by the Authorization Platform for each originating message it routes. The reference number is guaranteed to be a unique value for any transaction within the specified financial network on any processing day. DE 63 (Network Data) is generated by the Authorization Platform for each originating message routed through the network. The receiver must retain the data element and use it in any response or acknowledgement message associated with the originating message.
          type: string
          example: 4977D7
        destinationInstitutionIdCode:
          description: Identity of the institution receiving a request is a numeric value range from 6 to 11 digits. DE 100 (Receiving Institution ID Code) is the identity of the institution receiving a Request or Advice message in an interchange system if not the same as identified in DE 2 (Primary Account Number [PAN]) or DE 34 (Primary Account Number [PAN], Extended). The Authorization Platform uses DE 100 to determine the destination routing of Administrative/06xx messages. For these messages, DE 33 (Forwarding Institution ID Code) identifies the sender of the message; DE 100 identifies the receiver of the message.
          type: integer
          example: 111111
        acquirerInstitutionIdCode:
          description: Interbank Card Association ID of the acquirer is numeric value range from 1 to 11 digits. DE 32 (Acquiring Institution ID Code) identifies the acquiring institution (for example, merchant bank) or its agent.
          type: integer
          example: 123456
        forwardingInstitutionIdCode:
          description: ICA of the processer if available. DE 33 (Forwarding Institution ID Code) identifies the institution forwarding a Request or Advice message in an interchange system if it is not the same institution as specified in DE 32 (Acquiring Institution ID Code). DE 33 is used within a message to contain the Mastercard six-digit customer ID number of the CPS or INF responsible for directly routing that message to the Authorization Platform.
          type: integer
          example: 322222
        cardHolderAmount:
          description: Indicates the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees.
          type: object
          properties:
            amount:
              description: Indicates the value of transaction amount in the issuers currency.
              type: integer
              example: 1234.56
            currencyCode:
              description: Indicates the currency code of the transaction amount in the issuers currency.
              type: string
              example: 840
            currencyCodeAlphabetic:
              description: Indicates the currency name of the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees
              type: string
              example: USD
        authorization:
          description: ''
          type: object
          properties:
            authorizationTransactionId:
              description: Specifies the Authorization Transaction ID used for matching.
              type: integer
              example: 2450
            systemTraceAuditNumber:
              description: Systems Trace Audit Number (STAN) is a number a message initiator assigns to uniquely identify a transaction.
              type: integer
              example: 2450
            type:
              description: 'Indicates the type of transaction. Valid values include: 0 = Auth,  1 = Advice,  2 = Reversal,  3 = Reversal advice,  4 = Offline Auth,  5 = Offline purchase return,  8 = Offline Auth for purchase return.  6,7 = Transaction types 6 & 7 are reserved for internal use'
              type: integer
              example: 0
            acceptorLocalDate:
              description: Transaction local date in the format of MMDD. DE 13 (Date, Local Transaction) is the local month and day on which the transaction takes place at the point of card acceptor location. This date must be specified in local time zone units, not in UTC units. The original value of this data element must not be changed.
              type: string
              example: 0912
            acceptorLocalTime:
              description: Transaction local time. DE 12 (Time, Local Transaction) is the local time at which the transaction takes place at the point of card acceptor location. Time must be specified in local time zone units, not in UTC units. The original value of this data element must not be changed.
              type: string
              example: '175603'
            mtIdType:
              description: Message Type Identifier. One of 0100 - Auth, 0120 - Advice, 0400 - Reversal, 0420 - Reversal Advice.
              type: string
              example: '0100'
            cardHolderAmount:
              description: ''
              type: object
              properties:
                amount:
                  description: DE 6 (Amount, Cardholder Billing) indicates the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees.
                  type: number
                  example: 75
                currencyCode:
                  description: Indicates the currency code of the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees.
                  type: string
                  example: 840
                currencyCodeAlphabetic:
                  description: Indicates the currency name of the transaction amount in the issuers currency. It is the amount billed to the cardholder in the cardholder account currency, excluding cardholder billing fees.
                  type: string
                  example: USD
            effectOnBalance:
              description: This value will be same as DE 6 in event of Partial Replacement. In Partial replacement DE 95.3 will replace DE 6.
              type: integer
              example: 75
            acceptorAmount:
              description: ''
              type: object
              properties:
                amount:
                  description: DE 4 (Amount, Transaction) is the amount of funds the cardholder requested in the local currency of the acquirer or source location of the transaction.
                  type: number
                  example: 999
                currencyCode:
                  description: Specifies the currency code of amount of funds the cardholder requested in the local currency of the acquirer or source location of the transaction.
                  type: string
                  example: 840
                currencyCodeAlphabetic:
                  description: Specifies the currency name of amount of funds the cardholder requested in the local currency of the acquirer or source location of the transaction.
                  type: string
                  example: USD
        virtualPaymentCard:
          description: Virtual Payment Card Details
          type: object
          properties:
            number:
              description: Specifies the Primary Account Number (PAN) of the VCN, which can have digits between 0 to 9, and has a length of 12 to 19 digits. The value is masked and only last four digits are visible.
              type: string
              example: '"************1234'
            expiry:
              description: Specifies the cardholders expiry in the format yyyy-MM
              type: string
              example: 2024-11
        realPaymentCard:
          description: Real Payment Card Details
          type: object
          properties:
            number:
              description: Specifies the Prima

# --- truncated at 32 KB (140 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mastercard/refs/heads/main/openapi/mastercard-notifications-api-openapi.yml