EzyPay Installments

Enable your customers to make installment purchases directly from their Maybank credit card using EzyPay. This guide walks you through the payment flow and details on how to implement.

How to enable

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

To enable EzyPay Installments, send an email requesting this feature to support@omise.co.

Payment flow

Customers who choose to pay using EzyPay Installment payments go through a redirect payment flow. This means that they are redirected from your website to an 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. After choosing EzyPay Maybank and the installment term, the customer is required to fill in their credit card information. They will then be redirected to the external webpage. The payment amount and any reference numbers will already be filled out on the authorization page. The customer has to review the information and authorize the payment using 3DS. Upon confirmation, the customer will be redirected to your website via the specified return URI.

Implementation

To create a charge using EzyPay Installments, make the following API requests.

1. Create a new payment source (type: installment_ezypay) 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 EzyPay Installments source on the client (a customer's browser or mobile phone). Use your secret key to create the EzyPay Installments 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_terms, and type.

The following examples demonstrate the creation of a new EzyPay Installments source for RM1500. 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_ezypay', {
  "amount": 150000,
  "currency": "MYR",
  "installment_term": "6"
}, 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=150000" \
  -d "currency=MYR" \
  -d "type=installment_ezypay" \
  -d "installment_term=6"

{
  "object": "source",
  "id": "src_5pugyjthdmerh11lqqs",
  "livemode": true,
  "location": "/sources/src_5pugyjthdmerh11lqqs",
  "amount": 150000,
  "barcode": null,
  "bank": null,
  "created_at": "2021-11-15T05:01:07Z",
  "currency": "MYR",
  "email": null,
  "flow": "redirect",
  "installment_term": 6,
  "absorption_type": "customer",
  "name": null,
  "mobile_number": null,
  "phone_number": null,
  "platform_type": null,
  "scannable_code": null,
  "references": null,
  "store_id": null,
  "store_name": null,
  "terminal_id": null,
  "type": "installment_ezypay",
  "zero_interest_installments": false,
  "charge_status": "unknown",
  "receipt_amount": null,
  "discounts": []
}

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 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 "amount=150000" \
  -d "currency=MYR" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source=$SOURCE_ID"

{
  "object": "charge",
  "id": "chrg_5pugykfxg2jg4sy7ya1",
  "location": "/charges/chrg_5pugykfxg2jg4sy7ya1",
  "amount": 150000,
  "net": 147300,
  "fee": 2700,
  "fee_vat": 0,
  "interest": 0,
  "interest_vat": 0,
  "funding_amount": 150000,
  "refunded_amount": 0,
  "transaction_fees": {
    "fee_flat": "0.0",
    "fee_rate": "1.8",
    "vat_rate": "0.0"
  },
  "platform_fee": {
    "fixed": null,
    "amount": null,
    "percentage": null
  },
  "currency": "MYR",
  "funding_currency": "MYR",
  "ip": null,
  "refunds": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/charges/chrg_5pugykfxg2jg4sy7ya1/refunds",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2021-11-15T05:01:10Z"
  },
  "link": null,
  "description": null,
  "metadata": {},
  "card": null,
  "source": {
    "object": "source",
    "id": "src_5pugyhqvki53sihvrhz",
    "livemode": true,
    "location": "/sources/src_5pugyhqvki53sihvrhz",
    "amount": 150000,
    "barcode": null,
    "bank": null,
    "created_at": "2021-11-15T05:00:57Z",
    "currency": "MYR",
    "email": null,
    "flow": "redirect",
    "installment_term": 6,
    "absorption_type": "customer",
    "name": null,
    "mobile_number": null,
    "phone_number": null,
    "platform_type": null,
    "scannable_code": null,
    "references": null,
    "store_id": null,
    "store_name": null,
    "terminal_id": null,
    "type": "installment_ezypay",
    "zero_interest_installments": false,
    "charge_status": "pending",
    "receipt_amount": null,
    "discounts": []
  },
  "schedule": null,
  "customer": null,
  "dispute": null,
  "transaction": null,
  "failure_code": null,
  "failure_message": null,
  "status": "pending",
  "authorize_uri": "https://pay.omise.co/payments/pay2_5pugykg23cb2rgifjme/authorize",
  "return_uri": "http://example.com/orders/345678/complete",
  "created_at": "2021-11-15T05:01:10Z",
  "paid_at": null,
  "expires_at": "2021-11-16T05:01:10Z",
  "expired_at": null,
  "reversed_at": null,
  "zero_interest_installments": false,
  "branch": null,
  "terminal": null,
  "device": null,
  "authorized": false,
  "capturable": false,
  "capture": true,
  "disputable": false,
  "livemode": true,
  "refundable": false,
  "reversed": false,
  "reversible": false,
  "voided": false,
  "paid": false,
  "expired": 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=150000" \
  -d "currency=MYR" \
  -d "return_uri=http://example.com/orders/345678/complete" \
  -d "source[type]=installment_ezypay" \
  -d "source[installment_term]=6"

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.

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.

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: 50000 (MYR500.00)
• Maximum: 2000000 (MYR20,000.00)

Next steps

• Charge API
• Source API
• Webhooks API