Mastercard

Mastercard Plans API

The Plans API from Mastercard — 2 operation(s) for plans.

GitHub OpenAPI

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

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

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-plans-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  title: Mastercard Bill Payment Validator Account Opening Plans 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: Plans
paths:
  /plans:
    post:
      tags:
      - Plans
      description: 'When a cardholder chooses one of the installment offers previously shown through the Offer Presentment API, customers need to send the details of the selected offer, including the PAN, transaction information, merchant details, and offer specifics, without any changes. Mastercard then validates this data against the presented offer to ensure its integrity and provides a success or failure response

        If the API processing is successful, it returns an HTTP status code of 201, a status of CREATED, and a unique Plan Identifier. In this scenario, customers can inform the cardholder that the installment offer has been processed successfully. However, if the API processing fails for some reason, it returns a corresponding HTTP status code and the customer should inform the cardholder about the failure in paying with installments.

        - This endpoint requires partial request payload encryption to encrypt sensitive data, merchant name and consumers primary account number as part of sensitiveData field. Please refer to request specification for more details. The encryption 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.'
      summary: Notify Mastercard when a consumer chooses a previously presented offer, which is henceforth called as an Installment Plan.
      x-mastercard-api-encrypted: true
      operationId: savePlan
      parameters:
      - $ref: '#/components/parameters/CorrelationIdHeaderParameter'
      requestBody:
        $ref: '#/components/requestBodies/PlanPostRequestBody'
      responses:
        '201':
          $ref: '#/components/responses/PlanCreated'
        '400':
          $ref: '#/components/responses/PlanCreateInvalidInput'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
  /plans/{plan_id}:
    get:
      tags:
      - Plans
      summary: Retrieves Buy Now, Pay Later installment plan.
      description: This operation returns a BNPL installment plan based on the selected plan ID provided in the request. The API response contains encrypted values of the consumer's email and phone, and the issuer needs to decrypt the response using the Mastercard client encryption key.
      operationId: getPlan
      parameters:
      - $ref: '#/components/parameters/plan_id'
      responses:
        '200':
          $ref: '#/components/responses/InstallmentPlan'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
