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

post

/direct-debit/merchant/allo/v1.0/registration-account-binding

Authorizations

Header parameters

X-TIMESTAMPstring · utc timestamprequired

Client's current local time in yyyy-MM- ddTHH:mm:ssTZD format

Example: 2020-12-21T07:56:11.000Z

X-SIGNATUREstringrequired

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-IDstringrequired

Unique ID for a partner (DOKU'S Client ID)

Example: 821508239190

X-EXTERNAL-IDstringrequired

Numeric String. Reference number that should be unique in the same day (request-id)

Example: 418075533589

X-DEVICE-IDstringrequired

Device identification on which the API services are currently being accessed by the end user (customer). Can’t contain symbols

Example: 95221

X-IP-ADDRESSstring

conditional. IP address of the end user (customer) using IPv4 format

Example: 95221

Authorizationstringrequired

Access Token obtained from Get B2B Token API

Example: 95221

Body

phoneNointegerrequired

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

additionalInfoobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api/doku.com/direct-debit/merchant/allo/v1.0/registration-account-binding' \
  --header 'Authorization: 95221' \
  --header 'X-TIMESTAMP: 2020-12-21T07:56:11.000Z' \
  --header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
  --header 'X-PARTNER-ID: 821508239190' \
  --header 'X-EXTERNAL-ID: 418075533589' \
  --header 'X-DEVICE-ID: 95221' \
  --header 'Content-Type: application/json' \
  --data '{"phoneNo":1,"additionalInfo":{"custIdMerchant":"text","successRegistrationUrl":"https://example.com","failedRegistrationUrl":"https://example.com","deviceModel":"text","osType":"text","channel":"text"}}'

200

400

401

200

success

already-registered-before

success

{
  "responseCode": "2000700",
  "responseMessage": "Successful",
  "referenceNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "redirectUrl": "https://uatipg.allobank.com/#/pages/bind/bind?language=id&journeyId=11682983915316909426889519104&nonceCode=4de47057a30540f1a4399d3a73100ae1",
  "additionalInfo": {
    "custIdMerchant": "CUSTOMER_OVOxDOKU",
    "accountStatus": "PENDING",
    "authCode": "1234123412341234"
  }
}

Successful registration

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

post

/direct-debit/merchant/allo/v1.0/balance-inquiry

Authorizations

Header parameters

X-TIMESTAMPstring · utc timestamprequired

Client's current local time in yyyy-MM- ddTHH:mm:ssTZD format

Example: 2020-12-21T07:56:11.000Z

X-SIGNATUREstringrequired

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-IDstringrequired

Unique ID for a partner (DOKU'S Client ID)

Example: 821508239190

X-EXTERNAL-IDstringrequired

Numeric String. Reference number that should be unique in the same day (request-id)

Example: 418075533589

X-DEVICE-IDstringrequired

Device identification on which the API services are currently being accessed by the end user (customer). Can’t contain symbols

Example: 95221

X-IP-ADDRESSstring

conditional. IP address of the end user (customer) using IPv4 format

Example: 95221

Authorization-customerstringrequired

Access token obtained from B2B2C API

Example: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a

Authorizationstringrequired

Access Token obtained from Get B2B Token API

Example: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ

Body

any

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api/doku.com/direct-debit/merchant/allo/v1.0/balance-inquiry' \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ' \
  --header 'X-TIMESTAMP: 2020-12-21T07:56:11.000Z' \
  --header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
  --header 'X-PARTNER-ID: 821508239190' \
  --header 'X-EXTERNAL-ID: 418075533589' \
  --header 'X-DEVICE-ID: 95221' \
  --header 'Authorization-customer: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a' \
  --header 'Content-Type: application/json'

200

400

401

200

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

Successful Balance Inquiry

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

post

/direct-debit/merchant/allo/v1.0/payment-host-to-host

Authorizations

Header parameters

X-TIMESTAMPstring · utc timestamprequired

Client's current local time in yyyy-MM- ddTHH:mm:ssTZD format

Example: 2020-12-21T07:56:11.000Z

X-SIGNATUREstringrequired

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-IDstringrequired

Unique ID for a partner (DOKU'S Client ID)

Example: 821508239190

X-EXTERNAL-IDstringrequired

Numeric String. Reference number that should be unique in the same day (request-id)

Example: 418075533589

X-DEVICE-IDstringrequired

Device identification on which the API services are currently being accessed by the end user (customer). Can’t contain symbols

Example: 95221

X-IP-ADDRESSstring

conditional. IP address of the end user (customer) using IPv4 format

Example: 95221

Authorization-customerstringrequired

Access token obtained from B2B2C API

Example: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a

Authorizationstringrequired

Access Token obtained from Get B2B Token API

Example: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ

Body

partnerReferenceNostringrequired

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

Example: INV_20221221_0002

amountobjectrequired

payOptionDetailsobject[]required

additionalInfoobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api/doku.com/direct-debit/merchant/allo/v1.0/payment-host-to-host' \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ' \
  --header 'X-TIMESTAMP: 2020-12-21T07:56:11.000Z' \
  --header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
  --header 'X-PARTNER-ID: 821508239190' \
  --header 'X-EXTERNAL-ID: 418075533589' \
  --header 'X-DEVICE-ID: 95221' \
  --header 'Authorization-customer: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a' \
  --header 'Content-Type: application/json' \
  --data '{"partnerReferenceNo":"INV_20221221_0002","amount":{"value":"12345678.00","currency":"IDR"},"payOptionDetails":[{"payMethod":"BALANCE","transAmount":{"value":"12345678.00","currency":"IDR"}}],"additionalInfo":{"successPaymentUrl":"https://dribbble.com/shots/14575431-Payment-method-success/attachments/6265573?mode=media","failedPaymentUrl":"https://dribbble.com/shots/4756331-Failed-Transaction","lineItems":[{"name":"masker","price":50000,"quantity":1}]}}'

200

400

401

200

{
  "responseCode": "20054000",
  "responseMessage": "Successful",
  "referenceNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "webRedirectUrl": "https://uatipg.allobank.com/#/pages/bind/bind?language=id&journeyId=11682983915316909426889519104&nonceCode=4de47057a30540f1a4399d3a73100ae1"
}

Successful Payment

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

post

/direct-debit/merchant/allo/v1.0/debit/refund

Header parameters

X-TIMESTAMPstring · utc timestamprequired

Client's current local time in yyyy-MM- ddTHH:mm:ssTZD format

Example: 2020-12-21T07:56:11.000Z

X-SIGNATUREstringrequired

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-IDstringrequired

Unique ID for a partner (DOKU'S Client ID)

Example: 821508239190

X-EXTERNAL-IDstringrequired

Numeric String. Reference number that should be unique in the same day (request-id)

Example: 418075533589

X-DEVICE-IDstringrequired

Device identification on which the API services are currently being accessed by the end user (customer). Can’t contain symbols

Example: 95221

X-IP-ADDRESSstring

conditional. IP address of the end user (customer) using IPv4 format

Example: 95221

Authorization-customerstringrequired

Access token obtained from B2B2C API

Example: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a

Authorizationstringrequired

Access Token obtained from Get B2B Token API

Example: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ

Body

originalPartnerReferenceNostringrequired

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

Example: INV-592566712725

originalExternalIdstringrequired

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

Example: 10052019

partnerRefundNostringrequired

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

Example: 239850918204981205970

reasonstring

Reason of Refund | max length: 255

Example: Customer complain

refundAmountobjectrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api/doku.com/direct-debit/merchant/allo/v1.0/debit/refund' \
  --header 'X-TIMESTAMP: 2020-12-21T07:56:11.000Z' \
  --header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
  --header 'X-PARTNER-ID: 821508239190' \
  --header 'X-EXTERNAL-ID: 418075533589' \
  --header 'X-DEVICE-ID: 95221' \
  --header 'Authorization-customer: Bearer fa8sjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a' \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ' \
  --header 'Content-Type: application/json' \
  --data '{"originalPartnerReferenceNo":"INV-592566712725","originalExternalId":"10052019","partnerRefundNo":"239850918204981205970","reason":"Customer complain","refundAmount":{"value":"10000.00","currency":"IDR"}}'

200

400

401

200

{
  "responseCode": "20058000",
  "responseMessage": "Successful",
  "originalPartnerReferenceNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "originalReferenceNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "refundNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "partnerRefundNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "refundTime": "2020-12-21T10:21:41.000Z",
  "refundAmount": {
    "value": 10000,
    "currency": "IDR"
  }
}

Successful Refund

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

post

/direct-debit/allo/v1.0/registration-account-unbinding

Authorizations

Header parameters

X-TIMESTAMPstring · utc timestamprequired

Client's current local time in yyyy-MM- ddTHH:mm:ssTZD format

Example: 2020-12-21T07:56:11.000Z

X-SIGNATUREstringrequired

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-IDstringrequired

Unique ID for a partner (DOKU'S Client ID)

Example: 821508239190

X-EXTERNAL-IDstringrequired

Numeric String. Reference number that should be unique in the same day (request-id)

Example: 418075533589

X-DEVICE-IDstringrequired

Device identification on which the API services are currently being accessed by the end user (customer). Can’t contain symbols

Example: 95221

X-IP-ADDRESSstring

conditional. IP address of the end user (customer) using IPv4 format

Example: 95221

Authorizationstringrequired

Access Token obtained from Get B2B Token API

Example: 95221

Body

tokenIdstringrequired

DOKU Gateway token | Format : AN

Example: hdiwh3h832d832h382h3duh2

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api/doku.com/direct-debit/allo/v1.0/registration-account-unbinding' \
  --header 'Authorization: 95221' \
  --header 'X-TIMESTAMP: 2020-12-21T07:56:11.000Z' \
  --header 'X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5' \
  --header 'X-PARTNER-ID: 821508239190' \
  --header 'X-EXTERNAL-ID: 418075533589' \
  --header 'X-DEVICE-ID: 95221' \
  --header 'Content-Type: application/json' \
  --data '{"tokenId":"hdiwh3h832d832h382h3duh2"}'

200

400

401

200

{
  "responseCode": "2000900",
  "responseMessage": "Successful",
  "referenceNo": "40cd084bdb184ea6ace7bab46ac19d14",
  "additionalInfo": {
    "redirectUrl": "https://uatipg.allobank.com/#/pages/bind/bind?language=id&journeyId=11682983915316909426889519104&nonceCode=4de47057a30540f1a4399d3a73100ae1"
  }
}

Successful Unbinding