DOKU e-Wallet
Doku e-Wallet API Guide Explanation
Last updated
Doku e-Wallet API Guide Explanation
Last updated
DOKU API
Legacy DocumentationHere is the overview of how to integrate with DOKU e-Wallet:
Obtain payment.url
by generating order
Display DOKU Wallet payment page to customer
Acknowledge payment result
payment.url
by generating orderTo generate order, you will need to hit this API through your Backend:
API Request
HTTP Method
POST
API endpoint (Sandbox)
https://api-sandbox.doku.com/dokuwallet-emoney/v1/payment
API endpoint (Production)
https://api.doku.com/dokuwallet-emoney/v1/payment
Here is the sample of request header to generate order:
Client-Id
Client ID retrieved from DOKU Back Office
Request-Id
Unique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-Timestamp
Timestamp 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
Signature
Security 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 generate order:
order.invoice_number
string
Mandatory
Generated by merchant to identify the order and must unique per request
Allowed chars: alphabetic, numeric, special chars
Max length: 64
order.amount
number
Mandatory
In IDR currency and without decimal
Allowed chars: numeric
Max length: 12
order.line_items.name
string
Conditional
Optional if request doesnt pass line items. But if request passes, then it becomes Mandatory.
Allowed chars: alphabetic, numeric, special chars
Max Length: 255
order.line_items.price
number
Conditional
Price of the product item. Total price and quantity must match with the order.amount
. Optional if request doesnt pass line items. But if request passes, then it becomes Mandatory.
Allowed chars: numeric
Max Length: 12
order.line_items.quantity
number
Conditional
Quantity of the product item<. Optional if request doesnt pass line items. But if request passes, then it becomes Mandatory.
Allowed chars: numeric
Max Length: 4
success_url
string
Optional
Merchant URL that will redirected to after the order success. If merchant set order.auto_redirect
to true
, then the default url is "www.doku.com".
Allowed chars: alphabetic, numeric, special chars
failed_url
string
Optional
Merchant URL that will redirected to after the order failed. If not set, then will redirect to success_url
Allowed chars: alphabetic, numeric, special chars
notify_url
string
Mandatory
Merchant URL that will be notify from DOKU. If its not define, status in merchant will not update.
Allowed chars: alphabetic, numeric, special chars
auto_redirect
string
Mandatory
Redirection to defined success_url
after payment process completed
Possible value: true, false
Default value: false
additional_info.override_notification_url
string
Optional
This parameter is intended to override the configured Notification URL
with another URL. Click here for more information.
API Response
After hitting the above API request, DOKU will give the response.
HTTP Status
200
Result
SUCCESS
Client-Id
Same as the request
Request-Id
Same as the request
Request-Timestamp
Timestamp Response on UTC with format ISO8601 UTC+0 from DOKU
Signature
Signature generated by DOKU based on the response body
Here is the sample of response body:
order.invoice_number
string
Mandatory
Same as the request
order.line_items.name`
number
Mandatory
Same as the request
order.line_items.price
number
Mandatory
Same as the request
order.line_items.quantity
number
Mandatory
Same as the request
doku_wallet_payment_page.url
string
Mandatory
DOKU Wallet Payment Page URL generated by DOKU that merchant displays to the customer
additional_info.override_notification_url
string
Optional
Same as the request
Once you have the payment.url
, you can now display the payment page by redirecting your customer to the DOKU Wallet payment page.
After the customer completed the payment, they will be redirected to the defined success_url
that you set on the API request.
After the payment is being made by your customer, DOKU will send HTTP Notification to your defined Notification URL
. Learn how to handle the notification from DOKU: