UOB Ezpay

UOB Ezpay is one of the internet banking payment methods that is provided by UOB Bank. This method allows the customer to perform a transaction by redirecting the customer to the UOB payment page.

Integration steps:

  1. Merchant send charge request to Midtrans.
  2. The merchant will need to open the redirection url in the actions to the customer. web-deeplink-redirect to redirect to UOB web page and mobile-deeplink-redirect to redirect to UOB mobile app.
  3. Redirect your customer back to your page by configuring Finish URL in Midtrans's Dashboard > Configurations or via Charge API request.
  4. Handle notifications.

By default, expiry time for UOB EzPay is 14 minutes unless specified by merchant (min 20s, max 180 days).




UOB Ezpay Charge API Request


{
  "payment_type": "uob_ezpay",
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "transaction_details": {
    "order_id": "H17550",
    "gross_amount": 11000
  },
  "customer_details" : {
    "first_name": "Andri",
    "last_name": "Litani",
    "email": "[email protected]",
    "phone": "081122334455"
  },
   "uob_ezpay": {
        "callback_url": "http://example.com/uobezpay?order_id=sample-001"
    }
}
JSON AttributeTypeDescription
payment_typeStringSet UOB Ezpay payment method. Value: uob_ezpay
transaction_detailsObjectDetails of the transaction will be paid by customer
item_detailsObjectShopping item details
customer_detailsObjectCustomer Details
uob_ezpayObjectUOB Ezpay Object, containing Callback Finish URL (optional)



UOB Ezpay Charge Sample Responses and Notifications


{
  "status_code": "201",
  "status_message": "Success, UOB Ez Pay transaction is successful",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "uob_ezpay",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "actions": [
    {
      "name": "web-deeplink-redirect",
      "method": "GET",
      "url": "https://u-payment.uob.co.id/startup/ezpay?clientId=107b9f3e-7399-4983-8342-a3350e7b8ce0&type=JWT&signature=Jpc3MiOiIxMDdiOWYzZS03Mzk5LTQ5ODMtODM0Mi1hMzM1MGU3YjhjZTAiLCJpYXQiOjE1NjE1NUBQl"
    },
    {
      "name": "mobile-deeplink-redirect",
      "method": "GET",
      "url": "https://digitalbankid.page.link/?link=https://www.tmrwbyuob.com?clientId%3D107b9f3e-7399-4983-8342-a3350e7b8ce0%26signature%3DJpc3MiOiIxMDdiOWYzZS03Mzk5LTQ5ODMtODM0Mi1hMzM1MGU3YjhjZTAiLCJpYXQiOjE1NjE1NUBQl-5gvMiOqzSq-lroACwpf83vpj2NYlExcrYckyV7Oc&type=JWT&apn=com.uob.id.digitalbank.dev&isi=1472320289&ibi=com.uob.id.digitalbank.uat"
    }
  ]
}
{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "uob_ezpay",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "signature_key": "666617ddc981eb096b6f08ab8ee132b93c12d3b5b3817f00a02c5d4c71bd53fd7f39d55a92b2a1f729ee070fdb241b569dc90bfa61e41de16904075238d67d55",
}
{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "uob_ezpay",
  "transaction_time": "2016-06-19 16:45:21",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "approval_code": "RB5031388093",
  "signature_key": "3bcdf0700d3c8a288f279e4fe27a4012e916cb44120d541f6e4c48c83a107b605fdb063ae7c8744d15891047aeb1fc8d2e95741c0abc5f67e10e0b60244bc441"
}
{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "uob_ezpay",
  "transaction_time": "2016-06-19 16:44:21",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "signature_key": "b736864661f8cbf04b287ee5a9514589dbe2dc53e3949338d648144b6bad1bc77d1b495921f119e7a6bf5521b697ea5d629b5ea93f2bcda4ff13df744cfbf701"
}
{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "uob_ezpay",
  "transaction_time": "2016-06-19 18:41:25",
  "transaction_status": "expire",
  "fraud_status": "accept",
  "signature_key": "3f1ddaf45b269df7a1638d6d4080957e1323df2cbc2da83549f86a23b17c2acae0215994bb60805455daf157125990414259e5319e84c9288fd6222e655c6756"
}
JSON AttributeTypeDescription
transaction_idStringTransaction ID given by Midtrans
order_idStringOrder ID given by merchant
gross_amountStringTotal amount of transaction
payment_typeStringTransaction payment method
transaction_timeStringTimestamp of transaction
transaction_statusStringTransaction status of UOB Ezpay transaction, the possible value is
pending
status_codeStringStatus code of transaction charge result
status_messageStringDescription of transaction charge result
redirect_urlStringRedirect URL to UOB Ezpay payment page