Skip to main content

ShopeePay Guide

Jokul has partnered with various e-money providers and one of them is ShopeePay to provide E-Money Payment. Learn more about how Jokul can help you integrate with ShopeePay here.

ShopeePay only compatible for Mobile Integration

ShopeePay integration is app-to-app redirection meaning that it will only available for mobile users


Integration steps#

Here is the overview of how to integrate with ShopeePay:

  1. Setup Return URL
  2. Create order
  3. Redirect to ShopeePay payment page to complete the payment
  4. Acknowledge payment result
Jokul Direct - ShopeePay Sequence DiagramJokul Direct ShopeePay Flow

1. Setup Return URL#

Based on the flow, the customers will redirected back to your site after completing the payment on ShopeePay application. Therefore, please setup the return URL:

ShopeePay Return URL Setup
  1. Login to Jokul Back Office
  2. Go to Configuration > E-Money
  3. Click Configure button on ShopeePay channel
  4. Input the Payment Return URL
  5. Click Save button

2. Create order#

To create an order, you will need to hit this API through your Backend:

API Request#

TypeValue
HTTP MethodPOST
API endpoint (Sandbox)https://api-sandbox.doku.com/shopeepay-emoney/v2/order
API endpoint (Production)https://api.doku.com/shopeepay-emoney/v2/order

Here is the sample of request header to create an order:

Client-Id: MCH-0001-10791114622547Request-Id: 24bb5232-3fe6-47a5-b0b0-d0fc3c6b5fdbRequest-Timestamp: 2020-08-11T08:45:42ZSignature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=
Request Header Explanation
ParameterDescription
Client-IdClient ID retrieved from Jokul Back Office
Request-IdUnique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-TimestampTimestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z
SignatureSecurity parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature

Here is a sample of request body to create an order:

{    "order": {        "invoice_number": "INV-20210124-0001",        "amount": 150000,        "callback_url": "https://merchant.com/return-url",        "expired_time": 300    }}
Request Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatoryGenerated by merchant to identify the order and must unique per request
Allowed chars: alphabetic, numeric, special chars
Max length: 64
order.amountnumberMandatoryIn IDR currency and without decimal
Allowed chars: numeric
Max length: 12
order.callback_urlstringMandatoryMerchant URL that will redirected to after the order completed
order.expired_timenumberMandatoryOrder expired time
Max length: 8

API Response#

After hitting the above API request, Jokul will give the response.

TypeValue
HTTP Status200
ResultSUCCESS
Client-Id: MCH-0001-10791114622547Request-Id: 24bb5232-3fe6-47a5-b0b0-d0fc3c6b5fdbResponse-Timestamp: 2021-07-09T02:05:14ZSignature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=
Response Header Explanation
ParameterDescription
Client-IdSame as the request
Request-IdSame as the request
Response-TimestampTimestamp Response on UTC with format ISO8601 UTC+0 from Jokul
SignatureSignature generated by Jokul based on the response body

Here is the sample of response body:

{    "order": {        "invoice_number": "INV-20210124-0001",        "amount": 150000    },    "shopeepay_configuration": {        "merchant_ext_id": "846609710695590",        "store_ext_id": "99012984"    },    "shopeepay_payment": {        "redirect_url_app" : "merchant://main?apprl=%2Frn%2FTRANSFER_PAGE%3Fnavigate_url%3Dhttps%253A%252F%252Fwallet.airpay.co.id%252Fwallet%252Fpay%253Ftoken%253D{paymentToken}",        "redirect_url_http": "https://wallet.airpay.co.id/universal-link/wallet/pay?de ep_and_deferred=1&token=5a10f3bc-f555-4c92-8339-10421c09264a",        "status": "SUCCESS"    }}
Response Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
order.amountnumberMandatorySame as the request
shopeepay_configuration.merchant_ext_idstringOptionalMerchant identifier by ShopeePay
Max length: 15
Allowed chars: alphabetic, numeric
shopeepay_configuration.store_ex_idstringOptionalStore identifier by ShopeePay
Max length: 8
Allowed chars: alphabetic, numeric
shopeepay_payment.redirect_url_httpstringConditionalUniversal link to ShopeePay payment page
shopeepay_payment.statusstringMandatoryStatus of the create order request
Possible value: SUCCESS, FAILED. If FAILED, initiate new order

2. Redirect to ShopeePay payment page to complete the payment#

  1. ShopeePay will display the order details in the Shopee App
  2. Customer will check the payment amount and input ShopeePay PIN / Biometrics to complete the payment
  3. ShopeePay returns the transaction result and the user is redirected to payment successful page. From the payment success page in ShopeePay, user can jump back to the Merchant's app using the ​return_url​ to view their order status.

3. Acknowledge payment result#

Jokul will send HTTP Notification to your defined Notification URL. Learn how to handle the notification from Jokul:


Additional features#

We provide various addtional features to suited your needs. Learn more here.

Online Refund#

To request a refund, you will need to hit this API through your backend:

API Request#

