BRI Direct Debit

BRI Direct Debit

One of DOKU's direct debit partner is BRI. Learn more about integration to BRI Direct Debit here.

Integration Steps

The overview of integration process with BRI Direct Debit

1. Card Registration

2. OTP Verification

3. Direct Debit Payment

4. Direct Debit Payment Notification

Card Registration

Merchant can register BRI card/account to customer ID. Each card/account can only registered/bind to one customer on one merchant. Customer need to verify OTP and input PIN on BRI page.

The flow of Card Registration:

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-bind

The sample of Request Header, Request Body and Response Body for BRI Direct Debit Card Registration:

Register a merchant account for direct debit

POSThttps://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-bind

Header parameters

Body

application/json

bankCardNostring (number)

Last four digit of BRI card number | length: 4

Example: "0747"

bankCardTypestring

Type of Bank Card Number | value: C (Credit) / D (Debit) / UE

Example: "D"

identificationNostring (number)

ID Number | max length: 20

Example: "6013010111348227"

identificationTypestring

Type of ID used for identificationNo | value: 01/02/03/04

Example: "02"

emailstring (email)

Account email| max length: 255

Example: "[e-mail]"

expiryDatestring

Card expiry date | length: 4 | format: MMYY

Example: "0525"

custIdMerchantstring

Customer id from merchant | min length: 1 | max length: 18

Example: "01010136136144"

phoneNostring (number)

Customer Phone number | min length: 5 | max length: 16

Example: "6289509325902"

accountNamestring

Account name from card number | max length: 70

Example: "TESTING-WTD"

dateOfBirthstring

Customer date of birth | format: YYYYMMDD

Example: "19960101"

additionalInfoobject

Response

200400401

Successful registration

Body

application/json

responseCodestring

Example: "2000100"

responseMessagestring

Example: "Successful"

referenceNostring

Example: "345968587571"

bankCardTokenstring

Example: "aa26bcba00d14a4a6a42e1041498d1e6"

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-bind', {
    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": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "bankCardNo": "0747",
      "bankCardType": "D",
      "identificationNo": "6013010111348227",
      "identificationType": "02",
      "email": "[e-mail]",
      "expiryDate": "0525",
      "custIdMerchant": "01010136136144",
      "phoneNo": "6289509325902",
      "accountName": "TESTING-WTD",
      "dateOfBirth": "19960101",
      "additionalInfo": {
        "customerEmail": "[e-mail]",
        "customerPhoneNo": "6289509325902",
        "customerCountry": "Indonesia",
        "customerAddress": "Jl. Menara Mulia Sekali"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2000100",
  "responseMessage": "Successful",
  "referenceNo": "345968587571",
  "bankCardToken": "aa26bcba00d14a4a6a42e1041498d1e6",
  "additionalInfo": {
    "tokenStatus": "PENDING",
    "tokenStatusMessage": "Waiting for validate OTP"
  }
}

OTP Verification

Once the customer has registered their card through the platform, merchant needs to verify the card. Merchant can hit this API to verify the OTP.

The flow of OTP Verification:

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	/wtd-direct-debit-snap-bri/snap/v1.0/otp-verification

The sample of Request Header, Request Body and Response Body for BRI Direct Debit OTP Verification:

OTP Verification API

POSThttps://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/otp-verification

Header parameters

Body

application/json

originalReferenceNo*string

Original Reference No get from prcess binding or payment | min length: 1 | max length: 64

Example: "108772587457"

otp*string

OTP | min length: 1 | max length: 18

Example: "999999"

chargeTokenstring (number)

DOKU Gateway token get from binding process| length: 6

Example: "89e1174c796b9628dcfd3ebec996e6c0"

type*string

Type of OTP Verification process | value: card/payment

Example: "card"

Response

200400401404

Successful OTP Verification

Body

application/json

one of

OTPBindingSuccessResponse (object)OTPPaymentSuccessResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/otp-verification', {
    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": "Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE2OTgwNTA3NDMsImlzcyI6IkRPS1UiLCJjbGllbnRJZCI6IkJSTi0wMjExLTE2OTY5MTk2NTE5MTgifQ.x-D5VlK6TlVZbLPUSCr-Gbfgh4tnp0QDJmedYFHJGHFjg1c4x39pszU4sLvRhr0Jk0vKdMIzxUZeNhKoesWqDJitnG3kfrNZNsMb_WYUC0tJW91onXzYOKXiTgsHwRNFoWPQHlXIEtT3RQm-SRlCpk_E0gsavgkQn2-kbJEBnPhIs4eKg5IUY9GYi4hRr-_GHsudDl8sd2B5UBB_rHYq36BRmLXH7i7MQADHPsB1ktPVgk3ZWF0jebEjI-lJ88p-omL1vQNvRseXej2HKBa9chGLmPDvXYBQaRmmstHz-tv1boFrHfwsHJebcUec-i3WE1vMvP_3EPXdbqb45N4ciQ",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "originalReferenceNo": "108772587457",
      "otp": "999999",
      "chargeToken": "89e1174c796b9628dcfd3ebec996e6c0",
      "type": "card"
    }),
});
const data = await response.json();

Response

200400401404

