Paylater Installments

The Paylater Installments allow the payers to pay for their purchases and make monthly installments until the amount is paid in full.

The Paylater Installments provides:

  • Generic offers: The payment plans that you want to offer which are not specific to the items, products, or cart.
  • Item offers: The payment plans that you want to offer for a specific item or a product.
  • Cart offers: The payment plans that you want to offer for a cart with one or more items or products.

The Paylater Installments payment plan terms may contain following:

  • Deferral period where a payer can choose to defer their first payment.
  • Interest rate component or interest-free payment plans from the issuing bank.
  • Cash awards for choosing certain payment plans.

Integration steps

Plan Name Plan Identifier Description API to use

1

Payer visits to your website

You want to know if there are generic payment plan offers that can be presented.

Shopping Options Inquiry

You must submit a WS API SHOPPING_OPTIONS_INQUIRY request to inquire about payment plan offers for the merchant.

The response contains a list of payment plan offers for the merchant.

2

Payer is browsing a category or performing a product search

You want to display the payment plan offers available for each item in the list.

Item Payment Plan Offers

You must submit a WS API ITEM_PAYMENT_PLAN_OFFERS request to inquire about the payment plan offers for a list of items.

The response contains a list of payment plan offers for the item.

3

Payer is viewing a product details Page

You want to display the payment plan offers for this item

Item Payment Plan Offers

You must submit a WS API ITEM_PAYMENT_PLAN_OFFERS request to inquire about the payment plan offers for a single item (that is, the list only contains a single item).

The response contains a list of payment plan offers for the item.

4

Payer is viewing the cart and indicates that they want to check out or on the checkout page.

You want to display

  • the list of available payment methods
  • the list of available Payment Plan Products

Payment options including the payment plan products

You must submit a WS API PAYMENT_OPTIONS_INQUIRY request to inquire about

  • available payment plan products
  • available payment methods

    • The response contains payment plan product as "Paylater Installments".

5

Payer has selected the payment plan product as "Paylater Installments"

You want to display all payment plan offers for this payment plan product

Payment options including the payment plan products

You must submit a WS API PAYMENT_OPTIONS_INQUIRY request to inquire about available payment plan offer for this payment plan product

The response contains a list of payment plan offers for the cart or order, and payment plan product.

6

Payer has provided the BIN of the card (as they enter the card number)

Depending on the BIN of the card the you want to display

  • available payment plan offers for this cart or order, and BIN

Payment options including the payment plan offers for the cart or order

You must submit a WS API PAYMENT_OPTIONS_INQUIRY request to inquire about

  • available payment plan offers for the cart/order with the card number.

The response contains a list of payment plan offers for the cart or order, and BIN.

7

Payer accepts the cart payment plan offer and agrees to the terms and conditions

You want to submit the payer's acceptance of the offer.

If the payer selects one of the offers within that payment method as "Paylater Installments", you must provide the terms and conditions returned in the PAYMENT_OPTIONS_INQUIRY response for cart offers and the payer must accept the offer to proceed with this payment plan.

Accept Offer

You display the terms and conditions (details for which are provided in the PAYMENT_OPTIONS_INQUIRY response) to the payer.

The payer accepts the terms and conditions.

  • Where the PAYMENT_OPTIONS_INQUIRY response contains paymentPlanOffer{id}.termsAndConditions.acceptanceRequired=true then you need to display the specific acceptance text and get the payer to actively tick a checkbox.

You then submit an UPDATE_PAYMENT_PLAN_OFFER request.

The request must contain

  • a list of all items (SKUs) in the cart
  • the order amount and currency
  • the plan offer ID of the cart payment plan offer that the payer has accepted
  • the card number
  • an indicator that the terms and conditions have been accepted.

