OVO Open API

---

Integration Steps

Here is the overview of how to integrate with OVO Open API :

1. Account Binding

2. Check Balance Inquiry

3. Payment

4. Acknowledge Payment Notification

---

1. Account Binding

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

Here is the flow for Account Binding :

API Endpoint

Type	Value
Service Code
HTTP Method	POST
API Endpoint Sandbox	Copy https://api-sandbox.doku.com/.../
API Endpoint Production	Copy https://api.doku.com/..../
Path	Copy /direct-debit/merchant/ovo/v1.0/registration-account-binding

Here are the sample request header, request body and response body for OVO Open API

Register a merchant account for direct debit

POSThttps://{api-domain}/direct-debit/merchant/allo/v1.0/registration-account-binding

Header parameters

Body

application/json

phoneNo*string

Account phone number | min length: 9 | max length: 16

Example: "62857957868761"

additionalInfo*object

Response

200400401

Successful registration

Body

application/json

responseCodestring

Example: "2000700"

responseMessagestring

Example: "Successful"

referenceNostring

Example: "129260743966"

redirectUrlstring

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

additionalInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/direct-debit/merchant/allo/v1.0/registration-account-binding', {
    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({
      "phoneNo": "62857957868761",
      "additionalInfo": {
        "custIdMerchant": "TEST-123",
        "successRegistrationUrl": "https://sandbox.doku.com/bo/login/",
        "failedRegistrationUrl": "https://www.seleniumeasy.com/test"
      }
    }),
});
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"
  }
}

2. Check Balance Inquiry

Once a customer has linked their account through the OVO 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 :

Type	Value
Service Code
HTTP Method	POST
API Endpoint Sandbox	Copy https://api-sandbox.doku.com/.../
API Endpoint Production	Copy https://api.doku.com/..../
Path	Copy /direct-debit/merchant/ovo/v1.0/registration-account-binding

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

Check Balance API

POSThttps://{api-domain}/direct-debit/merchant/ovo/v1.0/balance-inquiry

Header parameters

Body

application/json

any

Response

200400401

Successful Balance Inquiry

Body

application/json

responseCodestring

Example: "2001100"

responseMessagestring

Example: "Successful"

accountInfosarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/direct-debit/merchant/ovo/v1.0/balance-inquiry', {
    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({}),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2001100",
  "responseMessage": "Successful",
  "accountInfos": [
    {
      "balanceType": "CASH",
      "amount": {
        "currency": "IDR",
        "value": "2000000.00"
      }
    },
    {
      "balanceType": "POINTS",
      "amount": {
        "currency": "IDR",
        "value": "2000000.00"
      }
    }
  ]
}

3. 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 OVO :

Here is the sample request header, request body and response body for Payment OVO :

Payment API

POSThttps://{api-domain}/direct-debit/merchant/ovo/v1.0/payment-host-to-host

Header parameters

Body

application/json

partnerReferenceNo*string

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

Example: "SIM_20230829_0001"

amount*object

feeTypestring

Type Of Fee | max length: 3 | value: OUR/BEN/SHA

Example: "OUR"

payOptionDetails*array of object

additionalInfo*object

Response

200400401

Successful Payment

Body

application/json

responseCodestring

Example: "20054000"

responseMessagestring

Example: "Successful"

webRedirectUrlstring

Example: "https://sandbox.doku.com/direct-debit/ui/payment/328512651824756285712516"

referenceNostring

Example: "1234"

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/direct-debit/merchant/ovo/v1.0/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({
      "partnerReferenceNo": "SIM_20230829_0001",
      "amount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      "feeType": "OUR",
      "payOptionDetails": [
        {
          "payMethod": "CASH",
          "transAmount": {
            "value": "10000.00",
            "currency": "IDR"
          },
          "feeAmount": {
            "value": "1000.00",
            "currency": "IDR"
          }
        }
      ],
      "additionalInfo": {
        "lineItems": [
          {
            "name": "masker",
            "price": "5000.00",
            "quantity": 1
          },
          {
            "name": "aqua",
            "price": "5000.00",
            "quantity": 1
          }
        ],
        "successPaymentUrl": "https://dribbble.com/shots/14575431-Payment-method-success/attachments/6265573?mode=media",
        "failedPaymentUrl": "https://dribbble.com/shots/4756331-Failed-Transaction"
      }
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "20054000",
  "responseMessage": "Successful",
  "webRedirectUrl": "https://sandbox.doku.com/direct-debit/ui/payment/328512651824756285712516",
  "referenceNo": "1234"
}

4. 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

1. Account Unbinding

Unbinding process

POSThttps://{api-domain}/direct-debit/ovo/v1.0/registration-account-unbinding

Header parameters

Body

application/json

tokenId*string

DOKU Gateway token | Format : AN

Example: "hdiwh3h832d832h382h3duh2"

Response

200400401

Successful Unbinding

Body

application/json

responseCode*string

Example: "2000900"

responseMessage*string

Example: "Successful"

referenceNostring

Example: "40cd084bdb184ea6ace7bab46ac19d14"

Request

JavaScriptCurlPython

const response = await fetch('https://{api-domain}/direct-debit/ovo/v1.0/registration-account-unbinding', {
    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({
      "tokenId": "hdiwh3h832d832h382h3duh2"
    }),
});
const data = await response.json();

Response

200400401

{
  "responseCode": "2000900",
  "responseMessage": "Successful",
  "referenceNo": "40cd084bdb184ea6ace7bab46ac19d14"
}