doku-nodejs-library v1.0.51

Welcome to the DOKU Node.js library! This powerful tool simplifies access to the DOKU API for your server-side JavaScript applications.

Documentation

For detailed information, visit the full DOKU API Docs.

Requirements

• Node 18 or higher.

Installation

Get started by installing the library:

npm install doku

Usage

This section will guide you through setting up the DOKU Node.js library, creating payment requests, and handling notifications. Let’s get started!

1. Configuration

To configure the library, you'll need your account's Client ID, Secret Key, and Private Key. Here’s how:

1. Client ID and Secret Key: Retrieve these from the Integration menu in your DOKU Dashboard.
2. Private Key: Generate your Private Key following DOKU’s guide and insert the corresponding Public Key into the same menu.

!info Your private key will not be transmitted or shared with DOKU. It remains on your server and is only used to sign the requests you send to DOKU.

function initializeSnap() {
  snap = new doku.Snap({
    isProduction: false,
    clientId: 'your_client_id_here'
    secretKey: 'your_secret_key_here'
    privateKey: 'your_private_key_here',
  });
}

2. Payment Flow

This section guides you through the steps to process payments using the DOKU Node.js library. You'll learn how to create a payment request and call the payment function.

a. Virtual Account

DOKU offers three ways to use a virtual account: DOKU-Generated Payment Code (DGPC), Merchant-Generated Payment Code (MGPC), and Direct Inquiry Payment Code (DIPC). You can find the full details here.

!Important! Each transaction can use only one feature at a time, but you can use multiple features across different transactions.

DGPC and MGPC

createVaRequestDto Function

Create the request object to generate a VA number. Specify the acquirer in the request object. This function is applicable for DGPC and MGPC.

let createVaRequestDto = new CreateVARequestDto();

createVaRequestDto.partnerServiceId = "999999";
createVaRequestDto.customerNo = "0000000";
createVaRequestDto.virtualAccountNo = "9999990000000000";

createVaRequestDto.virtualAccountName = "Sukhito Tanawal";
createVaRequestDto.virtualAccountEmail = "sukhito.tanawal@gmail.com";
createVaRequestDto.virtualAccountPhone = "082191358706";
createVaRequestDto.trxId = "TRX-0001";

let totalAmount = new TotalAmount();
totalAmount.value = "12500.00";
totalAmount.currency = "IDR";
createVaRequestDto.totalAmount = totalAmount;

let virtualAccountConfig = new VirtualAccountConfig();
virtualAccountConfig.reusableStatus = false;

let additionalInfo = new AdditionalInfo("VIRTUAL_ACCOUNT_BANK_CIMB", virtualAccountConfig);
additionalInfo.channel = "VIRTUAL_ACCOUNT_BANK_CIMB";
additionalInfo.virtualAccountConfig = virtualAccountConfig;
createVaRequestDto.additionalInfo = additionalInfo;
createVaRequestDto.virtualAccountTrxType = "1";
createVaRequestDto.expiredDate = "2024-06-22T09:54:04+07:00";

createVa Function

Call the createVa function to request the paycode from DOKU. You’ll receive the paycode and payment instructions to display to your customers. This function is applicable for DGPC and MGPC.

await snap.createVa(createVaRequestDto).then(createVaResponseDto => {
    // You can get your payment code from variable createVaResponseDto
});

updateVa Function

Call the updateVa function to update Va

await snap.updateVa(updateVaRequestDto).then(updateVaResponseDto => {
    // You can get your payment code from variable updateVaResponseDto
});

deleteVa Function

Call the deleteVa function to delete Va

await snap.deletePaymentCode(deleteVaRequestDto).then(deleteVaResponseDto => {
    // You can get your payment code from variable deleteVaResponseDto
});

checkStatusVa Function

Call the checkStatusVa function to checkStatus Va

await snap.checkStatusVa(checkVaRequestDto).then(checkVaResponseDto => {
    // You can get your payment code from variable checkVaResponseDto
});

DIPC

#coming-soon inquiryResponse Function

If you use the DIPC feature, you can generate your own paycode and allow your customers to pay without direct communication with DOKU. After customers initiate the payment via the acquirer's channel, DOKU sends an inquiry request to you for validation. This function is applicable for DIPC.