The response indicates if you can proceed with the order, including this offer. If

  • Yes:
      The response indicates if the acceptance is conditional or not. If it is
    • not conditional: you must proceed with submitting a WS API AUTHORIZE or PAY request with the plan offer ID of the accepted offer.
    • conditional: you must provide additional information requested by submitting another UPDATE_PAYMENT_PLAN_OFFER request.
  • no: You may tell the payer that the offer is no longer available.
    • If the payer agrees to proceed without the payment plan, you can still submit a WS API AUTHORIZE or PAY request, but that request must not contain any plan offer ID.
    • Alternatively, you may ask the payer to select another cart payment plan offer.

8

Payer proceeds with the payment

-

Authorize or Pay Request

The merchant submits a WS API AUTHORIZE or PAY request with the plan offer ID of the accepted offer.

The cart payment plan offer that the payer has accepted now becomes the payment plan for the order or transaction.

Payment Options Inquiry API Reference [REST][NVP]

Shopping options enquiry

You can request the gateway for a list of valid generic plan offers using the Shopping Options Inquiry operation. The following details about the supported payment plans are returned:

From the version 70 onwards, the response contains the supported payment plan products, which is "Paylater Installments":

  • paymentPlanProduct.{paymentPlanProductId}
  • paymentPlanProduct.{paymentPlanProductId}.name
  • paymentPlanProduct.{paymentPlanProductId}.logoUrl