{
  "responseCode": "2000400",
  "responseMessage": "Successful",
  "originalReferenceNo": "108772587457",
  "additionalInfo": {
    "tokenStatus": "SUCCESS",
    "tokenStatusMessage": "Success Register Card"
  }
}

Direct Debit Payment

This API is used for payment of transaction based on the card number in the card token obtained from the Card Registration/Binding process. After merchant hit this Payment API, DOKU will deduct the customer's balance.

The flow of Direct Debit Payment:

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

The sample of Request Header, Request Body and Response Body for BRI Direct Debit Payment:

Payment API

POSThttps://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/debit/payment-host-to-host

Header parameters

Body

application/json

bankCardToken*string

DOKU Gateway token get from binding process | min length: 1 | max length: 128

Example: "198ad24d9562f1179a25cd65fe1dddec"

transAmount*object

additionalInfo*object

Response

200400401

Successful Payment

Body

application/json

responseCodestring

Example: "2005400"

responseMessagestring

Example: "Successful"

referenceNostring

Example: "738663838768"

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/debit/payment-host-to-host', {
    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({
      "bankCardToken": "198ad24d9562f1179a25cd65fe1dddec",
      "merchantId": "MCH-0001-2768422848550",
      "transAmount": {
        "value": "90000.00",
        "currency": "IDR"
      },
      "additionalInfo": {
        "lineItems": [
          {
            "name": "Vitamin C",
            "price": "40000.00",
            "quantity": "1"
          },
          {
            "name": "Pensil Warna",
            "price": "50000.00",
            "quantity": "1"
          }
        ],
        "merchantTrxId": "66778181123",
        "otpStatus": "YES"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2005400",
  "responseMessage": "Successful",
  "referenceNo": "738663838768",
  "additionalInfo": {
    "merchantTrxId": "66778181123",
    "transactionStatus": "PENDING",
    "transactionStatusMessage": "Waiting for validate OTP"
  }
}

Direct Debit Payment Notification

After the payment is done by the customer, DOKU will send HTTP Notification to merchant's defined Notification URL. Learn how to handle the notification from DOKU.

Additional Feature

Online Direct Debit Refund

This endpoint is used to create refund requests for previously successful payments. Refunds can be made in full or partial amounts. Merchant can refund the transaction to DOKU. Hit this API to refund the transaction. Currently DOKU Support Full Refund.

The flow of Direct Debit Refund:

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

The sample of Request Header, Request Body and Response Body for BRI Direct Debit Refund:

Refund API

POSThttps://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/debit/refund

Header parameters

Body

application/json

originalReferenceNo*string

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

Example: "884791706226"

partnerRefundNo*string

Partner refund number | min length: 1 | max length: 64

Example: "123491931459"

originalExternalId*string

External id used on payment | min length: 1 | max length: 64

Example: "85116108"

reasonstring

Reason of refund | max length: 255

Example: "kesalahan data"

refundAmountobject

additionalInfo*object

Response

200400401

Successful Refund

Body

application/json

responseCodestring

Example: "2005800"

responseMessagestring

Example: "Successful"

originalPartnerReferenceNostring

Example: "2238220704144005697107174446374000107558"

originalReferenceNostring

Example: "884791706226"

refundNostring

Example: "132979271182"

partnerRefundNostring

Example: "123491931459"

refundAmountobject

refundTimestring (date-time)

Example: "2022-07-04T16:09:35+07:00"

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/wtd-direct-debit-snap-bri/snap/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({
      "originalReferenceNo": "884791706226",
      "partnerRefundNo": "123491931459",
      "originalExternalId": "85116108",
      "reason": "kesalahan data",
      "refundAmount": {
        "value": "45000.00",
        "currency": "IDR"
      },
      "additionalInfo": {
        "merchantTrxId": "667781811252"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2005800",
  "responseMessage": "Successful",
  "originalPartnerReferenceNo": "2238220704144005697107174446374000107558",
  "originalReferenceNo": "884791706226",
  "refundNo": "132979271182",
  "partnerRefundNo": "123491931459",
  "refundAmount": {
    "value": "45000.00",
    "currency": "IDR"
  },
  "refundTime": "2022-07-04T16:09:35+07:00"
}

Card Registration Unbinding

This API is used to delete customer's card data in DOKU.

API Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox	https://api-sandbox.doku.com
API Production	https://api.doku.com
Path	/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-unbind

The sample of Request Header, Request Body and Response Body for BRI Direct Debit Card Registration Unbinding:

Unbinding process

POSThttps://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-unbind

Header parameters

Body

application/json

token*string

DOKU Gateway token | Format : AN

Example: "hdiwh3h832d832h382h3duh2"

Response

200400401

Successful Unbinding

Body

application/json

responseCode*string

Example: "2000500"

responseMessage*string

Example: "OTP Sent To Cardholder"

bankCardTokenstring

Example: "89e1174c796b9628dcfd3ebec996e6c0"

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/wtd-direct-debit-snap-bri/snap/v1.0/registration-card-unbind', {
    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": "95221",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "hdiwh3h832d832h382h3duh2"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2000500",
  "responseMessage": "OTP Sent To Cardholder",
  "bankCardToken": "89e1174c796b9628dcfd3ebec996e6c0",
  "additionalInfo": {
    "tokenStatus": "SUCCESS",
    "tokenStatusMessage": "Success Unbinding Card"
  }
}