Backend Integration

Integration Steps

Overview of integration process with KKI Integration

1. Payment

Merchant can request for payment by requesting this API

Payment Flow

API Endpoint

Environment Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox
API Production
Path	`.../direct-debit/core/v1/debit/payment-host-to-host`

HTTP Method

POST

API Sandbox

API Production

Path

.../direct-debit/core/v1/debit/payment-host-to-host

Sample of Request Header, Request Body and Response Body

Notes:

Parameter with (*) is mandatory

Paramater without (*) is optional/conditional

Request Payment From Merchant for KKI

POSThttps://{api-domain}/direct-debit/core/v1/debit/payment-host-to-host

Header parameters

Body

partnerReferenceNo*string

Reference No From Partner | max: 32 | Optional

Example: "INV-0001"

bankCardTokenstring

Token From DOKU | max: 64 | Conditional if merchant customer already has token from DOKU

Example: "de52e5820f4c381db88a1cf91d57b73e"

chargeTokenstring

Customer CPAN | max: 20 | Optional

Example: 9360001609987000000

otpstring

Customer OTP | min: 8 max: 8 | Optional

Example: 12345678

amount*AmountObject (object)

additionalInfo*object

Response

Successful

Body

responseCode*string

Response Code with format HTTP status code + service code + case code. service code and status code refer to: https://developers.doku.com/getting-started-with-doku-api/response-code/http-status-and-case-code#id-4.-direct-debit | Mandatory | min length: 1 | max length: 7.

Example: "2005400"

responseMessage*string

Response Description. | min length: 1 | max length: 150

Example: "Successful"

referenceNostring

DOKU Reference No

Example: "REF-DOKU-0001"

Request

const response = await fetch('https://{api-domain}/direct-debit/core/v1/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",
      "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({
      "partnerReferenceNo": "INV-0001",
      "amount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      "additionalInfo": {
        "channel": "KARTU_KREDIT_INDONESIA",
        "isBindAndPay": "N"
      }
    }),
});
const data = await response.json();

Response

{
  "responseCode": "2005400",
  "responseMessage": "Successful",
  "referenceNo": "REF-DOKU-0001"
}

2. Refund

Online Refund

This endpoint is used to create refund request for previous successful payment. Merchant can request a transaction refund to DOKU. Full refund and partial refund are available to be requested

Online Refund Flow

API Endpoint

Environment Endpoint

Environment	Endpoint
HTTP Method	POST
API Sandbox
API Production
Path	`.../direct-debit/core/v1/debit/refund`

HTTP Method

POST

API Sandbox

API Production

Path

.../direct-debit/core/v1/debit/refund

Sample of Request Header, Request Body and Response Body

Notes:

Parameter with (*) is mandatory

Paramater without (*) is optional/conditional

Request Refund From Merchant for Direct Debit Transaction

POSThttps://{api-domain}/direct-debit/core/v1/debit/refund

Header parameters

Body

additionalInfoobject

originalPartnerReferenceNo*string

Reference No From Partner | AlphaNumeric | min: 32 max: 64 | Mandatory

Example: "INV0001"

originalExternalIdstring

External ID Purchase Transaction | max: 36 |

Example: "REQ-0001"

refundAmount*AmountObject (object)

reasonstring

Reason from customer | max: 255

Example: "Request by Customer"

partnerRefundNo*string

Partner Refund No| max: 12 | Mandatory

Example: "INV-REF-0001"

Response

Successful

Body

responseCode*string

Example: "2000700"

responseMessage*string

Response Description. | min length: 1 | max length: 150

Example: "Successful"

refundAmount*AmountObject (object)

originalPartnerReferenceNostring

Partner Reference No Purchase Transaction

Example: "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"

originalReferenceNostring

Reference No Purchase Transaction From DOKU To Allo

Example: "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"

refundNostring

Refund No from DOKU To Allo

Example: "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"

partnerRefundNostring

Partner Refund No

Example: "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7"

refundTimestring

format: yyyy-MM-dd'T'HH:mm:ssXXX

Example: "2024-01-01T09:09:00.123"

Request

const response = await fetch('https://{api-domain}/direct-debit/core/v1/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-IP-ADDRESS": "192.168.1.1",
      "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": "INV0001",
      "refundAmount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      "partnerRefundNo": "INV-REF-0001"
    }),
});
const data = await response.json();

Response

{
  "responseCode": "2000700",
  "responseMessage": "Successful",
  "refundAmount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "originalPartnerReferenceNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7",
  "originalReferenceNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7",
  "refundNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7",
  "partnerRefundNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7",
  "refundTime": "2024-01-01T09:09:00.123"
}

PreviousKartu Kredit Indonesia Cepat Secure(KKI CPTS)NextFinance and Settlement

Last updated 12 days ago

const response = await fetch('https://{api-domain}/direct-debit/core/v1/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", "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({ "partnerReferenceNo": "INV-0001", "amount": { "value": "10000.00", "currency": "IDR" }, "additionalInfo": { "channel": "KARTU_KREDIT_INDONESIA", "isBindAndPay": "N" } }), }); const data = await response.json();

const response = await fetch('https://{api-domain}/direct-debit/core/v1/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-IP-ADDRESS": "192.168.1.1", "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": "INV0001", "refundAmount": { "value": "10000.00", "currency": "IDR" }, "partnerRefundNo": "INV-REF-0001" }), }); const data = await response.json();

{ "responseCode": "2000700", "responseMessage": "Successful", "refundAmount": { "value": "10000.00", "currency": "IDR" }, "originalPartnerReferenceNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7", "originalReferenceNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7", "refundNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7", "partnerRefundNo": "Ra7o1bLJAh2oV9eb33129stQc5xFm5s7", "refundTime": "2024-01-01T09:09:00.123" }