TypeValue
HTTP MethodPOST
API endpoint (Sandbox)https://api-sandbox.doku.com/shopeepay-emoney/v2/refund
API endpoint (Production)https://api.doku.com/shopeepay-emoney/v2/refund

Here is the sample of request header to generate payment URL:

Client-Id: MCH-0001-10791114622547Request-Id: 6cc9f8b1-d83d-4c24-b853-a3223f43a744Request-Timestamp: 2020-08-12T09:45:42ZSignature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=
Request Header Explanation
ParameterDescription
Client-IdClient ID retrieved from Jokul Back Office
Request-IdUnique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-TimestampTimestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z
SignatureSecurity parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature

Here is the sample request body to request a refund:

{    “order”: {        "invoice_number":"MINV20201231468",        "amount":150000    }    "shopeepay_payment": {        "identifier": [            {                "name": "PAYMENT_REFERENCE_ID”,                "value": "REF-12345678            },{                "name": "TRANSACTION_SN”,                "value": "000000012345678            }        ]    }}
Request Body Explanation
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatoryInvoice number of the transaction that being refunded
amountnumberMandatoryTransaction amount that wants to be refunded
shopeepay_payment.identifierArrayMandatoryGet from payment notification response

API Response#

After hitting the above API request, Jokul will give the response.

TypeValue
HTTP Status200
ResultSUCCESS

Here is the sample response header:

Client-Id: MCH-0001-10791114622547Request-Id: 6cc9f8b1-d83d-4c24-b853-a3223f43a744Response-Timestamp: 2020-08-11T08:45:42ZSignature: HMACSHA256=1jap2tpgvWt83tG4J7IhEwUrwmMt71OaIk0oL0e6sPM=
Response Header Explanation
ParameterDescription
Client-IdSame as the request
Request-IdSame as the request
Response-TimestampTimestamp Response on UTC with format ISO8601 UTC+0 from Jokul
SignatureSignature generated by Jokul based on the response body

Here is the sample of response body:

{    "service": {        "id": "EMONEY”    },    "acquirer": {        "id": "SHOPEE_PAY”    },    "channel": {        "id": "EMONEY_SHOPEE_PAY”    },    “order”: {        "invoice_number":"MINV20201231468",        "amount":150000    },    "transaction": {        "status": "REFUNDED”,        "date": "2020-08-11T08:45:42Z",        "original_request_id": "asdak1238912381"    },    "refund”: {        "status": "SUCCESS",        "date": "2020-08-11T08:45:42Z",        "original_request_id": "asdak1238912381"    },    "additional_info": {    },    "shopeepay_configuration": {        "merchant_ext_id": "846609710695590,        "store_ext_id”: "99012984    },    "shopeepay_payment": {        "identifier": [            {                "name": "PAYMENT_REFERENCE_ID”,                "value": "REF-12345678            },{                "name": "TRANSACTION_SN”,                "value": "000000012345678            },{                "name": "USER_ID_HASH”,                "value": "dhfas0yd0ayf0sadf7nys0af0san7”            },        ],        "transaction_status”: "3,        “transaction_message”: “Transaction successful”    },    "shopeepay_refund”: {        "identifier": [            {                "name": "PAYMENT_REFERENCE_ID”,                "value": "REF-12345678            },{                "name": "TRANSACTION_SN”,                "value": "000000012345678            },{                "name": "USER_ID_HASH”,                "value": "dhfas0yd0ayf0sadf7nys0af0san7”            },        ],        "transaction_status”: "3,        “transaction_message”: “Transaction successful”    }}
Response Body Explanation
ParameterTypeMandatoryDescription
service.idstringMandatorySame as the request
acquirer_idstringMandatorySame as the request
channel.idnumberMandatorySame as the request
order.invoice_numberstringMandatoryMerchant invoice number, must unique per request per merchant
order.amountnumberMandatoryAmount per request per merchant
transaction.statusstringMandatoryTransaction status
Possible value: REFUNDED, SUCCESS, FAILED
transaction.datestringMandatoryTime Stamp request on UTC time in ISO8601 format
transaction.original_request_idstringMandatoryRequest Id from create order request
refund.statusstringMandatoryRefund status
Possible value: SUCCESS, FAILED
refund.datestringMandatoryTime Stamp request on UTC time in ISO8601 format
refund.original_request_idstringMandatoryRequest Id from create order request
additional_infostringMandatoryAdditional info
shopeepay_configuration.merchant_ext_idstringMandatoryMerchant identifier
shopeepay_configuration.store_ext_idstringMandatoryMerchant identifier
shopeepay_payment.identifierstringMandatoryTransaction data identifier
shopeepay_payment.transaction_statusstringMandatoryTransaction data status
shopeepay_payment.transaction_messagestringMandatoryTransaction message description
shopeepay_refund.identifierstringMandatoryRefund data identifier
shopeepay_refund.transaction_statusstringMandatoryRefund data status
shopeepay_refund.transaction_messagestringMandatoryRefund message description

Jokul Fin - Split Settlement#

If you are a platform or a marketplace, you can use this feature to settle the funds to your sellers or partners programmatically, save many operational efforts.