Unpaid Notification

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)

post

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.

Path parameters

merchantUrlUnpaidNotificationstringRequired

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

Header parameters

requestIdstringRequired

Unique reference identification sent by the API partner.

Example: fd53b1e3-9c35-4dfa-a95ca8dbc5695485

agentKeystringRequired

Hash key of authorization agent

Example: A41418

signaturestringRequired

Unique authorization code generated by partner validated by KIRIMDOKU

Example: ieNOENDdN4MnectGytx5UvmOfASZ2oGWMCJ8gVqkw3tB98ofgY9cbxSeY4IYoYeoKs+0QP4h8BTBhemlfeXp1w==

Content-TypestringRequired

The Content-Type field indicates that JSON type is acceptable to send to the recipient

Example: application/json

Body

application/json

sendTrxIdstring · max: 64Optional

Transaction identifier on service consumer system, generated by partner.

transactionIdstring · max: 16RequiredExample: DK0018353

invoiceNumberstringRequired

Transaction ID that have been updated

Example: I088787987870912

transactionStatusstringRequired

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

activityCodestringRequired

Specific notification code

Example: 200

messagestringRequired

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

Example: Transaction is Success

processDatestringRequired

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

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

createdTimestringRequired

Payment creation time in Epoch time format

Example: 1699520040340

Responses

200

Notification processed Successfully

application/json

post

HTTPcURLJavaScriptPython

POST /{merchantUrlUnpaidNotification} HTTP/1.1
Host: {merchant-domain}
requestId: text
agentKey: text
signature: text
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "sendTrxId": "text",
  "transactionId": "DK0018353",
  "invoiceNumber": "I088787987870912",
  "transactionStatus": "50",
  "activityCode": "200",
  "message": "Transaction is Success",
  "processDate": "2024-01-12'T'07:30:12",
  "createdTime": "1699520040340"
}

200

Notification processed Successfully

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