components:
  responses:
    UnauthorizedError:
      content:
        application/json:
          example:
            Errors:
              Error:
              - Source: mci-installment-bnpl-plans-api
                ReasonCode: unauthorized
                Description: Unauthorized to access the resource.
                Details: None
                Recoverable: false
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
      description: 'Unauthorized: Authentication is required and has failed or has not been provided.'
    MethodNotAllowed:
      description: 'Method Not Allowed: Method used to request the resource is not allowed.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            MethodNotAllowed:
              $ref: '#/components/examples/MethodNotAllowed'
    BadRequestError:
      description: This response code is returned when a request is invalid, or data in the request is not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            InvalidCardProductError:
              $ref: '#/components/examples/InvalidCardProductError'
            InvalidFieldFormat:
              $ref: '#/components/examples/InvalidFieldFormat'
            InvalidFieldLength:
              $ref: '#/components/examples/InvalidFieldLength'
            InvalidFieldValue:
              $ref: '#/components/examples/InvalidFieldValue'
            MissingRequiredField:
              $ref: '#/components/examples/MissingRequiredField'
    Unauthorized:
      description: Unauthorized to access the resource.
      headers:
        Correlation-Id:
          $ref: '#/components/headers/Correlation-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            Unauthorized:
              $ref: '#/components/examples/Unauthorized'
    PlanCreateInvalidInput:
      description: Invalid Input while processing Plan API.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            TransactionAmountMisMatch:
              $ref: '#/components/examples/TransactionAmountMisMatch'
            TransactionDateMisMatch:
              $ref: '#/components/examples/TransactionDateMisMatch'
            InvalidTransactionCurrency:
              $ref: '#/components/examples/InvalidTransactionCurrency'
            BlankPAN:
              $ref: '#/components/examples/BlankPAN'
            NonNumericPAN:
              $ref: '#/components/examples/NonNumericPAN'
            InvalidPANLength:
              $ref: '#/components/examples/InvalidPANLength'
            InvalidTokenPAN:
              $ref: '#/components/examples/InvalidTokenPAN'
            PANMisMatch:
              $ref: '#/components/examples/PANMisMatch'
            InvalidLengthMerchantName:
              $ref: '#/components/examples/InvalidLengthMerchantName'
            InvalidLengthMerchantURL:
              $ref: '#/components/examples/InvalidLengthMerchantURL'
            InvalidMerchantURL:
              $ref: '#/components/examples/InvalidMerchantURL'
            InvalidAcquirerId:
              $ref: '#/components/examples/InvalidAcquirerId'
            InvalidLengthAcquirerId:
              $ref: '#/components/examples/InvalidLengthAcquirerId'
            InvalidCountryCode:
              $ref: '#/components/examples/InvalidCountryCode'
            InvalidLengthMcc:
              $ref: '#/components/examples/InvalidLengthMcc'
            InvalidLengthMerchantId:
              $ref: '#/components/examples/InvalidLengthMerchantId'
            InvalidMerchantId:
              $ref: '#/components/examples/InvalidMerchantId'
            InvalidAmountType:
              $ref: '#/components/examples/InvalidAmountType'
            InvalidLengthSTAN:
              $ref: '#/components/examples/InvalidLengthSTAN'
            NonNumericSTAN:
              $ref: '#/components/examples/NonNumericSTAN'
            InvalidLengthRRN:
              $ref: '#/components/examples/InvalidLengthRRN'
            NonNumericRRN:
              $ref: '#/components/examples/NonNumericRRN'
            InvalidLengthAuthCode:
              $ref: '#/components/examples/InvalidLengthAuthCode'
            NonNumericAuthCode:
              $ref: '#/components/examples/NonNumericAuthCode'
            InvalidTransactionLinkId:
              $ref: '#/components/examples/InvalidTransactionLinkId'
            InvalidTransmissionDateTime:
              $ref: '#/components/examples/InvalidTransmissionDateTime'
            InvalidLocalTransactionDateTime:
              $ref: '#/components/examples/InvalidLocalTransactionDateTime'
            InvalidFrequency:
              $ref: '#/components/examples/InvalidFrequency'
            InvalidPresentedOffersDSP:
              $ref: '#/components/examples/InvalidPresentedOffersDSP'
            InvalidPresentedOffersDRNG:
              $ref: '#/components/examples/InvalidPresentedOffersDRNG'
    InstallmentPlan:
      content:
        application/json:
          examples:
            Initiated Plan with Consumer Selected Offer:
              $ref: '#/components/examples/InitiatedPlanOfferSelected'
            Initiated Plan with Lender Selected Offer:
              $ref: '#/components/examples/InitiatedPlanProviderSelected'
            Approved Plan:
              $ref: '#/components/examples/ApprovedPlan'
            Rejected Plan:
              $ref: '#/components/examples/RejectedPlan'
          schema:
            $ref: '#/components/schemas/InstallmentPlan'
      description: 'The plan is found and returned based on plan ID.

        '
    ForbiddenError:
      description: This response code is returned when API or resource access is not approved for the client.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            ForbiddenError:
              $ref: '#/components/examples/ForbiddenError'
    NotFound:
      description: Not Found.
      headers:
        Correlation-Id:
          $ref: '#/components/headers/Correlation-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorWrapper'
          examples:
            NotFound:
              $ref: '#/components/examples/NotFound'
    PlanCreated:
      headers:
        Location:
          schema:
            type: string
          description: The URL that the client should poll for a response status. Refer to GET /plans/{plan_id}.
      content:
        application/json:
          examples:
            Carded Installment Plan:
              description: This example shows a successful response for 'Mastercard Installments Payment Services product which includes planID & status.
              value:
                planId: 3d56f5a7-db48-41f0-875e-30920e8465f3
                status: CREATED
          schema:
            $ref: '#/components/schemas/CreatedInstallmentPlan'
      description: A new plan is created.
  examples:
    InitiatedPlanProviderSelected:
      description: This example shows no offer selection by a consumer during checkout. Transaction Offers and ProviderId are specified instead. Lenders can view the consumer information, merchant information, and transaction information to determine installment eligibility.
      value:
        consumer:
          email: doe.jane@example.com
          isdCode: '1'
          mobile: '5551231234'
        merchant:
          acceptor: '100234'
          country: USA
          mcc: '1711'
          name: Decor shop
        planId: 3d56f5a7-db48-41f0-875e-30920e8465f3
        providerId: 218b9962-1355-44e4-8a16-f911363fd849
        status: CREATED
        transaction:
          amount: 400.11
          currency: USD
        transactionOffers:
        - offerId: '12345678'
        - offerId: '87654321'
    PANMisMatch:
      description: PAN does not match with Offer.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: pan.match
            Description: Provided PAN does not match with offer.
            Recoverable: false
            Details: PAN does not match with Offer.
    ApprovedPlan:
      description: This example shows a consumer-selected plan that has been approved by a lender. The lender can view the status of the plan after the approval.
      value:
        consumer:
          email: doe.jane@example.com
          isdCode: '1'
          mobile: '5551231234'
        merchant:
          acceptor: '100234'
          country: USA
          mcc: '1711'
          name: Decor shop
        offerId: '24092019'
        transactionOffers:
        - offerId: '24092019'
        - offerId: '87654321'
        planId: 3d56f5a7-db48-41f0-875e-30920e8465f3
        planInstallmentInformation:
          apr: 1.92
          currency: USD
          frequency: 15DAYS
          installmentAmount: 166.79
          installmentFee: 0
          tenure: 3
          totalAmount: 500.37
        providerId: 218b9962-1355-44e4-8a16-f911363fd849
        scheduledRepayments:
        - amount: 166.79
          dueDate: '2022-05-30'
          installmentNumber: 1
        - amount: 166.79
          dueDate: '2022-06-13'
          installmentNumber: 2
        - amount: 166.79
          dueDate: '2022-06-27'
          installmentNumber: 3
        status: APPROVED
        transaction:
          amount: 400.11
          currency: USD
    BlankPAN:
      description: Blank PAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: PAN is present and is blank or null.
            Recoverable: false
            Details: PAN cannot blank or empty.
    TransactionDateMisMatch:
      description: Provided transaction date does not match with Offer.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Provided transaction date does not match with offer.
            Recoverable: false
            Details: Mismatch in Transaction Date.
    InvalidFieldFormat:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.body.parameter
            Description: Field format or type is invalid
            Recoverable: false
            Details: ''
    MissingRequiredField:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.body.parameter
            Description: One or more of the required fields are missing
            Recoverable: false
            Details: ''
    InvalidLengthMerchantId:
      description: Incorrect Length for Merchant Id provided in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect Merchant Id length.
            Recoverable: false
            Details: Merchant id should not be lesser than 1 and greater than 15 in length.
    InvalidLengthSTAN:
      description: Incorrect length for STAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect STAN length.
            Recoverable: false
            Details: STAN should not be less than 1 or greater than 6. Please provide a valid STAN.
    InvalidTransmissionDateTime:
      description: Incorrect datetime format for TransmissionDateTime field sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Invalid datetime format.
            Recoverable: false
            Details: Transmission date and time should be in 'YYYY-MM-DD hh:mm:ss' format only.
    InvalidLocalTransactionDateTime:
      description: Incorrect datetime format for LocalTransactionDateTime field sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Invalid datetime format.
            Recoverable: false
            Details: Local Transaction date and time should be in 'YYYY-MM-DD hh:mm:ss' format only.
    NonNumericSTAN:
      description: Non-Numeric STAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Non-Numeric STAN.
            Recoverable: false
            Details: STAN should be numeric only.
    InitiatedPlanOfferSelected:
      description: This example shows a consumer selected plan during checkout when OfferId is available. Lenders can view the plan information consumer information, merchant information, and transaction information to determine installment eligibility.
      value:
        consumer:
          email: doe.jane@example.com
          isdCode: '1'
          mobile: '5551231234'
        merchant:
          acceptor: '100234'
          country: USA
          mcc: '1711'
          name: Decor shop
        offerId: '24092019'
        transactionOffers:
        - offerId: '24092019'
        - offerId: '87654321'
        planId: 3d56f5a7-db48-41f0-875e-30920e8465f3
        planInstallmentInformation:
          apr: 1.92
          currency: USD
          frequency: 15DAYS
          installmentAmount: 166.79
          installmentFee: 0
          tenure: 3
          totalAmount: 500.37
        providerId: 218b9962-1355-44e4-8a16-f911363fd849
        scheduledRepayments:
        - amount: 166.79
          dueDate: '2022-05-30'
          installmentNumber: 1
        - amount: 166.79
          dueDate: '2022-06-13'
          installmentNumber: 2
        - amount: 166.79
          dueDate: '2022-06-27'
          installmentNumber: 3
        status: CREATED
        transaction:
          amount: 400.11
          currency: USD
    InvalidLengthMerchantURL:
      description: Incorrect Merchant URL Length sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect Merchant URL length.
            Recoverable: false
            Details: Merchant URL should not be lesser that 1 and greater than 50 in length.
    TransactionAmountMisMatch:
      description: Provided transaction amount does not match with Offer.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Provided transaction amount does not match with offer.
            Recoverable: false
            Details: Mismatch in Transaction Amount.
    InvalidFieldLength:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.body.parameter
            Description: Field length is out of bound
            Recoverable: false
            Details: ''
    InvalidPresentedOffersDRNG:
      description: Presented offers is required, along with the offer ID, if the Provider Carded Product Use Case includes 'during purchase'.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Both OfferId and TransactionOffers must be present for this provider - Value must not be null
            Recoverable: false
            Details: Invalid input request for cardedInstallments.
    NonNumericPAN:
      description: Non Numeric PAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: PAN is present and is non numeric.
            Recoverable: false
            Details: PAN should be numeric only.
    InvalidLengthMcc:
      description: Incorrect Length for Mcc provided in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Merchant Category Code is invalid. Length must match 4.
            Recoverable: false
            Details: Merchant Category Code length must be 4.
    Unauthorized:
      description: Unauthorized to access the resource.
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: unauthorized
            Description: Unauthorized to access the resource.
            Recoverable: false
            Details: ''
    NotFound:
      description: URI/Resource not found.
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: not.found
            Description: URI/Resource not found.
            Recoverable: false
            Details: ''
    NonNumericRRN:
      description: Non-Numeric RRN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Non-Numeric RRN.
            Recoverable: false
            Details: RRN should be numeric only.
    InvalidLengthAuthCode:
      description: Incorrect length for Auth Code sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect Auth Code length.
            Recoverable: false
            Details: Authorization code should be 6 digits in length. Please provide a valid Authorization code.
    RejectedPlan:
      description: This example shows a consumer-selected plan that has been declined by a lender. Lenders can view the status of the plan after the decline.
      value:
        consumer:
          email: doe.jane@example.com
          isdCode: '1'
          mobile: '5551231234'
        merchant:
          acceptor: '100234'
          country: USA
          mcc: '1711'
          name: Decor shop
        offerId: '24092019'
        transactionOffers:
        - offerId: '24092019'
        - offerId: '87654321'
        planId: 3d56f5a7-db48-41f0-875e-30920e8465f3
        planInstallmentInformation:
          apr: 1.92
          currency: USD
          frequency: 15DAYS
          installmentAmount: 166.79
          installmentFee: 0
          tenure: 3
          totalAmount: 500.37
        providerId: 218b9962-1355-44e4-8a16-f911363fd849
        rejectReasonCode: LENDER_DRIVEN_REJECTION
        rejectReasonDetail: Customer's credit score is insufficient.
        scheduledRepayments:
        - amount: 166.79
          dueDate: '2022-05-30'
          installmentNumber: 1
        - amount: 166.79
          dueDate: '2022-06-13'
          installmentNumber: 2
        - amount: 166.79
          dueDate: '2022-06-27'
          installmentNumber: 3
        status: DECLINED
        transaction:
          amount: 400.11
          currency: USD
    InvalidLengthRRN:
      description: Incorrect Length for RRN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect RRN length.
            Recoverable: false
            Details: RRN should be 12 digits in length. Please provide a valid RRN.
    InvalidTransactionLinkId:
      description: Transaction link id is present and is more than 22 in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Invalid Transaction Link Id.
            Recoverable: false
            Details: Transaction link id should not be greater than 22. Please provide a valid transaction link id.
    InvalidPANLength:
      description: Incorrect length of PAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect PAN length.
            Recoverable: false
            Details: PAN should not be less than 11 and greater than 19 in length. Please provide a valid PAN.
    InvalidMerchantId:
      description: Merchant Id in request is invalid.
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: merchant.merchantId
            Description: size must be between 1 and 15
            Recoverable: false
            Details: ''
    InvalidMerchantURL:
      description: Merchant URL in request is invalid.
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: merchant.url
            Description: size must be between 1 and 50
            Recoverable: false
            Details: ''
    InvalidTokenPAN:
      description: Invalid Token PAN sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Detokenization failed due to incorrect DPAN.
            Recoverable: false
            Details: PAN provided is invalid.
    InvalidLengthMerchantName:
      description: Incorrect Merchant Name Length sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Merchant Name validation failed-Value has incorrect length.
            Recoverable: false
            Details: Merchant name should not be greater than 100 in length.
    InvalidTransactionCurrency:
      description: Provided transaction currency is not valid.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Currency Not Supported.
            Recoverable: false
            Details: Invalid transaction currency.
    NonNumericAuthCode:
      description: Non-Numeric Auth Code value sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Invalid Auth Code.
            Recoverable: false
            Details: .
    InvalidAcquirerId:
      description: Acquirer Id in request is invalid.
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: merchant.acquirerId
            Description: size must be between 1 and 6
            Recoverable: false
            Details: ''
    InvalidFrequency:
      description: Invalid frequency sent in the Plan API request for Installments on Cards.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Invalid frequency - 15DAYS.
            Recoverable: false
            Details: Frequency not valid for Installments on Card.
    InvalidLengthAcquirerId:
      description: Incorrect Length for Acquirer Id provided in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect Acquirer Id length.
            Recoverable: false
            Details: Acquirer Id should not be less than 1 and greater than 6 in length. Please provide a valid Acquirer Id.
    MethodNotAllowed:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: method.not.allowed
            Description: Method is not allowed
            Recoverable: false
    InvalidCardProductError:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.parameter
            Description: Product SPP is not available for the IND country
            Recoverable: false
            Details: ''
    ForbiddenError:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: forbidden
            Description: Your account is not approved to access the API or resource, kindly contact your Mastercard associate to get approval.
            Recoverable: false
            Details: ''
    InvalidFieldValue:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.body.parameter
            Description: Value doesn't exist / doesn't meet specified range
            Recoverable: false
            Details: ''
    InvalidCountryCode:
      description: Provided Country Code in request is invalid
      value:
        Errors:
          Error:
          - Source: mci-installments-offers-eligibilities-api
            ReasonCode: invalid.request.parameter
            Description: Country Code Not Supported
            Recoverable: false
            Details: ''
    InvalidAmountType:
      description: Incorrect value for Amount Type field sent in the Plan API request for **Installments on Cards**.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Incorrect value for Amount Type.
            Recoverable: false
            Details: Amount type must be 'PURCHASE' OR 'FINAL'.
    InvalidPresentedOffersDSP:
      description: Presented offers is required, along with the offer ID, if the client is classified as a distribution partner.
      value:
        Errors:
          Error:
          - Source: mci-installment-bnpl-plans-api
            ReasonCode: invalid.request.parameter
            Description: Both OfferId and TransactionOffers must be present for this client - Value must not be null
            Recoverable: false
            Details: Invalid input request for cardedInstallments.
  schemas:
    PlanIdField:
      type: string
      format: uuid
      description: A unique identifier assigned to an installment plan.
      example: 3d56f5a7-db48-41f0-875e-30920e8465f3
      maxLength: 36
      minLength: 36
    SensitiveDataField:
      type: object
      description: "Mandatory for Carded Installments\n     - Plain payload which contains Consumer Primary Account Number in encrypted format, refer example 'Carded Installments Offers Request Plain' to see payload (sensitiveData object) in plain format.\n     - Represented as the concatenation of the Base64 encoded JWE Protected Header, JWE Encrypted Key, JWE Initialization Vector, JWE Ciphertext, and JWE Authentication Tag separated by '.'"
      properties:
        consumer:
          properties:
            primaryAccountNumber:
              type: number
              description: Consumer Credit or Debit card number (PAN) to offer Installments (ISO-DE2). This field can contain both funding and tokenized PAN. For 'Carded Installments', this will be mandatory parameter.
              maxLength: 19
              minLength: 11
              example: 5110921032063789
          required:
          - primaryAcco

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