app.post("/v1.1/transfer-va/inquiry",(req,res)=>{ //path must be /v1.1/transfer-va/inquiry after your domain
    let isvalid = snap.validateTokenB2B(req.headers['authorization']);
    if(isvalid){
      if(req.body){
        // validate virtualAccountNo from merchant DB
        let query = `select * from direct_inquiry_va where va_number = '${req.body.virtualAccountNo}'`;
        db.query(query ,(err, result) => {
          if(err){
            throw err
          }       
          if(result.rows.length>0){
            let updateQuery = `UPDATE direct_inquiry_va set status_va = 'inquiry', settlement_time = '${req.body.trxDateInit}' where va_number = '${req.body.virtualAccountNo}';`
            db.query(updateQuery ,(err, result) => {
              if(err){
                throw err
              }
              if(result){
                //use InquiryResponseBodyDTO to easily mapping response
                let bodyData = new InquiryResponseBodyDTO()
                bodyData.responseCode = "2002400";
                bodyData.responseMessage = "Successful"
                let vaData = new InquiryResponseVirtualAccountDataDTO()
                vaData.partnerServiceId = req.body.partnerServiceId;
                vaData.customerNo = req.body.customerNo;
                vaData.virtualAccountNo = req.body.virtualAccountNo;
                vaData.virtualAccountName = "Nama "+Date.now();
                vaData.virtualAccountEmail ="email."+Date.now()+"@gmail.com";
                vaData.virtualAccountPhone = `${Date.now()}`;
                let totalAmount = new TotalAmount()
                totalAmount.currency = "IDR";
                totalAmount.value = "25000.00"
                vaData.totalAmount = totalAmount;
                vaData.virtualAccountTrxType = "C"
                let additionalInfo = new InquiryResponseAdditionalInfoDTO()
                additionalInfo.channel = req.body.additionalInfo.channel;
                additionalInfo.trxId = "INV_MERCHANT_"+Date.now();
                let virtualAccountConfig = new VirtualAccountConfig()
                virtualAccountConfig.reusableStatus = true;
                virtualAccountConfig.maxAmount = "100000.00";
                virtualAccountConfig.minAmount = "10000.00"
                additionalInfo.virtualAccountConfig = virtualAccountConfig;
                vaData.additionalInfo = additionalInfo;
                vaData.inquiryStatus ="00";
                let inquiryReason = new InquiryReasonDto()
                inquiryReason.english = "Success";
                inquiryReason.indonesia = "Sukses";
                vaData.inquiryReason = inquiryReason;
                vaData.inquiryRequestId = req.body.inquiryRequestId;
                vaData.freeText = [
                        {
                          "english": "Free text",
                          "indonesia": "Tulisan Bebas"
                        }
                ]
                bodyData.virtualAccountData = vaData;
               res.status(200).send(bodyData.toObject()); //change dto to object with toObject()
              }
         
            })
          }else{
            res.status(401).send({
              "responseCode": "4012400",
              "responseMessage": "Virtual Account Not Found",
            });
          }
        })
      }else{
        let body ={
          "responseCode": "4010000",
          "responseMessage": "Unauthorized",
        }
         res.status(401).send(body);
      }
       
    }else{
      let body ={
        "responseCode": "4010000",
        "responseMessage": "Unauthorized",
      }
       res.status(401).send(body);
    }
})

!Important! Before sending the inquiry, DOKU sends a token request. Use the generateToken function found in the Handling Payment Notification section.

#coming-soon 3. Handling Payment Notification

After your customers make a payment, you’ll receive a notification from DOKU to update the payment status on your end. DOKU first sends a token request (as with DIPC), then uses that token to send the payment notification.

validateSignatureAndGenerateToken function

Generate the response to DOKU, including the required token, by calling this function.

 let response = snap.validateSignatureAndGenerateToken(req,endPointUrl); 
 // req is request from doku include header and body
 // endPointUrl is your api path

validateTokenAndGenerateNotificationReponse function

Deserialize the raw notification data into a structured object using a Data Transfer Object (DTO). This allows you to update the order status, notify customers, or perform other necessary actions based on the notification details.

let response = snap.validateTokenAndGenerateNotificationResponse(req.headers['authorization'],req.body);

generateNotificationResponse function

DOKU requires a response to the notification. Use this function to serialize the response data to match DOKU’s format.

let response = snap.generateNotificationResponse(isTokenValid,req.body);
//isTokenValid is boolean, true or false from validateToken function

#coming-soon 4. Additional Features

Need to use our functions independently? No problem! Here’s how:

- v1 to SNAP converter

If you're one of our earliest users, you might still use our v1 APIs. In order to simplify your re-integration process to DOKU's SNAP API specification, DOKU provides you with a helper tools to directly convert v1 APIs to SNAP APIs specification

a. convertRequestV1

Convert DOKU's inquiry and notification from SNAP format (JSON) to v1 format (XML). Feed the inquiry and notification directly to your app without manually mapping parameters or converting file formats.

 let formData = snap.directInquiryRequestMapping(req.headers,req.body);
//req headers and req body from request doku when hit inquiry

b. convertResponseV1

Convert your inquiry response to DOKU from v1 format (XML) to SNAP format (JSON). Our library handles response code mapping, allowing you to directly use the converted response and send it to DOKU.

let xmlToJson = snap.directInquiryResponseMapping(xml)
//xml string format