Installment Payment Plan (IPP)

Installment Payment Plan is a feature that allows the consumer to pay in equal installments.
Depending on the total order amount, you can offer various payment plans to the consumer. These IPPs differ in tenure and installment payment framework (e.g. interest rate).

Set up a contract with your issuing bank to agree on the IPP parameters. The issuing bank then provides Wirecard with these IPP parameters.

If your merchant account has not yet been set up for IPP, contact merchant support.
IPP Characteristics
  • Fixed: Installments are of equal amount.

  • On-us: Issuing bank and acquiring bank are the same.

  • Issuer-based: Post-clearing, you receive the full amount from the acquiring bank. The consumer pays their issuing bank (same entity as acquiring bank since on-us) in installments.

  • Domestic payments only: The instrument country, i.e. the country where the consumer’s card was issued, must match the merchant country.

  • Domestic currency only: The consumer can only pay in the local currency of the merchant country.

  • Credit card: This feature is available for credit card payments only.
    Supported card brands:

    • Mastercard

    • Visa

Countries and Currencies

Countries

HK, ID, MY, PH, SG, TH, TW

Currencies

HKD, IDR, MYR, PHP, SGD, THB, TWD

Transaction Types

Installment Payment Plan works with transaction type purchase.

Workflow

  1. The consumer checks out products in the merchant’s shop.

  2. The merchant’s shop displays the payment form, where the consumer enters their credit card data (PAN).

  3. WPG checks the card’s IPP eligibility by validating the card number against the BIN ranges activated at the issuing bank. The BIN range is part of the contract between merchant and issuing bank. It lists all Bank Identification Numbers (the first 6 digits of credit card number) that qualify for installment payment.

    WPG also checks if the transaction and the transaction currency are domestic.

    • Validation fail: The consumer is redirected to the regular (credit card) payment form.

    • Validation OK: The consumer can select either regular payment or payment in installments.

  4. The consumer selects "Payment in Installments".

  5. The merchant sends an Installment Calculator request to WPG.

  6. WPG forwards the request to the issuing bank.

  7. The issuing bank generates a list of all available IPPs and sends it to the merchant.

  8. The merchant’s shop displays the available installment plans to the consumer (on the checkout page).

  9. The consumer selects an installment plan and submits the payment. The selected program/tenure is sent with the purchase request to WPG. Mandatory IPP fields in this purchase request are tenure and program-id.

  10. WPG forwards the request to the issuing bank.

  11. The issuing bank processes the request and sends the response to WPG.

  12. WPG forwards the response to the merchant.

  13. The merchant informs the consumer about the transaction outcome.

  14. The issuing bank pays the total order amount to the merchant.

  15. The consumer pays the issuing bank (same entity as acquiring bank since on-us) in installments.

Fields

A purchase request with IPP requires two additional mandatory fields that identify the installment plan selected by the consumer:

Field Data Type Size Description

tenure

Integer

10

Installment tenure. Number of months the consumer has to pay in installments.
Enter the respective value from the field months provided in the Installment Calculator response.

program-id

Alphanumeric

36

This ID uniquely identifies the corresponding installment payment plan framework.
Enter the respective value from the field program-id provided in the Installment Calculator response.

Two additional fields are sent in the response to this request:

Field Data Type Description

monthly-pay

Decimal

Amount that the consumer pays to the issuing bank per month.

interest-rate

Decimal

Interest rate of the selected IPP.

Installment Calculator

The Installment Calculator retrieves the available installment plans defined in the contract between the merchant and the issuing bank.

Endpoints

Test URL

https://api-test.wirecard.com/engine/rest/utils/installmentcalculator

Production URL

https://api.wirecard.com/engine/rest/utils/installmentcalculator

Test Credentials

Merchant Account ID

6dcd81a6-88d0-42ef-a37e-a8cc0b6ab122

Username

45892-IPPS

Password

5D348E1jE246-g

Communication Formats

Format

XML

Methods

POST

Request Fields

M=Mandatory, O=Optional

Field M/O Data Type Size Description

merchant-account-id

M

Alphanumeric

36

Unique identifier of merchant account.

payment-method

M

Enumeration

15

Set to creditcard.

account-number

M

Token

36

Consumer’s credit card number (primary account number).

Response Fields

M=Mandatory, O=Optional

Field M/O Data Type Size Description

merchant-account-id

M

Alphanumeric

36

Unique identifier of merchant account.

payment-method

M

Enumeration

15

Always creditcard.

state

M

Enumeration

The state of the response: success, failed

statuses

M

Complex

List of response statuses.

statuses.status

M

Complex

Response status.

statuses.status@code

M

Alphanumeric

12

The status code of the response. Click Status Codes and Transaction Status for a complete list of all status codes.

statuses.status@description

M

Alphanumeric

256

The description to the response status code.

statuses.status@severity

M

Enumeration

Possible values: warning, error or information.

installments

M

Complex

Contains all available IPPs.

installments.installment

M

Complex

Each installment complex contains information on a specific IPP framework.

installments.installment.
program-id

M

Alphanumeric

36

This ID uniquely identifies the corresponding IPP framework.
Insert this value as program-id of a subsequent purchase request.

installments.installment.
program-name

O

Alphanumeric

Label of this specific IPP framework as displayed to the consumer.
This is just a suggestion and may be replaced by any text you find more conclusive for your consumer.

installments.installment.
details

M

Complex

Breakdown of information on the corresponding IPP.

installments.installment.
details.months

M

Alphanumeric

10

Number of installments (months) to pay for this IPP.
Insert this value as tenure of a subsequent purchase request.

Samples

Installment Calculator Sample Request
<installment-calculator-request xmlns="http://www.elastic-payments.com/schema/utils">
   <merchant-account-id>6dcd81a6-88d0-42ef-a37e-a8cc0b6ab122</merchant-account-id>
   <payment-method>creditcard</payment-method>
   <account-number>5401274899901388</account-number>
</installment-calculator-request>
Installment Calculator Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<installment-calculator-response xmlns="http://www.elastic-payments.com/schema/utils">
    <merchant-account-id>6dcd81a6-88d0-42ef-a37e-a8cc0b6ab122</merchant-account-id>
    <payment-method>creditcard</payment-method>
    <state>success</state>
    <statuses>
        <status code="200.0000" description="Successful Response" severity="information"/>
    </statuses>
    <installments>
        <installment>
            <program-id>IPP-PRG-1</program-id>
            <program-name>Installment Payment Plan Program 1</program-name>
            <details>
                <months>3</months>
            </details>
        </installment>
    </installments>
</installment-calculator-response>
Custom URL: