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 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 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
|
Payment options including the payment plan products You must submit a WS API PAYMENT_OPTIONS_INQUIRY request to inquire about
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
|
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
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.
You then submit an UPDATE_PAYMENT_PLAN_OFFER request. The request must contain
The response indicates if you can proceed with the order, including this offer. If
|
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}.namepaymentPlanProduct.{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}.paymentPlanProductIdpaymentPlanOffer{id}.totalAmountpaymentPlanOffer{id}.numberOfPaymentspaymentPlanOffer{id}.subsequentPaymentAmountpaymentPlanOffer{id}.firstPaymentAmountpaymentPlanOffer{id}.deferalPeriodpaymentPlanOffer{id}.interest.ratepaymentPlanOffer{id}.interest.discountAmountpaymentPlanOffer{id}.feeAmountpaymentPlanOffer{id}.cashAward.amountpaymentPlanOffer{id}.cashAward.payerInstructionTextpaymentPlanOffer{id}.qualifier.descriptionpaymentPlanOffer{id}.qualifier.logoUrlpaymentPlanOffer{id}.minimumAmountpaymentPlanOffer{id}.maximumAmountItem 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:
merchantpayerlocalecurrencyitem[0].skuitem[0].unitPriceitem[1].skuitem[1].unitPriceThe 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}.namepaymentPlanProduct.{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}.paymentPlanProductIditem[n].paymentPlanOffer.{id}.currencyitem[n].paymentPlanOffer.{id}.totalAmountitem[n].paymentPlanOffer.{id}.numberOfPaymentsitem[n].paymentPlanOffer.{id}.deferalPerioditem[n].paymentPlanOffer.{id}.subsequentPaymentAmountitem[n].paymentPlanOffer{id}.firstPaymentAmountitem[n].paymentPlanOffer{id}.interest.rateitem[n].paymentPlanOffer{id}.interest.discountAmountitem[n].paymentPlanOffer{id}.feeAmountitem[n].paymentPlanOffer{id}.cashAward.amountitem[n].paymentPlanOffer{id}.cashAward.payerInstructionTextitem[n].paymentPlanOffer{id}.qualifier.descriptionitem[n].paymentPlanOffer{id}.qualifier.logoUrlresult
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:
payerLocaleorder.amountorder.currencyorder.item[n].skuorder.item[n].quantityorder.item[n].unitPriceorder.itemAmountsourceOfFunds.provided.card.prefix
From version 70 onwards, the response contains the payment plan products supported which is "Paylater Installments":
paymentPlanProduct.{paymentPlanProductId}paymentPlanProduct.{paymentPlanProductId}.namepaymentPlanProduct.{paymentPlanProductId}.logoUrlEach payment plan offer has a unique offer ID and the corresponding payment plan product ID:
paymentTypes.card.paymentPlanOffer.{id}paymentTypes.card.paymentPlanOffer.{id}.paymentPlanProductIdpaymentTypes.card.paymentPlanOffer.{id}.numberofPaymentspaymentTypes.card.paymentPlanOffer.{id}.deferralPeriodpaymentTypes.card.paymentPlanOffer.{id}.interest.chargedpaymentTypes.card.paymentPlanOffer.{id}.currencypaymentTypes.card.paymentPlanOffer.{id}.minimumOrderAmountpaymentTypes.card.paymentPlanOffer.{id}.startDatepaymentTypes.card.paymentPlanOffer.{id}.endDatepaymentTypes.card.paymentPlanOffer.{id}.totalAmountpaymentTypes.card.paymentPlanOffer.{id}.firstPaymentAmountpaymentTypes.card.paymentPlanOffer.{id}.subsequentPaymentAmountpaymentTypes.card.paymentPlanOffer.{id}.feeAmountpaymentTypes.card.paymentPlanOffer.{id}.interest.ratepaymentTypes.card.paymentPlanOffer.{id}.interest.discountAmountpaymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.textpaymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.acceptanceRequiredpaymentTypes.card.paymentPlanOffer.{id}.termsAndConditions.acceptanceTextpaymentTypes.card.paymentPlanOffer.{id}.cashAward.amountpaymentTypes.card.paymentPlanOffer.{id}.cashAward.payerInstructionTextpaymentTypes.card.paymentPlanOffer.{id}.qualifier.textpaymentTypes.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 grouporder.amountorder.currencyorder.item[n].quantityorder.item[n].unitPrice
You can provide the details for the payer acceptance by indicating:
paymentPlanOffer.payerAcceptance = truepaymentPlanOffer.termsAndConditionsDisplayValue 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.