DOKU Wallet
Overview
Introduction
DOKU Wallet is a payment method which allows to process payments in Indonesian rupiahs by using e-wallets in Indonesia. This method supports purchases and payouts.
This article provides information about working with the DOKU Wallet method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.
General information
Payment method type | digital wallet payments |
---|---|
Payment instruments | digital wallets |
Countries and regions | ID |
Payment currencies | IDR |
Currency conversion | on the ecommpay side; refer to your ecommpay key account manager to enable currency conversion |
One-time purchases | + |
Credential-on-file purchases | – |
Full refunds | contact ecommpay technical support |
Partial refunds | contact ecommpay technical support |
Payouts | + |
Chargebacks | – |
Notes |
|
Onboarding and access fee | refer to your ecommpay key account manager, additional information available in the ecommpay shop |
Interaction diagram
Payment processing by using the DOKU Wallet method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the DOKU Wallet service.
Operations support
Various platform interfaces can be used to process payments and perform operations using the DOKU Wallet method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), payouts—by using Gate and Dashboard. At the same time, regardless of the interfaces used, the following properties and limitations are applicable.
When working with the DOKU Wallet the following properties and limitations are applicable.
Amounts, IDR ¹ | Times ² | |||
---|---|---|---|---|
minimum | maximum | basic | threshold | |
Purchases | 1.00 | 2,000,000.00 until KYC * 10,000,000.00 since KYC |
Under a minute | Refer to your ecommpay key account manager |
Payouts | 1.00 | 10 000 000,00 | Under 5 minutes | Refer to your ecommpay key account manager |
- KYC or Know Your Customer is the process that allows organisations to verify clients and prevent frauds.
- The base and threshold times are defined as follows:
- The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
- The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the
decline
status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.
Processing scenarios
To perform a purchase by using the DOKU Wallet method, you need to redirect the customer to the DOKU Wallet service, while to initiate a payout, you need to notify the customer via the web service.
Purchases by using Payment Page
General information
To process a purchase through Payment Page by using the DOKU Wallet method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.
Information about the formats of requests and callbacks used for processing payments by using the DOKU Wallet method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.
Request format
There are several things you need to consider when using the DOKU Wallet method:
- The following parameters required for any payment must be specified:
project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectpayment_currency
—payment currency code in the ISO-4217 alpha-3 formatpayment_amount
—payment amount in the smallest currency unitcustomer_id
—customer identifier unique within the project
- The following parameters required for any payment must be specified:
project_id
,payment_id
,payment_currency
,payment_amount
,customer_id
. - Additionally, it is recommended to specify the first name and email address of the customer in the parameters
customer_first_name
andcustomer_email
. If any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information). - If you need to have the payment form displayed with the DOKU Wallet method selected, set the
force_payment_method
parameter todoku
. - Additionally, any other parameters available for working with Payment Page can be used (details).
- After all target parameters are specified, generate a signature (details).
Thus, a correct request for opening the payment form using the DOKU Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), identifier, first name and email address of the customer, as well as signature.
Callback format
In the DOKU Wallet method, the callbacks that deliver purchase results use the standard format described in Callbacks.
The following is the example of a callback with information about a 1,000.00 IDR
purchase made in the 238
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Payment Page:
- Interaction concepts—about the interaction with the payment platform by using Payment Page.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Purchases by using Gate
General information
To process a purchase through Gate by using the DOKU Wallet method, the merchant's web service is required to do the following:
- Send a request with all the required parameters and signature to the ecommpay URL.
- Receive an intermediate callback from the payment platform and redirect the customer to the DOKU Wallet service.
- Receive the final callback from the payment platform.
The full sequence and special aspects of purchase processing are provided below.
Information about the formats of requests and callbacks used for processing payments by using the DOKU Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you must consider when using purchase requests in the DOKU Wallet method:
- To initiate each purchase, send a separate POST request to the
/v2/payment/wallet/doku/sale
endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale. - Each request must include the following objects and parameters:
- Object
general
—general purchase information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectsignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
- Object
payment
—payment information:amount
—payment amount in the smallest currency unitcurrency
—payment currency code in the ISO-4217 alpha-3 format
- Object
customer
—customer information:id
—customer identifier unique within the projectip_address
—customer IP address relevant for the initiated payment
- Object
- Additionally, it is recommended to specify the following parameters:
- Object
customer
—customer information:first_name
—first name of the customeremail
—email address of the customer
If any of these parameters are missing, the payment platform may send the list of missing parameters in a callback requesting additional information submission (details are available in Submission of additional payment information).
- Object
- Additionally, any other parameters included in the specification can be used.
Thus, a correct purchase request by using the DOKU Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), identifier, first name, email address and IP address of the customer, as well as signature.
Formats of intermediate callbacks for customer redirection
Each payment made with the DOKU Wallet method requires redirection of customers from the merchant's web service to the DOKU Wallet service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data
object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data
object:
body
—object with data to be sent in the request bodymethod
—parameter specifying the HTTP method for sending the request (GET
orPOST
)url
—parameter containing a link for redirection
Final callback format
In the DOKU Wallet method, the callbacks that deliver purchase results use the standard format described in Callbacks.
The following is the example of a callback with information about a 1,000.00 IDR
purchase made in the 238
project.
The following is the example of a callback with information about a declined purchase.
Useful links
The following articles can be useful when implementing purchases via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Payouts by using Gate
General information
To process a payout through Gate by using the DOKU Wallet method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.
Information about the formats of requests and callbacks used for processing payouts by using the DOKU Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.
Request format
There are several things you need to consider when sending payout requests by using the DOKU Wallet method:
- To initiate each payout send a separate POST request to the
/v2/payment/wallet/doku/payout
endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/payout. - Each request must include the following objects and parameters:
- Object
general
—general payout information:project_id
—project identifier obtained from ecommpay during integrationpayment_id
—payment identifier unique within the projectsignature
—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
- Object
payment
—payment information:amount
—payout amount in the smallest currency unitcurrency
—payout currency code in the ISO-4217 alpha-3 format
- Object
customer
—customer information:id
—customer identifier unique within the projectip_address
—customer IP address relevant for the initiated payout
- Object
account
—customer e-wallet information:number
—customer e-wallet numbercustomer_name
—full customer name
- Object
- Additionally, any other parameters included in the specification can be used.
Thus, a correct payout request by using the DOKU Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), identifier, e-wallet number, full name and IP address, as well as signature.
Callback format
In the DOKU Wallet method, the callbacks that deliver payout results use the standard format described in Callbacks.
The following is the example of a callback with information about a 1.00 IDR
payout made in the 580
project.
The following is the example of a callback with information about a declined payout.
Useful links
The following articles can be useful when implementing payouts via Gate:
- Interaction concepts—about the interaction with the payment platform by using Gate.
- Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
- Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
- Payouts—about processing of payouts by using Gate.
- Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.
Testing
General information
For the DOKU Wallet method, it is possible to test purchases by using Payment Page and Gate, as well as payouts by using Gate. To enable and disable testing, as well getting assistance with setting up a test project, refer to ecommpay technical support.
When testing payments and operations keep in mind that the test project identifier must be indicated in requests, only the IDR currency can be used, the interfaces of the emulator of Payment Page and DOKU Wallet payment forms can differ from the production environment.
Statuses of test payments and operations
The final status of test payments and operations is determined by the amount specified in the request.
Test purchases:
decline
status with40000
or40400
amountsuccess
status with any other amount
Test payouts:
decline
status with40000
or40400
amountsuccess
status with any other amount
Purchases by using Payment Page
To perform a test purchase by using Payment Page, do the following:
- Send a correct test request for Payment Page opening to the payment platform.
- If the
doku
method was not specified in the request—select the method on the emulator page. - Specify a random email address and a random first name in the data entry fields.
- Click the Success or Decline button (depending on the amount specified in the request).
- Receive the final callback with information about the payment result.
More information about processing purchases by using the DOKU Wallet method via Payment Page is provided in the Purchases by using Payment Page section.
Purchases by using Gate
To perform test purchases by using Gate, it is necessary to submit a URL for redirection to the test purchases confirmation page to ecommpay technical support (due to the peculiarities of the DOKU Wallet service one URL is used for payments with success
and decline
statuses), and receive a confirmation about the possibility of testing purchases. After that, do the following for every test purchase:
- Send a correct test request for purchase to the payment platform.
- Accept a callback with redirection data.
- Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
- Make sure that the test purchase confirmation page is displayed.
- Receive the final callback with information about the payment result.
More information about processing purchases by using the DOKU Wallet method via Gate is provided in the Purchases by using Gate section.
Payouts by using Gate
o process a test payout by using Gate, send a valid test request for a payout to the payment platform and receive a final callback with information about the payout result. More information about processing payouts by using the DOKU Wallet method via Gate is provided in the Payouts by using Gate section.
Analysis of payments results
To analyse information about payments made with the DOKU Wallet method and other methods, you can use:
- Dashboard interface toolkit with various lists and analytic panels.
- Reports in CSV file format, available via the Reports section (one-time and periodically).
- Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.
If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.