Kirim DOKU

Kirim DOKU is a service designed to facilitate seamless domestic fund transfers. With Kirim DOKU, users can send money directly to recipients' bank accounts within the country without the need to visit a physical bank.

How Kirim DOKU works ?

Kirim DOKU

1. Account Inquiry

Before initiating a fund transfer, it is crucial to verify the validity of both the sender's and the recipient's bank accounts. Ensuring account accuracy helps prevent transaction errors and supports a seamless transfer process.

Completing an Account Inquiry is mandatory before proceeding with a bank transfer.

1. Balance Inquiry

Perform a Balance Inquiry to confirm that sufficient funds are available in the sender's account to complete the transaction. This step minimizes the risk of failed transactions due to insufficient balance.

1. Transfer Bank

This process involves transferring funds from the sender's account to the recipient's account. Ensure all required details, including the recipient's bank account information and the transfer amount, are accurately provided.

1. Check Status

Track the status of your transfer to confirm its completion. This feature allows real-time monitoring and provides transparency for both the sender and recipient.

Integration Guide

1. Account Inquiry

POSThttps://api-sandbox.doku.com/v1.0/emoney/bank-account-inquiry

Header parameters

Body

application/json

partnerReferenceNostring

Transaction identifier on service consumer system, generated by KD partner

Example: "hsjkans284b2he54"

customerNumberstring

Customer account number in phone number format

Example: "628115678890"

amountamountRequestDTO (object)

beneficiaryAccountNumberstring

Destination account number

Example: "8377388292"

additionalInfoBankAccountInquiryAdditionalInfoReqDTO (object)

Response

200400

Transfer bank processed

Body

application/json

responseCodestring

Example: 2004200

responseMessagestring

Example: "Successful"

referenceNoany

Example: "I0438729855304540"

partnerReferenceNostring

Example: "hsjkans284b2he54"

beneficiaryAccountNumberstring

Example: "8377388292"

beneficiaryAccountNamestring

Example: "SUHUT"

beneficiaryBankCodestring

Example: "014"

beneficiaryBankShortNamestring

Example: "Bank Central Asia BCA"

beneficiaryBankNamestring

Example: "Bank Central Asia BCA"

amountamountRequestDTO (object)

sessionIdstring

Example: "I0438729855304540"

additionalInfoInquiryAdditionalInfoResDTO (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/v1.0/emoney/bank-account-inquiry', {
    method: 'POST',
    headers: {
      "X-EXTERNAL-ID": "text",
      "X-PARTNER-ID": "text",
      "X-SIGNATURE": "text",
      "X-TIMESTAMP": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseCode": 2004200,
  "responseMessage": "Successful",
  "referenceNo": "I0438729855304540",
  "partnerReferenceNo": "hsjkans284b2he54",
  "beneficiaryAccountNumber": "8377388292",
  "beneficiaryAccountName": "SUHUT",
  "beneficiaryBankCode": "014",
  "beneficiaryBankShortName": "Bank Central Asia BCA",
  "beneficiaryBankName": "Bank Central Asia BCA",
  "amount": {
    "value": "200000.00",
    "currency": "IDR"
  },
  "sessionId": "I0438729855304540",
  "additionalInfo": {
    "senderCountryCode": "ID",
    "forexRate": "1.00",
    "forexOriginCurrency": "IDR",
    "feeAmount": "4500.00",
    "feeCurrency": "IDR",
    "beneficiaryAmount": "200000.00",
    "referenceNumber": "c5fe5465-0843-4ac7-9c93-57cb2c5ef6b2"
  }
}

2. Balance Inquiry

POSThttps://api-sandbox.doku.com/v1.0/balance-inquiry

Header parameters

Body

application/json

partnerReferenceNostring

Transaction identifier on service consumer system, generated by partner.

accountNostring

Example: "A41879"

Response

200400

Transfer bank processed

Body

application/json

responseCodestring

Example: 2001100

responseMessagestring

Example: "Successful"

accountNostring

Example: "A41879"

namestring

Example: "Simulator Indo Agent"

accountInfosobject

additionalInfoBalanceAdditionalInfoResDTO (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/v1.0/balance-inquiry', {
    method: 'POST',
    headers: {
      "X-EXTERNAL-ID": "text",
      "X-PARTNER-ID": "text",
      "X-SIGNATURE": "text",
      "X-TIMESTAMP": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseCode": 2001100,
  "responseMessage": "Successful",
  "accountNo": "A41879",
  "name": "Simulator Indo Agent",
  "accountInfos": {
    "holdAmount": {
      "value": "0.00",
      "currency": "IDR"
    },
    "avaliableBalance": {
      "value": "823781442.13",
      "currency": "IDR"
    }
  },
  "additionalInfo": {
    "creditAlertLimit": {
      "value": "65000.00",
      "currency": "IDR"
    }
  }
}

3. Transfer Bank

POSThttps://api-sandbox.doku.com/v1.0/emoney/transfer-bank

Header parameters

Body

application/json

partnerReferenceNo*string

Transaction identifier on service consumer system, generated by KD partners. Must be unique per request.

Example: "hsjkans284b2he54"

customerNumber*string

Customer Account Number in Phone Number format

Example: "628115678890"

beneficiaryAccountNumber*string

Destination account number

Example: "8377388292"

beneficiaryBankCode*string

Bank code

Example: "014"

amount*amountRequestDTO (object)

sessionIdstring

Inquiry invoice id

Example: "I0438729855304540"

feeTypeany

Example: ""

additionalInfoRemitAdditionalInfoReqDTO (object)

Response

200400

Transfer bank processed

Body

application/json

responseCodestring

Example: 2004300

responseMessagestring

Example: "Successful"

referenceNostring

Example: "DK01123220"

partnerReferenceNostring

Example: "2020102900000000000001"

transactionDatestring

Example: "2022-11-11T10:51:48+07:00"

referenceNumberstring

Example: "39448581-c741-44f9-b3af-98616e2229b1"

additionalInfoRemitAdditionalInfoResDTO (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/v1.0/emoney/transfer-bank', {
    method: 'POST',
    headers: {
      "X-EXTERNAL-ID": "text",
      "X-PARTNER-ID": "text",
      "X-SIGNATURE": "text",
      "X-TIMESTAMP": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "partnerReferenceNo": "hsjkans284b2he54",
      "customerNumber": "628115678890",
      "beneficiaryAccountNumber": "8377388292",
      "beneficiaryBankCode": "014",
      "amount": {}
    }),
});
const data = await response.json();

