Installment Payments

Topics covered on this page

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

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

Credit Card Source type Installment Term Lengths (months) Monthly Minimum (THB)
Krungsri installment_bay 3, 4, 6, 9, 10 500
Bangkok Bank installment_bbl 4, 6, 8, 9, 10 500
Krungsri First Choice installment_first_choice 3, 4, 6, 9, 10, 12, 18, 24, 36 300
Kasikorn Bank installment_kbank 3, 4, 6, 10 300
Krungthai Card (KTC) installment_ktc 3, 4, 5, 6, 7, 8, 9, 10 300

Payment flow

Customers who choose to pay using installment payments go through a redirect payment flow. This means that they are redirected from your website to a external webpage to authorize and confirm the payment amount. Upon completion, the customer is redirected back to your website.

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

installment 1

After choosing the credit card with which they would like to pay, the customer is redirected to the external webpage. The payment amount and any reference numbers will already be filled out on the authorization page.

installment 2

The customer has to review the information and confirm the payment. 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

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

Setting Zero Interest Installments

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 payment source (type: installment_bay, installment_bbl, installment_first_choice, installment_kbank, or installment_ktc) using Omise.js or one of the mobile SDKs (iOS and Android)
  2. Create a new charge using the identifier of the source created in Step 1.
  3. After receiving the charge completion webhook event, retrieve the charge to verify its status (optional, but recommended).

Use your public key to create the Installment Payments source on 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 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.

Parameter Type Description
amount integer (required) See Limits
currency string (required) THB
installment_term integer (required) Valid installment term length in months
type string (required) Valid installment source type
zero_interest_installments string (optional, defaults to account setting) Whether customer or merchant absorbs interest. true when merchant absorbs interest

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 found 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_kbank', {
  "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_kbank" \
  -d "installment_term=4"
{
  "object": "source",
  "id": "src_test_5kdpnbmzhgkvp3jr2qr",
  "livemode": false,
  "location": "/sources/src_test_5kdpnbmzhgkvp3jr2qr",
  "amount": 400000,
  "barcode": null,
  "created_at": "2020-06-30T03:50:25Z",
  "currency": "THB",
  "email": null,
  "flow": "redirect",
  "installment_term": 4,
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "scannable_code": null,
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "installment_kbank",
  "zero_interest_installments": false
}

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

Creating a charge

Create a charge specifying the parameters return_uri, source, 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.
  • amount and currency must match amount and currency of the source.

The following example demonstrates how to create a new charge using curl. Replace $OMISE_SECRET_KEY with your test secret key found on your dashboard. Replace $SOURCE_ID with the id of the source.

For installments, the boolean parameter zero_interest_installments may also be passed, 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 "return_uri=https://example.com/orders/345678/complete"
{
  "object": "charge",
  "id": "chrg_test_5kdpnbqscs9q97q9ixm",
  "location": "/charges/chrg_test_5kdpnbqscs9q97q9ixm",
  "amount": 400000,
  "net": 384378,
  "fee": 14600,
  "fee_vat": 1022,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 400000,
  "refunded_amount": 0,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": false,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": false,
  "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_5kdpnbqscs9q97q9ixm/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2020-06-30T03:50:26Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_test_5kdpnbbqwprhx7tgzk3",
    "livemode": false,
    "location": "/sources/src_test_5kdpnbbqwprhx7tgzk3",
    "amount": 400000,
    "barcode": null,
    "created_at": "2020-06-30T03:50:24Z",
    "currency": "THB",
    "email": null,
    "flow": "redirect",
    "installment_term": 4,
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "scannable_code": null,
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "installment_kbank",
    "zero_interest_installments": false
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/offsites/ofsp_test_5kdpnbqxb9435eqdulq/pay",
  "return_uri": "https://example.com/orders/345678/complete",
  "created_at": "2020-06-30T03:50:26Z",
  "paid_at": null,
  "expires_at": "2020-07-07T03:50:26Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": false
}

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 "source[type]=installment_kbank" \
  -d "source[installment_term]=4"

Creating a source and charge where 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 "source[type]=installment_kbank" \
  -d "source[installment_term]=4"

Completing the charge

At this point, 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.

This sequence diagram shows the entire flow.

sequenceDiagram participant customer participant omise.js participant merchant participant api.omise.co customer->>omise.js: Send payment details for purchase omise.js->>api.omise.co: Request source using payment details api.omise.co-->>omise.js: Return source omise.js->>merchant: Merchant gets returned source merchant->>api.omise.co: Request charge using source and purchase details api.omise.co-xmerchant: Send "charge.create" webhook api.omise.co-->>merchant: Return charge merchant->>customer: Redirect to "authorize_uri" for pending charge customer->>api.omise.co: Provide charge authorization details at "authorize_uri" api.omise.co-->>customer: Redirect to "return_uri" api.omise.co-xmerchant: Send "charge.complete" webhook merchant-xcustomer: Send charge result (e.g. via email)

Authorizing the charge

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

You can simulate this authorization phase in test mode by visiting the authorize_uri to manually mark the charge as Successful or Failed. After the customer has completed the authorization phase, they will be redirected to the location you specified in return_uri.

Receiving the charge completion event

The best way for you to be notified of the completion of a charge is using webhook events. Set up a location on your server to receive webhook events, and add this location as a webhook endpoint on the dashboard.

Once a charge is completed, a POST request will be sent to this endpoint with the charge response embedded.

The key attribute for the event object contains charge.complete and the data attribute contains the charge object. See Events API for event object structure.

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 listed below.

Failure Code Description
insufficient_balance Insufficient funds in the account or the payment method has reached its limit.
payment_cancelled Payment cancelled by payer.
timeout Payer did not take action before charge expiration.
failed_processing General payment processing failure.

Voids and refunds

See the Refunds API documentation for information on how to refund an installment payment charge.

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

Limits

  • Minimum: 300000 (THB3,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 an installment term of 10 months would result a monthly charge of approximately ฿330, below the minimum for Bangkok Bank credit cards, but above the minimum for Kasikorn Bank credit cards.

Next steps

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more