Allobank

Integration Steps

Here is the overview of how to integrate with Allobank :

1. Account Binding

2. Check Balance Inquiry

3. Payment

4. Acknowledge Payment Notification

---

Account Binding

Merchant can binding Allobank account to customer id, each Allobank account can only binding to one customer on one merchant. Customer need to verify OTP and input PIN on Allobank page.

Here is the flow for Account Binding :

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	/direct-debit/merchant/allo/v1.0/registration-account-binding

Here is the sample request header, request body and response body for Account Binding - AlloBank

Register a merchant account for direct debit

POSThttps://api/doku.com/direct-debit/merchant/allo/v1.0/registration-account-binding

Authorization

bearerAuth

Header parameters

Body

application/json

phoneNo*integer

Customer phone number | min length: 9 | max length: 16 format: 62xxxxx

additionalInfoobject

Response

200400401

Successful registration

Body

application/json

responseCode*string

Example: "2000700"

responseMessage*string

Example: "Successful"

referenceNostring

Example: "129260743966"

redirectUrl*string (uri)

Example: "https://sandbox.doku.com/direct-debit/ui/binding/2238230713001534401107183161486001168389"

additionalInfo*object

Request

JavaScriptCurlPython

const response = await fetch('https://api/doku.com/direct-debit/merchant/allo/v1.0/registration-account-binding', {
    method: 'POST',
    headers: {
      "Authorization": "95221",
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "phoneNo": 0
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2000700",
  "responseMessage": "Successful",
  "referenceNo": "129260743966",
  "redirectUrl": "https://sandbox.doku.com/direct-debit/ui/binding/2238230713001534401107183161486001168389",
  "additionalInfo": {
    "custIdMerchant": "CUSTOMER_OVOxDOKU",
    "accountStatus": "PENDING",
    "authCode": "1234123412341234"
  }
}

Check Balance Inquiry

Once a customer has linked their account through the Allobank platform, merchants can initiate a Balance Inquiry via the this API to obtain accurate and up-to-date account balance information.

Here is the flow for Check Balance Inquiry :

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	...../direct-debit/merchant/allo/v1.0/balance-inquiry

Here is the sample request header, request body and response body for Check Balance Inquiry Allobank :

Check Balance API

POSThttps://api/doku.com/direct-debit/merchant/allo/v1.0/balance-inquiry

Authorization

bearerAuth

Header parameters

Body

application/json

any

Response

200400401

Successful Balance Inquiry

Body

application/json

responseCode*string

Example: "2001100"

responseMessage*string

Example: "Successful"

accountInfosarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api/doku.com/direct-debit/merchant/allo/v1.0/balance-inquiry', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Authorization-customer": "Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2001100",
  "responseMessage": "Successful",
  "accountInfos": [
    {
      "balanceType": "balance",
      "amount": {
        "value": "1916427.00",
        "currency": "IDR"
      }
    }
  ]
}

Payment

After merchant check the balance, merchant can hit this API to do payment. DOKU will deduct customer's balance.

Here is the flow for Payment Allobank :

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	...../direct-debit/merchant/allo/v1.0/payment/host-to-host

Payment API

POSThttps://api/doku.com/direct-debit/merchant/allo/v1.0/payment-host-to-host

Authorization

bearerAuth

Header parameters

Body

application/json

partnerReferenceNo*string

Partner Reference Number | min length: 1 | max length: 64

Example: "INV_20221221_0002"

amount*object

payOptionDetails*array of object

additionalInfoobject

Response

200400401

Successful Payment

Body

application/json

responseCode*string

responseMessage*string

webRedirectUrl*string (uri)

referenceNostring

Request

JavaScriptCurlPython

const response = await fetch('https://api/doku.com/direct-debit/merchant/allo/v1.0/payment-host-to-host', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Authorization-customer": "Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "payOptionDetails": [
        {
          "payMethod": "BALANCE",
          "transAmount": {}
        }
      ],
      "amount": {
        "value": "12345678.00",
        "currency": "IDR"
      },
      "partnerReferenceNo": "INV_20221221_0002"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "text",
  "responseMessage": "text",
  "webRedirectUrl": "https://example.com",
  "referenceNo": "text"
}

Acknowledge Payment Notification

After the payment is being made by your customer, DOKU will send HTTP Notification to your defined Notification URL. Learn how to handle the notification from DOKU .

Additional Feature

Online Refund

Merchant can refund the transaction to DOKU. Hit this API to refund the transaction. Currently DOKU Support Full Refund.

Here is the Refund Flow :

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	...../direct-debit/merchant/allo/v1.0/debit/refund

Refund API

POSThttps://api/doku.com/direct-debit/merchant/allo/v1.0/debit/refund

Header parameters

Body

application/json

originalPartnerReferenceNo*string

Original Partner Reference Number | min length: 1 | max length: 64

Example: "INV-592566712725"

originalExternalId*string

Original External Id - External ID from payment process| min length: 1 | max length: 36

Example: "10052019"

partnerRefundNo*string

Partner Refund Number| min length: 32 | max length: 64

Example: "239850918204981205970"

refundAmount*object

reasonstring

Reason of Refund | max length: 255

Example: "Customer complain"

Response

200400401

Successful Refund

Body

application/json

responseCode*string

responseMessage*string

originalPartnerReferenceNostring

originalReferenceNostring

refundNostring

partnerRefundNo*string

refundAmountobject

refundTime*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api/doku.com/direct-debit/merchant/allo/v1.0/debit/refund', {
    method: 'POST',
    headers: {
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Authorization-customer": "Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a",
      "Authorization": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "originalPartnerReferenceNo": "INV-592566712725",
      "originalExternalId": "10052019",
      "partnerRefundNo": "239850918204981205970",
      "refundAmount": {
        "value": "10000.00",
        "currency": "IDR"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "text",
  "responseMessage": "text",
  "originalPartnerReferenceNo": "text",
  "originalReferenceNo": "text",
  "refundNo": "text",
  "partnerRefundNo": "text",
  "refundAmount": {
    "value": "text",
    "currency": "text"
  },
  "refundTime": "2024-12-21T12:22:10.596Z"
}

Account Unbinding

In case you need to remove the customer data on DOKU, hit this API to unbinding the customer data.

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	...../direct-debit/allo/v1.0/registration-account-unbinding

Unbinding process

POSThttps://api/doku.com/direct-debit/allo/v1.0/registration-account-unbinding

Authorization

bearerAuth

Header parameters

Body

application/json

tokenId*string

DOKU Gateway token | Format : AN

Example: "hdiwh3h832d832h382h3duh2"

Response

200400401

Successful Unbinding

Body

application/json

responseCode*string

responseMessage*string

referenceNostring

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://api/doku.com/direct-debit/allo/v1.0/registration-account-unbinding', {
    method: 'POST',
    headers: {
      "Authorization": "95221",
      "X-TIMESTAMP": "2020-12-21T07:56:11.000Z",
      "X-SIGNATURE": "85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5",
      "X-PARTNER-ID": "821508239190",
      "X-EXTERNAL-ID": "418075533589",
      "X-DEVICE-ID": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tokenId": "hdiwh3h832d832h382h3duh2"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "text",
  "responseMessage": "text",
  "referenceNo": "text",
  "additionalInfo": {
    "redirectUrl": "https://example.com"
  }
}