Each payment plan offer has a unique offer ID and the corresponding payment plan product ID:

  • paymentPlanOffer.{id}
  • paymentPlanOffer.{id}.currency (populated with payerCurrency from request)
  • paymentPlanOffer{id}.paymentPlanProductId
  • paymentPlanOffer{id}.totalAmount
  • paymentPlanOffer{id}.numberOfPayments
  • paymentPlanOffer{id}.subsequentPaymentAmount
  • paymentPlanOffer{id}.firstPaymentAmount
  • paymentPlanOffer{id}.deferalPeriod
  • paymentPlanOffer{id}.interest.rate
  • paymentPlanOffer{id}.interest.discountAmount
  • paymentPlanOffer{id}.feeAmount
  • paymentPlanOffer{id}.cashAward.amount
  • paymentPlanOffer{id}.cashAward.payerInstructionText
  • paymentPlanOffer{id}.qualifier.description
  • paymentPlanOffer{id}.qualifier.logoUrl
  • paymentPlanOffer{id}.minimumAmount
  • paymentPlanOffer{id}.maximumAmount

    • Item Payment Plan Offers

    You can request the gateway for a list of valid plan offers for specific item using the Item Payment Plan Offers operation.

    The request contains the following details:

  • merchant
  • payerlocale
  • currency
  • item[0].sku
  • item[0].unitPrice
  • item[1].sku
  • item[1].unitPrice

    • The following details about the supported payment plans are returned. From version 70 onwards, the response contains the payment plan products supported which is "Paylater Installments":

    • paymentPlanProduct.{paymentPlanProductId}
    • paymentPlanProduct.{paymentPlanProductId}.name
    • paymentPlanProduct.{paymentPlanProductId}.logoUrl

    Each payment plan offer has a unique offer ID and the corresponding payment plan product ID:

    • item[n].paymentPlanOffer.{id}
    • item[n].paymentPlanOffer.{id}.paymentPlanProductId
    • item[n].paymentPlanOffer.{id}.currency
    • item[n].paymentPlanOffer.{id}.totalAmount
    • item[n].paymentPlanOffer.{id}.numberOfPayments
    • item[n].paymentPlanOffer.{id}.deferalPeriod
    • item[n].paymentPlanOffer.{id}.subsequentPaymentAmount
    • item[n].paymentPlanOffer{id}.firstPaymentAmount
    • item[n].paymentPlanOffer{id}.interest.rate
    • item[n].paymentPlanOffer{id}.interest.discountAmount
    • item[n].paymentPlanOffer{id}.feeAmount
    • item[n].paymentPlanOffer{id}.cashAward.amount
    • item[n].paymentPlanOffer{id}.cashAward.payerInstructionText
    • item[n].paymentPlanOffer{id}.qualifier.description
    • item[n].paymentPlanOffer{id}.qualifier.logoUrl
    • result

    Payment Plan Inquiry

    You can request the gateway for a list of valid payment plan products and plan offers using the Payment Options Inquiry operation.

    The request contain:

    • payerLocale
    • order.amount
    • order.currency
    • order.item[n].sku
    • order.item[n].quantity
    • order.item[n].unitPrice
    • order.itemAmount
    • sourceOfFunds.provided.card.prefix

    From version 70 onwards, the response contains the payment plan products supported which is "Paylater Installments":

  • paymentPlanProduct.{paymentPlanProductId}
  • paymentPlanProduct.{paymentPlanProductId}.name
  • paymentPlanProduct.{paymentPlanProductId}.logoUrl

    • Each payment plan offer has a unique offer ID and the corresponding payment plan product ID:

    • paymentTypes.card.paymentPlanOffer.{id}
    • paymentTypes.card.paymentPlanOffer.{id}.paymentPlanProductId
    • paymentTypes.card.paymentPlanOffer.{id}.numberofPayments
    • paymentTypes.card.paymentPlanOffer.{id}.deferralPeriod
    • paymentTypes.card.paymentPlanOffer.{id}.interest.charged
    • paymentTypes.card.paymentPlanOffer.{id}.currency
    • paymentTypes.card.paymentPlanOffer.{id}.minimumOrderAmount
    • paymentTypes.card.paymentPlanOffer.{id}.startDate
    • paymentTypes.card.paymentPlanOffer.{id}.endDate
    • paymentTypes.card.paymentPlanOffer.{id}.totalAmount
    • paymentTypes.card.paymentPlanOffer.{id}.firstPaymentAmount
    • paymentTypes.card.paymentPlanOffer.{id}.subsequentPaymentAmount
    • paymentTypes.card.paymentPlanOffer.{id}.feeAmount
    • paymentTypes.card.paymentPlanOffer.{id}.interest.rate
    • paymentTypes.card.paymentPlanOffer.{id}.interest.discountAmount
    • paymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.text
    • paymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.acceptanceRequired
    • paymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.acceptanceText
    • paymentTypes.card.paymentPlanOffer.{id}.cashAward.amount
    • paymentTypes.card.paymentPlanOffer.{id}.cashAward.payerInstructionText
    • paymentTypes.card.paymentPlanOffer.{id}.qualifier.text
    • paymentTypes.card.paymentPlanOffer.{id}.qualifier.logoUrl

    Update Payment Plan Offers

    You can submit payer acceptance of the payment plan offers to the provider by using Update Payment Plan Offers Operation.

      The request contains:
    • sourceOfFunds parameter group
    • order.amount
    • order.currency
    • order.item[n].quantity
    • order.item[n].unitPrice

    You can provide the details for the payer acceptance by indicating:

    • paymentPlanOffer.payerAcceptance = true
    • paymentPlanOffer.termsAndConditionsDisplay

      Value can be one of the following:

      • NONE - you did not display any terms and conditions text.
      • TERMS_AND_CONDITIONS_ONLY - you displayed terms and conditions text.
      • TERMS_AND_CONDITIONS_AND_ACCEPTANCE - you displayed terms and conditions text as well as enforced payer to accept the terms and conditions.

    Submit a transaction with the Payment Plan

    To submit a transaction with the payment plan selected by the payer, provide the following fields in an Authorize/Pay or Update Session request. From the version 70 onwards, provide paymentPlan.offerID field with the offer ID in the Payment Options Inquiry response.

    The gateway processes a payment plan only if the following conditions are met:

    • The order currency is supported on the payment plan.
    • The order amount exceeds the minimum order amount defined on the payment plan.
    • The card type is supported on the payment plan.

    Copyright © 2023 Mastercard