Installment Payments

Installment payments allow customers to split one large payment into several smaller payments over a fixed period. Omise offers a new Installment Payment flow and a set of APIs that allow you to offer your customers this convenient payment method.

For the legacy integration with Installment payments using the redirect payment flow, please refer to the Redirect Integration.

How to enable

• Supported Countries: Thailand
• Minimum API version: 2017-11-02

To enable Installment Payments, send an email requesting this feature to support@omise.co. You will need to review and accept new terms and conditions.

Supported cards

Supported Loan cards

The list of supported installment terms for each card type can be found in the Capability API.

Payment flow

For customers who choose to pay using Installment Payments, you (the merchant) display your checkout page with relevant Installment details for the customer to select.

Once the customer submits their card details and confirms the payment, the card will be charged the same way as normal credit card payments. This means your current card processing settings will also apply to every charge, and the customer will be redirected to the issuer to authenticate themselves via 3DS. Upon completion, the customer will be redirected back to your website.

The following screenshots demonstrate this payment flow. At checkout, the customer selects the installment payment method.

After submitting the credit card with which they would like to pay, the customer is redirected to the external webpage, where they might have to authenticate themselves occasionally. Upon confirmation, the customer will be redirected to your website via the specified return URI.

Setting who pays installment interest

One party, you (the merchant) or the customer, pays the interest for installment payments. We use the term zero-interest installments to reflect when you pay the interest instead of the customer.

Default setting

Use the Dashboard to set the default party to pay installment interest. You can override this setting per charge.

Per charge setting

Override the default setting of which party pays installment interest by passing the boolean parameter zero_interest_installments at both source and charge creation. When set to true, you, the merchant, pay the interest; when set to false, the customer pays; when omitted, the default account value is used. The values passed at source and charge creation must match.

If directly charging a source, pass this parameter at charge creation.

Implementation

To create a charge using Installment Payments, make the following API requests.

