Download the PHP package doku/doku-php-library without Composer

On this page you can find all versions of the php package doku/doku-php-library. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of doku/doku-php-library

Informations about the package doku-php-library

DOKU PHP SDK Documentation

Introduction

Welcome to the DOKU PHP SDK! This SDK simplifies access to the DOKU API for your server-side PHP applications, enabling seamless integration with payment and virtual account services.

If your looking for another language Node.js, Go, Python, Java

Table of Contents

1. Getting Started

Requirements

Installation

To install the Doku Snap SDK, use Composer:

Configuration

Before using the Doku Snap SDK, you need to initialize it with your credentials:

  1. Client ID, Secret Key and DOKU Public Key: Retrieve these from the Integration menu in your Doku Dashboard
  2. Private Key and Public Key : Generate your Private Key and Public Key

How to generate Merchant privateKey and publicKey :

  1. generate private key RSA : openssl genrsa -out private.key 2048
  2. set passphrase your private key RSA : openssl pkcs8 -topk8 -inform PEM -outform PEM -in private.key -out pkcs8.key -v1 PBE-SHA1-3DES
  3. generate public key RSA : openssl rsa -in private.key -outform PEM -pubout -out public.pem

The encryption model applied to messages involves both asymmetric and symmetric encryption, utilizing a combination of Private Key and Public Key, adhering to the following standards:

  1. Standard Asymmetric Encryption Signature: SHA256withRSA dengan Private Key ( Kpriv ) dan Public Key ( Kpub ) (256 bits)
  2. Standard Symmetric Encryption Signature HMAC_SHA512 (512 bits)
  3. Standard Symmetric Encryption AES-256 dengan client secret sebagai encryption key.
Parameter Description Required
privateKey The private key for the partner service. ✅
publicKey The public key for the partner service. ✅
dokuPublicKey Key that merchants use to verify DOKU request ✅
clientId The client ID associated with the service. ✅
secretKey The secret key for the partner service. ✅
isProduction Set to true for production environment ✅
issuer Optional issuer for advanced configurations. ❌
authCode Optional authorization code for advanced use. ❌

2. Usage

Initialization Always start by initializing the Snap object.

Virtual Account

I. Virtual Account (DGPC & MGPC)

DGPC

Parameters for createVA and updateVA

Parameter Description Data Type Required
partnerServiceId The unique identifier for the partner service. String(20) ✅
customerNo The customer's identification number. String(20) ✅
virtualAccountNo The virtual account number associated with the customer. String(20) ✅
virtualAccountName The name of the virtual account associated with the customer. String(255) ✅
virtualAccountEmail The email address associated with the virtual account. String(255) ❌
virtualAccountPhone The phone number associated with the virtual account. String(9-30) ❌
trxId Invoice number in Merchants system. String(64) ✅
totalAmount value: Transaction Amount (ISO 4217)
Example: "11500.00"		 String(16.2) ✅
Currency: Currency
Example: "IDR"		 String(3) ✅
additionalInfo channel: Channel that will be applied for this VA
Example: VIRTUAL_ACCOUNT_BANK_CIMB		 String(20) ✅
virtualAccountConfig reusableStatus: Reusable Status For Virtual Account Transaction
value TRUE or FALSE		 Boolean ❌
minAmount: Minimum Amount can be used only if virtualAccountTrxType is Open Amount (O).
Example: "10000.00"		 String(16.2) ❌
maxAmount: Maximum Amount can be used only if virtualAccountTrxType is Open Amount (O).
Example: "5000000.00"		 String(16.2) ❌
virtualAccountTrxType Transaction type for this transaction. C (Closed Amount), O (Open Amount) String(1) ✅
expiredDate Expiration date for Virtual Account. ISO-8601
Example: "2023-01-01T10:55:00+07:00"		 String ❌

  1. Create Virtual Account

    • Function: createVa

  2. Update Virtual Account

    • Function: updateVa

  3. Delete Virtual Account

    Parameter Description Data Type Required
    partnerServiceId The unique identifier for the partner service. String(8) ✅
    customerNo The customer's identification number. String(20) ✅
    virtualAccountNo The virtual account number associated with the customer. String(20) ✅
    trxId Invoice number in Merchant's system. String(64) ✅
    additionalInfo channel: Channel applied for this VA.
    Example: VIRTUAL_ACCOUNT_BANK_CIMB    		 String(30) ✅
    • Function: deletePaymentCode

II. Virtual Account (DIPC)

III. Check Virtual Account Status

Parameter Description Data Type Required
partnerServiceId The unique identifier for the partner service. String(8) ✅
customerNo The customer's identification number. String(20) ✅
virtualAccountNo The virtual account number associated with the customer. String(20) ✅
inquiryRequestId The customer's identification number. String(128) ❌
paymentRequestId The virtual account number associated with the customer. String(128) ❌
additionalInfo The virtual account number associated with the customer. String ❌

B. Binding / Registration Operations

The card registration/account binding process must be completed before payment can be processed. The merchant will send the card registration request from the customer to DOKU.

Each card/account can only registered/bind to one customer on one merchant. Customer needs to verify OTP and input PIN.

Services Binding Type Details
Direct Debit Account Binding Supports Allo Bank and CIMB
Direct Debit Card Registration Supports BRI
E-Wallet Account Binding Supports OVO