Response

200400

{
  "responseCode": 2004300,
  "responseMessage": "Successful",
  "referenceNo": "DK01123220",
  "partnerReferenceNo": "2020102900000000000001",
  "transactionDate": "2022-11-11T10:51:48+07:00",
  "referenceNumber": "39448581-c741-44f9-b3af-98616e2229b1",
  "additionalInfo": {
    "sessionId": "I0438729855304540",
    "amount": "200000.00"
  }
}

4. Check Status

POSThttps://api-sandbox.doku.com/v1.0/qr/qr-mpm-status

Header parameters

Body

application/json

originalPartnerReferenceNo*string

Original transaction identifier on service consumer system. Filled with partnerReferenceNo from remit/transfer API

Example: "hsjkans284b2he54"

originalReferenceNostring

Original transaction identifier on service provider system. Can be filled with referenceNo or sessionId from remit/transfer API.

Example: "hsjkans284b2he54"

originalExternalIdstring

Original transaction identifier on service provider system. Can be filled with X-EXTERNAL_ID from remit/transfer API.

Example: "892834eWg"

serviceCode*string

Transaction type indicator (service code of the original transaction request).

Example: "43"

Response

200400

check status processed

Body

application/json

responseCodestring

Example: 2005300

responseMessagestring

Example: "Successful"

originalReferenceNostring

Example: "DK01123220"

originalPartnerReferenceNostring

Example: "2020102900000000000001"

serviceCodestring

Example: 43

latestTransactionStatusstring

00 - Success 03 - Pending 04 - Refunded 06 - Failed

Example: "00"

amountamountDTO (object)

transactionDatestring

transaction date : ISO 8601

Example: "2024-09-17T14:41:52. 022+07:00"

originalResponseCodestring

Example: 0

originalResponseMessagestring

Example: "Transfer Approve"

transactionStatusDescstring

Example: "Transaction is successfully processed"

sessionIdstring

Example: "I0438729855304540"

additionalInfoCheckStatusAdditionalInfoResDTO (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/v1.0/qr/qr-mpm-status', {
    method: 'POST',
    headers: {
      "X-EXTERNAL-ID": "text",
      "X-PARTNER-ID": "text",
      "X-SIGNATURE": "text",
      "X-TIMESTAMP": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "originalPartnerReferenceNo": "hsjkans284b2he54",
      "serviceCode": "43"
    }),
});
const data = await response.json();

Response

200400

{
  "responseCode": 2005300,
  "responseMessage": "Successful",
  "originalReferenceNo": "DK01123220",
  "originalPartnerReferenceNo": "2020102900000000000001",
  "serviceCode": 43,
  "latestTransactionStatus": "00",
  "amount": {
    "value": "65000.00",
    "currency": "IDR"
  },
  "transactionDate": "2024-09-17T14:41:52. 022+07:00",
  "originalResponseCode": 0,
  "originalResponseMessage": "Transfer Approve",
  "transactionStatusDesc": "Transaction is successfully processed",
  "sessionId": "I0438729855304540",
  "additionalInfo": {
    "cashInTime": "2024-09-17 13:56:57",
    "remark": "Remark test",
    "beneficiaryAmount": "200000.00"
  }
}