1. Create a new token using Omise.js or one of the mobile SDKs (iOS and Android)
2. Create a new payment source (type: installment_wlb_bay, installment_wlb_bbl, installment_wlb_first_choice, installment_wlb_kbank, installment_wlb_ktc, installment_wlb_scb, installment_wlb_ttb, or installment_wlb_uob) using Omise.js or one of the mobile SDKs (iOS and Android)
3. Create a new charge using the token ID and source ID created in Steps 1 and 2.
4. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your public key to create the token and Installment Payments source for the client (a customer's browser or mobile phone). Use your secret key to create the Installment Payments charge on the server.

If both the creation and charge of a source must happen server-side, you can create and charge the source in a single API request using your secret key.

Creating a card token

Omise.js is a client-side JavaScript library that provides a form with validation, allowing you to collect card information easily. It sends sensitive card data to our secure vault server and generates a token.

When the customer confirms they wish to pay with a card, create a new token specifying card details in a card object. Tokens can be used only once.

The following examples demonstrate the creation of a new card token for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with your test public key found on the dashboard: https://dashboard.omise.co/test/keys

Using Omise.js, the type parameter is supplied as the first argument to the createToken method.

Omise.setPublicKey(omise_public_key);

Omise.createToken('card', {
  "name": "Somchai Prasert",
  "number": "4242424242424242",
  "expiration_month": "10",
  "expiration_year": "2022",
  "city": "Bangkok",
  "postal_code": "10320",
  "security_code": "123"
}, function(statusCode, response) {
  console.log(response)
});

For testing, you can create the same request using curl.

curl https://vault.omise.co/tokens \
  -X POST \
  -u $OMISE_PUBLIC_KEY: \
  -d "card[name]=Somchai Prasert" \
  -d "card[city]=Bangkok" \
  -d "card[postal_code]=10320" \
  -d "card[number]=4242424242424242" \
  -d "card[security_code]=123" \
  -d "card[expiration_month]=12" \
  -d "card[expiration_year]=2024"

{
  "object": "token",
  "id": "tokn_test_6275ran0cxjao4505d1",
  "livemode": false,
  "location": "https://vault.omise.co/tokens/tokn_test_6275ran0cxjao4505d1",
  "used": false,
  "charge_status": "unknown",
  "card": {
    "object": "card",
    "id": "card_test_6275ramxwea3rk2uduo",
    "livemode": false,
    "location": null,
    "deleted": false,
    "street1": null,
    "street2": null,
    "city": "Bangkok",
    "state": null,
    "phone_number": null,
    "postal_code": "10320",
    "country": "us",
    "financing": "credit",
    "bank": "JPMORGAN CHASE BANK N.A.",
    "brand": "Visa",
    "fingerprint": "b3ejUqhKT6DjGjtnathYRJk8oifeVAFXPhgtoQMhZIs=",
    "first_digits": null,
    "last_digits": "4242",
    "name": "Somchai Prasert",
    "expiration_month": 12,
    "expiration_year": 2024,
    "security_code_check": true,
    "tokenization_method": null,
    "created_at": "2024-12-26T03:16:37Z"
  },
  "created_at": "2024-12-26T03:16:37Z"
}

The id attribute is the token identifier (begins with tokn).

Creating a source

When the customer confirms that they wish to pay with this payment method, create a new source specifying the amount, currency, installment_term, and type.

The following examples demonstrate the creation of a new Installment Payments source for ฿4,000. Replace the omise_public_key and $OMISE_PUBLIC_KEY variables with the test public key on your dashboard.

Using Omise.js, the type parameter is supplied as the first argument to the createSource method.

Omise.setPublicKey(omise_public_key);

Omise.createSource('installment_wlb_ktc', {
  "amount": 400000,
  "currency": "THB",
  "installment_term": 4
}, function(statusCode, response) {
  console.log(response)
});

For testing, you can create the same request using curl.

curl https://api.omise.co/sources \
  -u $OMISE_PUBLIC_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "type=installment_wlb_ktc" \
  -d "installment_term=4"

{
  "object": "source",
  "id": "src_test_6275raqws8zz5bm5oba",
  "livemode": false,
  "location": "/sources/src_test_6275raqws8zz5bm5oba",
  "amount": 400000,
  "barcode": null,
  "bank": null,
  "created_at": "2024-12-26T03:16:38Z",
  "currency": "THB",
  "email": null,
  "flow": "redirect",
  "installment_term": 4,
  "ip": "35.198.236.178",
  "absorption_type": "customer",
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "billing": null,
  "shipping": null,
  "items": [],
  "references": null,
  "provider_references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "installment_wlb_ktc",
  "zero_interest_installments": false,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": [],
  "promotion_code": null
}

The id attribute is the source identifier (begins with src).

Creating a charge

Create a charge specifying the parameters return_uri, source, card, amount, and currency.

• return_uri specifies the location on your website to which the customer should be redirected after completing the payment authorization step.
• source specifies the source identifier.
• card specifies the token identifier.
• The amount and currency must match those of the source.

The following example demonstrates how to create a new charge using curl.

• Replace $OMISE_SECRET_KEY with the test secret key on your dashboard.
• Replace $SOURCE_ID with the id of the source.
• Replace $TOKEN_ID with the id of the card token.

For installments, the following parameter may also be passed:

• zero_interest_installments, the value of which must match the value in the source.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "source=$SOURCE_ID" \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "card=$TOKEN_ID" \
  -d "return_uri=https://example.com/orders/345678/complete"

{
  "object": "charge",
  "id": "chrg_test_6275raual3km80ul0d3",
  "location": "/charges/chrg_test_6275raual3km80ul0d3",
  "amount": 400000,
  "acquirer_reference_number": null,
  "net": 384378,
  "fee": 14600,
  "fee_vat": 1022,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "0.0",
    "fee_rate": "3.65",
    "vat_rate": "7.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "THB",
  "funding_currency": "THB",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_test_6275raual3km80ul0d3/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2024-12-26T03:16:38Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": {
    "object": "card",
    "id": "card_test_6275ra9jn0agjscj9q1",
    "livemode": false,
    "location": null,
    "deleted": false,
    "street1": null,
    "street2": null,
    "city": "Bangkok",
    "state": null,
    "phone_number": null,
    "postal_code": "10320",
    "country": "us",
    "financing": "credit",
    "bank": "JPMORGAN CHASE BANK N.A.",
    "brand": "Visa",
    "fingerprint": "b3ejUqhKT6DjGjtnathYRJk8oifeVAFXPhgtoQMhZIs=",
    "first_digits": null,
    "last_digits": "4242",
    "name": "Somchai Prasert",
    "expiration_month": 9,
    "expiration_year": 2025,
    "security_code_check": true,
    "tokenization_method": null,
    "created_at": "2024-12-26T03:16:35Z"
  },
  "source": {
    "object": "source",
    "id": "src_test_6275r9v0js90wdo7saw",
    "livemode": false,
    "location": "/sources/src_test_6275r9v0js90wdo7saw",
    "amount": 400000,
    "barcode": null,
    "bank": null,
    "created_at": "2024-12-26T03:16:33Z",
    "currency": "THB",
    "email": null,
    "flow": "redirect",
    "installment_term": 4,
    "ip": "35.198.236.178",
    "absorption_type": "customer",
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "billing": null,
    "shipping": null,
    "items": [],
    "references": null,
    "provider_references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "installment_wlb_ktc",
    "zero_interest_installments": false,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": [],
    "promotion_code": null
  },
  "schedule": null,
  "linked_account": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "merchant_advice": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_test_6275rauc8sa7s5tl12s/authorize?acs=false",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2024-12-26T03:16:38Z",
  "paid_at": null,
  "authorized_at": null,
  "expires_at": "2025-01-02T03:16:38Z",
  "expired_at": null,
  "reversed_at": null,
  "multi_capture": false,
  "zero_interest_installments": false,
  "branch": null,
  "terminal": null,
  "device": null,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "partially_refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false,
  "can_perform_void": false,
  "approval_code": null
}