I. Account Binding

  1. Binding
Parameter Description Data Type Required
phoneNo Phone Number Customer.
Format: 628238748728423 		String(9-16) ✅
additionalInfo channel: Payment Channel
 String ✅
custIdMerchant: Customer id from merchant String(64) ✅
customerName: Customer name from merchant String(70) ❌
email: Customer email from merchant String(64) ❌
idCard: Customer id card from merchant String(20) ❌
country: Customer country String ❌
address: Customer Address String(255) ❌
dateOfBirth String(YYYYMMDD) ❌
successRegistrationUrl: Redirect URL when binding is success String ✅
failedRegistrationUrl: Redirect URL when binding is success fail String ✅
deviceModel: Device Model customer String ✅
osType: Format: ios/android String ✅
channelId: Format: app/web String ✅

  1. Unbinding

    • Function: getTokenB2B2C
    • Function: doAccountUnbinding

II. Card Registration

  1. Registration

    • Function: doCardRegistration

  2. UnRegistration

    • Function: getTokenB2B2C

    • Function: doCardUnbinding

C. Direct Debit and E-Wallet

I. Request Payment

Once a customer’s account or card is successfully register/bind, the merchant can send a payment request. This section describes how to send a unified request that works for both Direct Debit and E-Wallet channels.

Acquirer Channel Name
Allo Bank DIRECT_DEBIT_ALLO_SNAP
BRI DIRECT_DEBIT_BRI_SNAP
CIMB DIRECT_DEBIT_CIMB_SNAP
OVO EMONEY_OVO_SNAP
Common parameter
Parameter Description Data Type Required
partnerReferenceNo Reference No From Partner
Format: 628238748728423 		String(9-16) ✅
amount value: Transaction Amount (ISO 4217)
Example: "11500.00"		 String(16.2) ✅
Currency: Currency
Example: "IDR"		 String(3) ✅
additionalInfo channel: payment channel String ✅
remarks:Remarks from Partner String(40) ✅
successPaymentUrl: Redirect Url if payment success String ✅
failedPaymentUrl: Redirect Url if payment fail String ✅
Allo Bank Specific Parameters
Parameter Description Required
additionalInfo.remarks Remarks from the partner ✅
additionalInfo.lineItems.name Item name (String) ✅
additionalInfo.lineItems.price Item price (ISO 4217) ✅
additionalInfo.lineItems.quantity Item quantity (Integer) ✅
payOptionDetails.payMethod Balance type (options: BALANCE/POINT/PAYLATER) ✅
payOptionDetails.transAmount.value Transaction amount ✅
payOptionDetails.transAmount.currency Currency (ISO 4217, e.g., "IDR") ✅
CIMB Specific Parameters
Parameter Description Required
additionalInfo.remarks Remarks from the partner ✅
OVO Specific Parameters
Parameter Description Required
feeType Fee type from partner (values: OUR, BEN, SHA) ❌
payOptionDetails.payMethod Payment method format: CASH, POINTS ✅
payOptionDetails.transAmount.value Transaction amount (ISO 4217) ✅
payOptionDetails.transAmount.currency Currency (ISO 4217, e.g., "IDR") ✅
payOptionDetails.feeAmount.value Fee amount (if applicable) ✅
payOptionDetails.feeAmount.currency Currency for the fee ✅
additionalInfo.paymentType Transaction type (values: SALE, RECURRING) ✅

Here’s how you can use the doPayment function for both payment types:

II. Request Payment Jump APP

Acquirer Channel Name
DANA EMONEY_DANA_SNAP
ShopeePay EMONEY_SHOPEE_PAY_SNAP

The following fields are common across DANA and ShopeePay requests:

Parameter Description Data Type Required
partnerReferenceNo Reference No From Partner
Examplae : INV-0001 		String(9-16) ✅
validUpto Expired time payment url String ❌
pointOfInitiation Point of initiation from partner,
value: app/pc/mweb 		String ❌
urlParam url: URL after payment sucess String ✅
type: Pay Return
always PAY_RETURN 		String ✅
isDeepLink: Is Merchant use deep link or not
Example: "Y/N"		 String(1) ✅
amount value: Transaction Amount (ISO 4217)
Example: "11500.00"		 String(16.2) ✅
Currency: Currency
Example: "IDR"		 String(3) ✅
additionalInfo channel: payment channel String ✅
DANA

DANA spesific parameters

Parameter Description Data Type Required
additionalInfo orderTitle: Order title from merchant String ❌
supportDeepLinkCheckoutUrl : Value 'true' for Jumpapp behaviour, 'false' for webview, false by default String ❌

For Shopeepay and Dana you can use the doPaymentJumpApp function for for Jumpapp behaviour

3. Other Operation

A. Check Transaction Status

B. Refund

C. Balance Inquiry

4. Error Handling and Troubleshooting

The SDK throws exceptions for various error conditions. Always wrap your API calls in try-catch blocks:

This section provides common errors and solutions:

Error Code Description Solution
4010000 Unauthorized Check if Client ID and Secret Key are valid.
4012400 Virtual Account Not Found Verify the virtual account number provided.
2002400 Successful Transaction completed successfully.

All versions of doku-php-library with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
firebase/php-jwt Version ^6.10
paragonie/sodium_compat Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package doku/doku-php-library contains the following files

Loading the files please wait ....