Mastercard Plans API

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

Documentation GitHub OpenAPI

Operations 2

POST /plans Notify Mastercard when a consumer chooses a previously presented offer, which is henceforth called as an Installment Plan. #

GET /plans/{plan_id} Retrieves Buy Now, Pay Later installment plan. #

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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

All 92 tools →

Call it yourself

curl for this page

This API

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

All apis

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

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Mastercard Installments Plans API
  description: The Mastercard Installments program enables financial institutions, licensed lenders, fintechs, and Buy Now, Pay Later (BNPL) players to offer installment plans before, during, and post purchase. This can be done by utilizing either existing or new lines of consumer credit.
  contact:
    name: API Support
    email: apisupport@mastercard.com
    url: https://developer.mastercard.com/support
  version: 2.0.0
servers:
- url: https://sandbox.api.mastercard.com/installments
  description: Sandbox
- url: https://api.mastercard.com/installments
  description: Production
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:
    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'
    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'
    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'
    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'
    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'
    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'
    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.'
    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.

        '
    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.
  schemas:
    Consumer:
      type: object
      properties:
        email:
          type: string
          description: Consumer's email address. Hashed for pre-approved consumer, raw for consumer without pre-approval.
          example: jane.doe@example.com
          maxLength: 254
          minLength: 5
        isdCode:
          type: string
          description: ISD code of the consumer's mobile number.
          example: '1'
          maxLength: 5
          minLength: 1
        mobile:
          type: string
          description: Consumer's mobile number. Hashed for pre-approved consumer, raw for consumer without pre-approval.
          example: '5550009999'
          maxLength: 64
          minLength: 4
        providerConsumerId:
          type: string
          format: uuid
          description: Unique user ID provided by the Installment Program Provider. This is specific to the provider. (External user/consumer id). Applicable only for pre-approved consumers.
          example: 3d56f5a7-db48-41f0-875e-30920e8465f3
          maxLength: 36
          minLength: 36
    ErrorWrapper:
      title: ErrorWrapper
      type: object
      description: The error response object which gets returned in case of any error.
      required:
      - Errors
      properties:
        Errors:
          $ref: '#/components/schemas/Errors'
    InstallmentPlan:
      type: object
      properties:
        consumer:
          $ref: '#/components/schemas/Consumer'
        merchant:
          $ref: '#/components/schemas/MerchantPlan'
        offerId:
          $ref: '#/components/schemas/OfferIdField'
        planId:
          $ref: '#/components/schemas/PlanIdField'
        planInstallmentInformation:
          $ref: '#/components/schemas/PlanInstallmentInformation'
        providerId:
          $ref: '#/components/schemas/ProviderIdField'
        rejectReasonCode:
          type: string
          description: Describes the reason for plan rejection. Mandatory for when status is DECLINED. Following are the reject reason codes:[ CONSUMER_AUTH_FAIL, CONSUMER_APPLICATION_FAIL, CONSUMER_CANCELLATION, LENDER_DRIVEN_REJECTION, LENDER_SYSTEM_ERROR, OTHER_REASON ]
          example: CONSUMER_CANCELLATION
          maxLength: 30
          minLength: 12
        rejectReasonDetail:
          type: string
          description: Indicates detailed information about reject reason.
          example: Credit score is too low
          maxLength: 5000
          minLength: 0
        scheduledRepayments:
          $ref: '#/components/schemas/ScheduledRepayments'
        status:
          $ref: '#/components/schemas/StatusField'
        transaction:
          $ref: '#/components/schemas/Transaction'
        transactionOffers:
          $ref: '#/components/schemas/TransactionOffers'
      required:
      - merchant
      - planId
      - providerId
      - status
      - transaction
    CardedTransaction:
      allOf:
      - $ref: '#/components/schemas/Transaction'
      - type: object
        properties:
          amountType:
            type: string
            description: Transaction amount type. Possible values can be PURCHASE, FINAL.
            example: PURCHASE
          stan:
            description: The System Trace Audit Number (STAN) for this transaction. (ISO DE-11).
            type: string
            minLength: 1
            maxLength: 6
            example: 123456
          rrn:
            description: The Retrieval Reference Number (RRN) for this transaction. (ISO DE-37).
            type: string
            minLength: 0
            maxLength: 12
            example: 123456123456
          authorizationCode:
            description: Value generated by the issuing bank in response to a proposal to transfer funds (ISO DE-38).
            type: string
            minLength: 0
            maxLength: 6
            example: 123456
          localDateTime:
            description: Transaction local date. [Date and Time RFC](https://datatracker.ietf.org/doc/html/rfc3339). (ISO DE-12, ISO DE-13). If amount type is purchase then populate purchase date time else populate ISO transaction date time.
            type: string
            example: '2023-01-01T00:00:00Z'
          transmissionDateTime:
            description: Transaction transmission date. [Date and Time RFC](https://datatracker.ietf.org/doc/html/rfc3339). (ISO DE-7).
            type: string
            example: '2023-01-01T00:00:00Z'
          transactionLinkId:
            description: Unique Value generated by Mastercard to track the transaction (ISO DE-105).
            type: string
            minLength: 0
            maxLength: 22
            example: 123456dasda123456
        required:
        - amountType
    PlanPost:
      type: object
      properties:
        offerTransactionId:
          $ref: '#/components/schemas/OfferTransactionIdField'
        merchant:
          $ref: '#/components/schemas/CardedMerchant'
        offerId:
          $ref: '#/components/schemas/OfferIdField'
        planInstallmentInformation:
          $ref: '#/components/schemas/CardedPlanInstallmentInformation'
        providerId:
          $ref: '#/components/schemas/ProviderIdField'
        schedulePayments:
          $ref: '#/components/schemas/PlanSchedulePayments'
        transaction:
          $ref: '#/components/schemas/CardedTransaction'
        sensitiveData:
          $ref: '#/components/schemas/SensitiveDataField'
        transactionOffers:
          $ref: '#/components/schemas/TransactionOffers'
      required:
      - providerId
      - transaction
      - offerTransactionId
    CardedMerchant:
      allOf:
      - $ref: '#/components/schemas/PlanMerchant'
      - type: object
        properties:
          name:
            description: Merchant legal name or "doing business as" name. For 'Mastercard Installments Payment Services', this will be optional parameter.
            type: string
            minLength: 1
            maxLength: 100
            example: Globex Decor
          url:
            description: URL for the Merchant .
            type: string
            minLength: 1
            maxLength: 50
            example: www.globexdecor.com
          acquirerId:
            description: Acquiring Institution ID Code to identifies the acquiring institution. (ISO DE-32).
            type: string
            minLength: 1
            maxLength: 6
            example: '456789'
          merchantId:
            description: Merchant ID assigned by Acquirer. (ISO DE-42).
            type: string
            minLength: 1
            maxLength: 15
            example: '456789'
    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:
          - primaryAccountNumber
    Error:
      title: Error
      type: object
      description: Error object which contains details about the Error.
      required:
      - Source
      - ReasonCode
      - Description
      - Recoverable
      properties:
        Source:
          type: string
          description: The application name that generated this error.
          minLength: 1
          maxLength: 100
          example: Mastercard Installments APIs
        ReasonCode:
          type: string
          description: A unique constant identifying the error case encountered during request processing.
          minLength: 1
          maxLength: 100
          example: invalid.request.parameter
        Description:
          type: string
          description: Short description of the ReasonCode field.
          minLength: 10
          maxLength: 1000
          example: One of the request parameters is invalid, try again with the correct request.
        Recoverable:
          type: boolean
          description: Indicates whether this error will always be returned for this request, or retrying could change the outcome.
          example: false
        Details:
          type: string
          description: (Optional) Where appropriate, indicates detailed information about data received and calculated during request processing, to help the user with diagnosing errors.
          minLength: 0
          maxLength: 5000
          example: paymentCardId size must be between 36 and 36
    Errors:
      title: Errors
      type: object
      description: Error object which returns the list of Error objects.
      required:
      - Error
      properties:
        Error:
          $ref: '#/components/schemas/ErrorList'
    TransactionOffers:
      type: array
      description: A list of offers presented to the consumer. This is a mandatory field for During Purchase use case of Mastercard Installments Payment Services.
      items:
        $ref: '#/components/schemas/TransactionOffer'
      maxItems: 50
    CardedPlanInstallmentInformation:
      allOf:
      - $ref: '#/components/schemas/PlanInstallmentInformation'
      - type: object
        properties:
          firstInstallmentAmount:
            type: number
            format: double
            description: Amount to be paid for the first installment.
            example: 100
            maximum: 1000000000000000
            minimum: 0
          otherInstallmentAmount:
            type: number
            format: double
            description: Subsequent Installment amount with minor unit according to ISO 4217.
            example: 200
            maximum: 1000000000000000
            minimum: 0
          feeValue:
            type: number
            format: double
            description: Fees values based on type it can be either Fixed amount or Percentage to applied in transaction amount. This is mandatory for 'Mastercard Installments Payment Services product.
            example: 2.05
            maximum: 1000000000000000
            minimum: 0
    TransactionOffer:
      type: object
      properties:
        offerId:
          type: string
          description: unique identifier for installment offers.
          example: '24092019'
          maxLength: 64
          minLength: 8
      required:
      - offerId
    CreatedInstallmentPlan:
      type: object
      properties:
        planId:
          $ref: '#/components/schemas/PlanIdField'
        status:
          $ref: '#/components/schemas/StatusField'
    MerchantPlan:
      type: object
      properties:
        acceptor:
          type: string
          description: Merchant acceptor identifier.
          example: '100234'
          maxLength: 100
          minLength: 1
        country:
          type: string
          description: Country code in ISO 3166 alpha 3 format.
          example: USA
          maxLength: 3
          minLength: 3
        mcc:
          type: string
          description: Merchant Category Code.
          example: '1711'
          maxLength: 4
          minLength: 4
        name:
          type: string
          description: Merchant name for plan.
          example: Decor shop
          maxLength: 100
          minLength: 1
      required:
      - country
      - mcc
    PlanInstallmentInformation:
      type: object
      description: This object is mandatory for **Mastercard Installments Payment Services**.
      properties:
        apr:
          type: number
          format: double
          description: Annual Percentage Rate (APR).
          example: 25.03
          maximum: 200
          minimum: 0
        currency:
          type: string
          description: Currency code according to ISO 4217.
          example: USD
          maxLength: 3
          minLength: 3
        frequency:
          type: string
          description: Frequency of installment (single installment time duration).It will be one of the [WEEKLY, BIWEEKLY, MONTHLY]
          example: BIWEEKLY
          maxLength: 20
          minLength: 3
        firstInstallmentAmount:
          type: number
          format: double
          description: Amount to be paid for the first installment.
          example: 100
          maximum: 1000000000000000
          minimum: 0
        otherInstallmentAmount:
          type: number
          format: double
          description: Subsequent Installment amount with minor unit according to ISO 4217.
          example: 200
          maximum: 1000000000000000
          minimum: 0
        feeValue:
          type: number
          format: double
          description: Fees values based on type it can be either Fixed amount or Percentage to applied in transaction amount.
          example: 2.05
          maximum: 1000000000000000
          minimum: 0
        tenure:
          type: integer
          format: int32
          description: Total number of installments for an offer. Offer tenure.
          example: 2
          maximum: 99
          minimum: 2
        totalAmount:
          type: number
          format: double
          description: The total amount owed by the cardholder on an installment purchase inclusive of fees, tax and interest for the installment plan.
          example: 200
          maximum: 1000000000000000
          minimum: 0
      required:
      - frequency
      - tenure
    StatusField:
      type: string
      description: 'Current status of a plan. One of: CREATED, APPROVED, DECLINED, TIMED_OUT.'
      example: CREATED
      maxLength: 12
      minLength: 7
    OfferIdField:
      type: string
      description: Unique identifier for installment offers. This is mandatory for 'Mastercard Installments Payment Services product.
      example: '24092019'
      maxLength: 64
      minLength: 8
    ScheduledRepayments:
      type: array
      description: This object will be populated only when consumer offer selection is enabled.
      items:
        $ref: '#/components/schemas/ScheduledRepayment'
      maxItems: 99
    PlanIdField:
      type: string
      format: uuid
      description: A unique identifier assigned to an installment plan.
      example: 3d56f5a7-db48-41f0-875e-30920e8465f3
      maxLength: 36
      minLength: 36
    ProviderIdField:
      type: string
      format: uuid
      description: Provider ID is internal ID generated by Configuration API.
      example: 3d56f5a7-db48-41f0-875e-30920e8465f3
      maxLength: 36
      minLength: 36
    SchedulePayment:
      type: object
      description: Schedule Payments of the offer selected by cardholder. This object is mandatory for **Mastercard Installments Payment Services**.
      properties:
        installmentAmount:
          type: number
          format: double
          description: Amount to be paid in an installment. This is mandatory for 'Mastercard Installments Payment Services product.
          example: 100
          maximum: 1000000000000000
          minimum: 0
        dueDate:
          type: string
          description: Due date for an installment. This is mandatory for 'Mastercard Installments Payment Services product.
          example: 2023-5-21
          maxLength: 10
          minLength: 8
        installmentNumber:
          type: integer
          format: int32
          description: Number of an installment. This is mandatory for 'Mastercard Installments Payment Services product.
          example: 1
          maximum: 99
          minimum: 1
    PlanMerchant:
      type: object
      properties:
        country:
          type: string
          description: Country code in ISO 3166 alpha 3 format.
          example: USA
          maxLength: 3
          minLength: 3
        mcc:
          type: string
          description: Merchant Category Code.
          example: '1711'
          maxLength: 4
          minLength: 4
        url:
          description: URL for the Merchant.
          type: string
          minLength: 1
          maxLength: 50
          example: www.globexdecor.com
        acquirerId:
          description: Acquiring Institution ID Code to identifies the acquiring institution. (ISO DE-32).
          type: string
          minLength: 1
          maxLength: 6
          example: '456789'
        merchantId:
          description: Merchant ID assigned by Acquirer. (ISO DE-42).
          type: string
          minLength: 1
          maxLength: 15
          example: '456789'
    PlanSchedulePayments:
      type: array
      description: List of installments as per Schedule payments.
      items:
        $ref: '#/components/schemas/SchedulePayment'
      maxItems: 99
    ScheduledRepayment:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        dueDate:
          type: string
          description: Due date for an installment.
          example: 2022-5-21
          maxLength: 10
          minLength: 8
        installmentNumber:
          type: integer
          format: int32
          description: Number of an installment.
          example: 1
          maximum: 99
          minimum: 1
    ErrorList:
      type: array
      minItems: 1
      items:
        $ref: '#/components/schemas/Error'
    Transaction:
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          type: string
          description: Currency code according to ISO 4217.
          example: USD
          maxLength: 3
          minLength: 3
      required:
      - amount
      - currency
    Amount:
      type: number
      format: double
      description: Amount to be paid in an installment.
      example: 100
      maximum: 9999999999999.99
      minimum: 0
    OfferTransactionIdField:
      type: string
      description: Unique identifier for installment offers presentment transaction. It will be snowflake identifier format.
      example: '1763137029152964608'
      minLength: 8
      maxLength: 40
  examples:
    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: ''
    InvalidFieldLength:
      value:
        Errors:
          Error:
          - Source: Mastercard Installments API's
            ReasonCode: invalid.request.body.parameter
            Description: Field length is out of bound
            Recoverable: false
            Details: ''
    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.
    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.
    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: .
    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'.
    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.
    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: fal

# --- 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

Mastercard Plans API

Operations 2

Documentation

Specifications

Code Examples

Other Resources