Creating a source and charge

Alternatively, you can create and charge a source in a single API request.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "card=$TOKEN_ID_CHARGE_SOURCE" \
  -d "source[type]=installment_wlb_ktc" \
  -d "source[installment_term]=4"

Creating a source and charge where the customer pays interest

Override the default setting of who pays installment interest by passing the zero_interest_installments parameter. See setting who pays installment interest for more details.

curl https://api.omise.co/charges \
  -u $OMISE_SECRET_KEY: \
  -d "amount=400000" \
  -d "currency=THB" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "zero_interest_installments=false" \
  -d "card=$TOKEN_ID_CHARGE" \
  -d "source[type]=installment_wlb_ktc" \
  -d "source[installment_term]=4"

Completing the charge

You have created a new charge with its status set to pending. Other possible values for charge status are successful, failed, and expired.

The following sections detail how to authorize a charge, receive its completion webhook event, and update its status.

Authorizing the charge

Redirect the customer to the location specified in authorize_uri so they can authorize the charge.

The merchant can simulate this authorization phase in test mode using our test cards.

After the customer has completed the authorization phase, they will be redirected to the location specified in return_uri.

Receiving the charge completion event

The best way to be notified about the completion of a charge is by using webhook events.

Set up a location on the merchant server to receive webhook events and add this location as a webhook endpoint on the dashboard.

Checking the charge status

After receiving this event, retrieve the charge using its id and confirm that its status matches the status of the charge contained in the event.

If the value of status is successful, you got paid.

If the value of status is failed, check the failure_code and failure_message in the charge object for an explanation.

Possible failure codes are as follows.

Voids and refunds

See the Refunds API documentation for information on refunding an installment payment charge.

Installment payment charges cannot be partially refunded. Only full refunds are supported.

Limits

• Minimum: 200000 (THB2,000.00)
• Maximum: 15000000 (THB150,000.00)

Since each credit card has its own monthly minimum, the effective minimum charge amount may be higher depending on the credit card and installment term length chosen.

For example, a ฿3,300 charge set to be paid over a 10-month installment term would result in a monthly charge of approximately ฿330, below the minimum for Bangkok Bank credit cards but above the minimum for Kasikorn Bank credit cards.

Related API documentation

• Charge
• Source
• Webhook

How to check the public key and secret key

For information on obtaining and checking the public and secret keys, please refer to this document.