- Integration Guidelines
- Integrating the Merchant Boarding API
- Update Merchant Acquirer Link
- Payment Plan Information
Payment Plan Information
This page describes information on payment plans that you are required to provide when enabling payment plans on a merchant acquirer link.
Custom Payment Plans
Custom payment plans are based on a template-instance system, where you can create instances of one of 5 payment plan templates by specifying the number of installments and the deferral period (where applicable). For more information, see custom payment plans.
You must provide a plan ID (see column 1) in field merchant.acquirerLink.paymentPlan[n].planId to enable a custom payment plan on the merchant acquirer link.
| Plan ID | Short Description | Long Description |
|---|---|---|
| BPWOI | Pay in installments, interest-free | Payer pays in a number of installments, commencing at the time of the purchase and where no interest is charged. |
| BPLWI | Pay in installments after a deferral period, with interest | Payer pays in a number of installments, commencing after a number of months and where interest is charged. |
| BPWI | Pay in installments, with interest | Payer pays in a number of installments, commencing at the time of the purchase and where interest is charged. |
| BPL | Pay in full after a deferral period | Payer pays in full, commencing after a number of months. |
| BPLWOI | Pay in installments after a deferral period, interest-free | Payer pays in a number of installments, commencing after a number of months and where no interest is charged. |
Plan N and Plan Amex
Plan N is a payment plan offered by American Express in some countries, which allows payers to defer payments for purchases from an eligible merchant into monthly installments. Plan Amex, also known as Deferred Payment Plan (DPP), is a payment plan offered by American Express where the merchant is paid in full less applicable discount rate; and the payer is billed in installments plus the applicable interest rate. For more information on these plans, see Plan N and Plan Amex.
You must provide a plan ID (see column 1) in field merchant.acquirerLink.paymentPlan[n].planId and a value for the maximum number of installment in the field merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments to enable a Plan N or Plan Amex payment plan on the merchant acquirer link.
| Plan ID | Short Description | Long Description | Allowed Number of Installments |
|---|---|---|---|
| planN_MEX | American Express Plan N Deferred Payment Plan for Mexico | Payer pays in a number of installments. | 3, 6, 9, 12, 13, 15, 18, 20, 21, 24 |
| planAmex_MEX | American Express Plan Amex Deferred Payment Plan for Mexico | Payer pays in a number of installments. | 2 to 12 |
Plan Cielo
Cielo is a payment plan which allows you to enter installment information on transactions processed by the Cielo acquirer. For more information, see Cielo.
You must provide a plan ID (see column 1) in field merchant.acquirerLink.paymentPlan[n].planId and a value for the maximum number of installments in the field merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments to enable a Cielo payment plan on the merchant acquirer link.
| Plan ID | Short Description | Long Description | Allowed Number of Installments |
|---|---|---|---|
| Cielo | Cielo, pay in installments | Payer pays in a number of installments for transactions processed by the Cielo acquirer. Appicable only to merchants in Brazil on transactions in the Brazilian Lira currency and on cards issued inside of Brazil. | 2 to 99 |
Plan Redecard
Redecard is a payment plan which allows you to enter installment information on transactions processed by the Redecard acquirer. For more information, see Redecard.
You must provide a plan ID (see column 1) in field merchant.acquirerLink.paymentPlan[n].planId and a value for the maximum number of installments in the field merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments to enable a Redecard payment plan on the merchant acquirer link.
| Plan ID | Short Description | Long Description | Allowed Number of Installments |
|---|---|---|---|
| Redecard | Redecard, pay in installments | Payer pays in a number of installments for transactions processed by the Cielo acquirer. Appicable only to merchants in Brazil on transactions in the Brazilian Lira currency and on cards issued inside of Brazil. | 2 to 99 |
Banorte Payment Plans
Banorte offers three types of payment plans. These plans apply only to Pay transactions in the Mexican Peso currency. For more information, see Banorte.
You must provide a plan ID (see column 1) in field merchant.acquirerLink.paymentPlan[n].planId and a value for the maximum number of installments in the field merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments, and optionally the deferral period in merchant.acquirerLink.paymentPlan[n].fixedNumberOfDeferrals to enable each of the Banorte payment plans on the merchant acquirer link.
| Plan ID | Short Description | Long Description | Allowed Number of Installments | Allowed Number of Deferrals |
|---|---|---|---|---|
| Banorte_Without_Interest | Banorte, pay in installments, with or without a deferral period, interest-free | Payer pays in a number of installments where no interest is charged. Payment can commence either at the time of the purchase or after a number of months of deferral period. | 3, 6, 9, 12, 18 | 1-99 |
| Banorte_With_Interest | Banorte, pay in installments, with or without a deferral period, with interest | Payer pays in a number of installments where interest is charged. Payment can commence either at the time of the purchase or after a number of months of deferral period. | 3, 6, 9, 12, 18 | 1-99 |
| Banorte_Full_Payment_With_Deferral | Banorte, pay in full after a deferral period | Payer pays in full, commencing after a number of months of deferral period. | 1 | 1-99 |
UniCredit Bank Payment Plan
The UniCredit payment plan in Romania allows payers to pay in monthly installments until the amount is paid in full. It supports EUR, RON, and USD currencies. For more information, see UniCredit.
Provide the following fields on the Update Acquirer Link request to enable UniCredit payment plan:
merchant.acquirerLink.paymentPlan[n].planId: This is a mandatory field. See Plan ID value in column 1.merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments: (Optional) The maximum number of installments.merchant.acquirerLink.paymentPlan[n].minimumOrderAmounts[n].amount: (Optional) You can configure a minimum order amount for which the payment plan will be offered, for each supported currency.merchant.acquirerLink.paymentPlan[n].minimumOrderAmounts[n].currency: (Optional) The currency of the minimum order amount expressed as an ISO 4217 alpha code, e.g. USD. This field is required if you configure a minimum order amount.
| Plan ID | Short Description | Long Description | Allowed Number of Installments |
|---|---|---|---|
| Unicredit | UniCredit Bank Payment Plan | Payer pays in a number of installments. | 1 to 99 |
National Bank of Greece (NBG) Payment Plan
The National Bank of Greece (NBG) payment plan allows payers to defer payment for their purchase(s) and pay in monthly installments until the amount is paid in full. The NBG payment plan supports EUR and USD currencies. For more information, see National Bank of Greece (NBG).
Provide the following fields on the Update Acquirer Link request to enable NBG payment plan:
merchant.acquirerLink.paymentPlan[n].planId: This is a mandatory field. See Plan ID value in column 1.merchant.acquirerLink.paymentPlan[n].maxNumberOfInstallments: (Optional) The maximum number of installments.merchant.acquirerLink.paymentPlan[n].fixedNumberOfDeferrals: (Optional) The deferral period.merchant.acquirerLink.paymentPlan[n].minimumOrderAmounts[n].amount: (Optional) You can configure a minimum order amount for which the payment plan will be offered, for each supported currency.merchant.acquirerLink.paymentPlan[n].minimumOrderAmounts[n].currency: (Optional) The currency of the minimum order amount expressed as an ISO 4217 alpha code, e.g. USD. This field is required if you configure a minimum order amount.
| Plan ID | Short Description | Long Description | Allowed Number of Installments | Allowed Number of Deferrals |
|---|---|---|---|---|
| NBG | National Bank of Greece Payment Plan | Payer pays in a number of installments. Payment can commence either at the time of the purchase or after a number of months of deferral period. | 1 to 99 | 0 to 99 |