API Reference
DOKU DocsChangelogDOKU Github
  • Getting Started with DOKU API
    • User Registration
    • Idempotency Request
    • Notification
      • Setup Notification URL
      • HTTP Notification Sample for SNAP
      • HTTP Notification Sample - Non SNAP
      • Best Practice
      • Retry Notification
      • Override Notification URL
    • Signature Component
      • Non-SNAP
        • Signature Component from Request Header
        • Signature Componen from Response Header
        • Signature from API Get Method
        • Sample Code
      • SNAP
        • Symmetric Signature
        • Asymmetric Signature
    • Response Code
      • HTTP Status and Case Code
    • Check Status API
      • Non-SNAP
      • SNAP
    • Retrieve Payment Credential
  • Accept Payment
    • DOKU Checkout
      • Integration Guide
        • Backend Integration
        • Frontend Integration
        • Simulate payment and Notification
      • Supported Payment Methods
      • Status Order
      • Additional Feature
        • Tokenization
        • Promo on DOKU Checkout Page
        • Track Campaign Source on Google Analytics
      • Checkout Settings
    • Direct API
      • Non-SNAP
        • Cards
          • Payment Page Integration Guide
          • Host-To-Host Integration Guide
          • Mastercard Automatic Billing Updater (ABU) Integration Guide
            • Backend Integration
        • e-Wallet
          • Overview
          • DOKU e-Wallet
          • OVO Push Payment
          • ShopeePay
          • LinkAja
        • Paylater
          • Akulaku
          • Kredivo
          • Indodana
        • Digital Banking
          • Jenius Pay
        • Convenience Store
          • Alfa Group
          • Indomaret
      • SNAP
        • Integration Guide
          • Get Token API
            • B2B
            • B2B2C
          • Virtual Account
            • CIMB Virtual Account
            • BSI Virtual Account
            • BCA Virtual Account
            • BNC Virtual Account
            • BNI Virtual Account
            • Mandiri Virtual Account
            • BRI Virtual Account
            • BTN Virtual Account
            • Permata Virtual Account
            • Danamon Virtual Account
            • BSS Virtual Account
          • E-Wallet
            • DOKU Wallet
            • DANA
            • OVO
            • ShopeePay
          • Direct Debit
            • Allo Bank Direct Debit
            • BRI Direct Debit
            • CIMB Direct Debit
            • Mandiri Direct Debit
          • Kartu Kredit Indonesia Cepat Secure(KKI CPTS)
            • Host to Host Integration
          • QRIS
    • Finance and Settlement
      • Split Settlement
      • Custom Settlement Report
      • Hold and Release Settlement
      • Bulk Registration Bank
    • Test on DOKU Demo Site
    • DOKU Payment Simulator
  • Developer Kit
    • Postman Collection
    • Libraries and SDK
  • Wallet As A Service
    • Sub Account
  • Partnership
    • Partner API
      • Check Requirements API
      • Generate Token API
      • Upload File API
      • Business Registration API
      • Create Business Lite API
      • Get Business Data API
  • Payout
    • Kirim DOKU
  • FLEXIBILL
    • Account Billing
      • Batch Upload
    • DOKU Biller
      • Response Code
      • Samples
  • PAYCHAT API
    • Send WhatsApp Message
  • Archive
    • Non-SNAP
      • Tokenization V1
      • e-Wallet
        • OVO Recurring
        • OVO Open API
    • SNAP
      • Virtual Account
        • BCA v1.0
        • BRI v1.0
        • BNI v1.0
        • BNC v1.0
        • Mandiri v1.0
        • BTN v1.0
        • Permata v1.0
        • Danamon Virtual Account
      • e-Wallet
        • OVO Open API
        • DANA
        • ShopeePay
      • Direct Debit
        • CIMB Direct Debit
        • BRI Direct Debit
        • Allobank
Powered by GitBook

DOKU API

  • Legacy Documentation
On this page

Was this helpful?

  1. Accept Payment
  2. Direct API
  3. Non-SNAP
  4. e-Wallet

DOKU e-Wallet

Doku e-Wallet API Guide Explanation

PreviousOverviewNextOVO Push Payment

Last updated 6 months ago

Was this helpful?

Integration steps

Here is the overview of how to integrate with DOKU e-Wallet:

  1. Obtain payment.url by generating order

  2. Display DOKU Wallet payment page to customer

  3. Acknowledge payment result

Direct API - DOKU e-Wallet Sequence Diagram


1. Obtain payment.url by generating order

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

API Request

Type
Value

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: MCH-0001-10791114622547
Request-Id: baec7d95-f30a-4b78-b711-6ebe0ccdf50b
Request-Timestamp: 2021-07-07T08:45:42Z
Signature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=

Request Header Explanation

Parameter
Description

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

Here is the sample request body to generate order:

{
    "order": {
        "invoice_number":"TEST-1234",
        "amount": 9000,
        "line_items": [
            {
                "name": "T-Shirt Red",
                "price": 3000,
                "quantity": 2
            },
            {
                "name": "Polo Navy",
                "price": 3000,
                "quantity": 1
            }
        ],
        "success_url": "https://your-success-url.domain/",
        "failed_url": "https://your-failed-url.domain/",
        "notify_url": "https://merchant.com/notify-url",
        "auto_redirect": false
    },
    "additional_info": {
        "override_notification_url": "https://another.example.com/payments/notifications"
    }
}

Request Body Explanation

Parameter
Type
Mandatory
Description

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

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

API Response

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

Type
Value

HTTP Status

200

Result

SUCCESS

Client-Id: MCH-0001-10791114622547
Request-Id: baec7d95-f30a-4b78-b711-6ebe0ccdf50b
Response-Timestamp: 2021-07-07T08:45:42Z
Signature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=

Response Header Explanation

Parameter
Description

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": "JT-JOKUL-PP_20220125093936",
        "line_items": [
            {
                "name": "T-Shirt Red",
                "price": 3000,
                "quantity": 2
            },
            {
                "name": "Polo Navy",
                "price": 3000,
                "quantity": 1
            }
        ]
    },
    "doku_wallet_payment_page": {
        "url": "https://staging.doku.com/wallauth/jokultransaction?sessionId=ff54640d-8a3d-4efb-a867-47785971c7c9"
    },
    "additional_info": {
        "override_notification_url": "https://another.example.com/payments/notifications"
    }
}

Response Body Explanation

Parameter
Type
Mandatory
Description

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


2. Display DOKU Wallet payment page to customer

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.


3. Acknowledge payment result

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:


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 to generate the signature

Merchant URL that will redirected to after the order success. If merchant set order.auto_redirect to true, then the default url is ". Allowed chars: alphabetic, numeric, special chars

This parameter is intended to override the configured Notification URL with another URL. Click for more information.

Handling DOKU HTTP Notification
this section
www.doku.com"
here