Inquiry Payment - API Reference (NEW)

Direct Inquiry

Request

Header Params

X-TIMESTAMP

string

required

Client's current local time in yyyy-MM-dd'T'HH:mm:ssXXX format. Sample: 2024-03-19T14:39:01+07:00

Example:

2024-03-19T14:39:01+07:00

X-SIGNATURE

string

required

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Example:

85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5

X-PARTNER-ID

string

required

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

Example:

BRN-0259-1678068334526

X-EXTERNAL-ID

string

required

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

Example:

418075533589

CHANNEL-ID

string

required

Channel Id for VA. Please fill with H2H (Host-To-Host)

Example:

H2H

Authorization

string

required

Access Token obtained from Get B2B Token API | Go to here for detailed documentation

Example:

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

Body Params application/json

partnerServiceId

string

required

similar to company code/BIN,8 digit left padding space. | Mandatory | min length: 1 | max length: 8

Example:

19008

customerNo

string

required

Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | Mandatory | min length: 1 | max length: 20

Example:

00000000000000000001

virtualAccountNo

string

required

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | Mandatory | min length: 1 | max length: 28

Example:

19008000000000000000000001

channelCode

string

optional

Channel code from bank | min length: 1 | max length: 10

Example:

trxDateInit

string

required

Transaction date. | Mandatory

Example:

2023-01-01T10:55:00+07:00

language

string

optional

Language | min length: 1 | max length: 2

Example:

inquiryRequestId

string

required

Unique Inquiry request id. | Mandatory | min length: 1 | max length: 30

Example:

12839218738127830

additionalInfo

object (AdditionalInfoDirectInquiyVARequestRef)

required

channel

enum<string>

required

Channel that will be apply for this VA | Mandatory | min length: 1 | max length: 30

Allowed value:

VIRTUAL_ACCOUNT_BCA

Example

{
    "partnerServiceId": "   19008",
    "customerNo": "00000000000000000001",
    "virtualAccountNo": "  19008000000000000000000001",
    "channelCode": "1",
    "trxDateInit": "2023-01-01T10:55:00+07:00",
    "language": "ID",
    "inquiryRequestId": "12839218738127830",
    "additionalInfo": {
        "channel": "VIRTUAL_ACCOUNT_BCA"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

item created

Body

responseCode

string

required

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/error-handling/http-status-and-case-code#id-1.-virtual-account . | Mandatory | min length: 1 | max length: 7.

Example:

2002400

responseMessage

string

required

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

Example:

Successful

virtualAccountData

object

required

partnerServiceId

string

required

similar to company code/BIN,8 digit left padding space. | Mandatory | min length: 1 | max length: 8

Example:

19008

customerNo

string

required

Unique number (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | Mandatory | min length: 1 | max length: 20

Example:

00000000000000000001

virtualAccountNo

string

required

partnerServiceId (8 digit left padding 0) + customerNo (up to 20 digits). partnerServiceId + customerNo or virtualAccountNo. | Mandatory | min length: 1 | max length: 28

Example:

19008000000000000000000001

virtualAccountName

string

required

Customer Name | min length: 1 | max length: 255

Example:

Customer Name

virtualAccountEmail

string

optional

Customer Email | min length: 1 | max length: 255

Example:

customer.email@mail.com

virtualAccountPhone

string

optional

Customer Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 30

Example:

081293912081

totalAmount

object (TotalAmountRef)

required

virtualAccountTrxType

string

required

Transaction type for this transaction. C (Closed Amount), O (Open Amount), V (Bill Variable Amount) | Mandatory | min length: 1 | max length: 1

Example:

expiredDate

string

optional

Example:

2023-01-01T10:55:00+07:00

inquiryStatus

string

optional

Status for this inquiry. Refer to case_code | min length: 1 | max length: 2

Example:

inquiryReason

object (InquiryReasonRef)

optional

inquiryRequestId

string

required

Unique Inquiry request id | min length: 1 | max length: 30

Example:

12839218738127830

freeText

array [object {2}]

optional

Free text for additional description. | Optional | min length: 1 | max length: 64

additionalInfo

object (AdditionalInfoDirectInquiyVAResponseRef)

optional

channel

enum<string>

required

Channel that will be apply for this VA | Mandatory | min length: 1 | max length: 30

Allowed value:

VIRTUAL_ACCOUNT_BCA

trxId

string

required

Invoice Number | Optional | min length: 1 | max length: 32

Example:

INV-001

virtualAccountConfig

object (VirtualAccountConfig)

optional

Example

{
    "responseCode": "2002400",
    "responseMessage": "Successful",
    "virtualAccountData": {
        "partnerServiceId": "   19008",
        "customerNo": "00000000000000000001",
        "virtualAccountNo": "  19008000000000000000000001",
        "virtualAccountName": "Customer Name",
        "virtualAccountEmail": "customer.email@mail.com",
        "virtualAccountPhone": "081293912081",
        "totalAmount": {
            "value": "11500.00",
            "currency": "IDR"
        },
        "virtualAccountTrxType": "C",
        "expiredDate": "2023-01-01T10:55:00+07:00",
        "inquiryStatus": "00",
        "inquiryReason": {
            "english": "Success",
            "indonesia": "Sukses"
        },
        "inquiryRequestId": "12839218738127830",
        "freeText": [
            {
                "english": "Free text",
                "indonesia": "Tulisan Bebas"
            }
        ]
    },
    "additionalInfo": {
        "channel": "VIRTUAL_ACCOUNT_BCA",
        "trxId": "INV-001",
        "virtualAccountConfig": {
            "reusableStatus": true,
            "minAmount": "10000.00",
            "maxAmount": "5000000.00"
        }
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠409409

🔴500Server Error

🔴504Gateway Timeout