5. Unpaid Notification

For Sandbox Environment

• UNPAID to FAILED transaction

  • beneficiaryBankCode must be 002

  • beneficiaryAccountNumber must contain 12345

  • channel.code must be 07 (or not send the parameter at all)

• For UNPAID to SUCCESS/PAID transaction

  • beneficiaryBankCode must be other than 002, e.g. 014

  • beneficiaryAccountNumber must contain 12345

  • channel.code must be 07 (or not send the parameter at all)

This API is used to notify partners when the transaction status initially gets UNPAID status and then updated by DOKU's system to either Success or Failed. If partners don't want to implement Unpaid Notification API, they may opt to call the Transaction Info API to fetch the status of a transaction. To receive unpaid notifications, partners are required to prepare Callback URLs for sandbox and production environments. For UNPAID to PAID transactions. In the sandbox environment, the notification will be sent in under 5 minutes. For UNPAID to FAILED transactions In the sandbox environment, the notification will be sent at odd hours e.g. 1 P.M., 3 P.M., 5 P.M., and so on.

POSThttps://api-sandbox.doku.com/{merchantUrlUnpaidNotification}

Path parameters

merchantUrlUnpaidNotification*string

Merchant url path for receiving Unpaid notification by KIRIMDOKU provided by partner

Header parameters

Body

application/json

sendTrxIdstring

Transaction identifier on service consumer system, generated by partner.

transactionIdstring

Example: "DK0018353"

invoiceNumberstring

Transaction ID that have been updated

Example: "I088787987870912"

transactionStatusstring

Remit transaction status. Use this status to determine whether the beneficiary is receiving the funds or not. 50: Success, 35: Failed, 20: Unpaid, 40: Refunded.

Example: "50"

activityCodestring

Specific notification code

Example: "200"

messagestring

Notification message “Transaction is Success” or “Transaction is Failed”

Example: "Transaction is Success"

processDatestring

Update time in yyyy-MM-ddTHH:mm:ss format

Example: "2024-01-12'T'07:30:12"

createdTimestring

Payment creation time in Epoch time format

Example: "1699520040340"

Response

200

Notification processed Successfully

Body

application/json

status*boolean

Unpaid notification status

Example: true

transactionId*string

Transaction ID that is sent from KIRIMDOKU to request notify

Example: "DK0018353"

responseCode*string

Flagging code for response notification of unpaid activity 00: The callback is processed successfully, 01: The callback has been processed before, Other codes: Failed occurs

Example: "00"

responseMessage*string

A message describing the response notification

Example: "Successfully processed"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/{merchantUrlUnpaidNotification}', {
    method: 'POST',
    headers: {
      "requestId": "text",
      "agentKey": "text",
      "signature": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "status": true,
  "transactionId": "DK0018353",
  "responseCode": "00",
  "responseMessage": "Successfully processed"
}

6. Refund Notification

For Sandbox Environment, beneficiaryAccountNumber parameter must be 7746555134

This API is used to notify partners when a refund occurs in the KIRIMDOKU system. KIRIMDOKU will notify partners with the URL that has been registered, and the notification will be done maximum 3 times or until the notification callback response is correct. If partners don't want to implement Refund Notification API, they may opt to call the Transaction Info API to fetch the status of a transaction. To receive refund notifications, partners are required to prepare Callback URLs for sandbox and production environments. In the sandbox environment, the notification will be sent in 5 minutes after the partner hits the remit API.

POSThttps://api-sandbox.doku.com/{merchantUrlRefundNotification}

Path parameters

merchantUrlRefundNotification*string

Merchant url path for receiving Refund notification by KIRIMDOKU provided by partner

Header parameters

Body

application/json

transactionIdstring

Example: "DK0018353"

activityCodestring

Specific notification code

Example: "200"

messagestring

Notification message “Transaction is Success” or “Transaction is Failed”

Example: "Transaction is Refunded"

processDatestring

Update time in yyyy-MM-ddTHH:mm:ss format

Example: "2024-01-12'T'07:30:12"

Response

200

Notification processed Successfully

Body

application/json

status*boolean

Unpaid notification status

Example: true

transactionId*string

Transaction ID that is sent from KIRIMDOKU to request notify

Example: "DK0018353"

responseCode*string

Flagging code for response notification of unpaid activity 00: The callback is processed successfully, 01: The callback has been processed before, Other codes: Failed occurs

Example: "00"

responseMessage*string

A message describing the response notification

Example: "Successfully processed"

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api-sandbox.doku.com/{merchantUrlRefundNotification}', {
    method: 'POST',
    headers: {
      "requestId": "text",
      "agentKey": "text",
      "signature": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "status": true,
  "transactionId": "DK0018353",
  "responseCode": "00",
  "responseMessage": "Successfully processed"
}