Additional - Refund - API Reference (NEW)

Request

Header Params

X-TIMESTAMP

string <utc timestamp>

required

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

Example:

2020-12-21T07:56:11.000Z

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:

821508239190

X-EXTERNAL-ID

string

required

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

Example:

418075533589

Authorization

string

required

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

Example:

95221

Body Params application/json

additionalInfo

object

optional

channel

string

required

Value should be always EMONEY_OVO_SNAP | Mandatory

Example:

EMONEY_OVO_SNAP

originalPartnerReferenceNo

string

required

Partner Reference No Purchase Transaction | max: 32 | Mandatory

Example:

INV-0001

originalExternalId

string

optional

External ID Purchase Transaction | max: 36 |

Example:

REQ-0001

refundAmount

object (AmountObject)

required

value

string

required

Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | Mandatory | min length: 1 | max length: 16.2

Example:

10000.00

currency

string

required

Currency. | Mandatory | min length: 1 | max length: 3

Example:

IDR

reason

string

optional

Reason from customer | max: 255

Example:

Request by Customer

partnerRefundNo

string

required

Partner Refund No| max: 64 | Mandatory

Example:

INV-REF-0001

Example

{
    "additionalInfo": {
        "channel": "EMONEY_OVO_SNAP"
    },
    "originalPartnerReferenceNo": "INV-0001",
    "originalExternalId": "REQ-0001",
    "refundAmount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "reason": "Request by Customer",
    "partnerRefundNo": "INV-REF-0001"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/direct-debit/core/v1/debit/refund' \
--header 'X-TIMESTAMP;' \
--header 'X-SIGNATURE;' \
--header 'X-PARTNER-ID;' \
--header 'X-EXTERNAL-ID;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "additionalInfo": {
        "channel": "EMONEY_OVO_SNAP"
    },
    "originalPartnerReferenceNo": "INV-0001",
    "originalExternalId": "REQ-0001",
    "refundAmount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "reason": "Request by Customer",
    "partnerRefundNo": "INV-REF-0001"
}'

Responses

🟢200OK

application/json

Successfull

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/response-code/http-status-and-case-code#id-3.-e-wallet | Mandatory | min length: 1 | max length: 7.

Example:

2000700

responseMessage

string

required

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

Example:

Successfull

refundAmount

object (AmountObject)

required

value

string

required

Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | Mandatory | min length: 1 | max length: 16.2

Example:

10000.00

currency

string

required

Currency. | Mandatory | min length: 1 | max length: 3

Example:

IDR

originalPartnerReferenceNo

string

optional

Partner Reference No Purchase Transaction

Example:

Ra7o1bLJAh2oV9eb33129stQc5xFm5s7

originalReferenceNo

string

optional

Reference No Purchase Transaction From DOKU To OVO

Example:

Ra7o1bLJAh2oV9eb33129stQc5xFm5s7

refundNo

string

optional

Refund No from DOKU To OVO

Example:

Ra7o1bLJAh2oV9eb33129stQc5xFm5s7

partnerRefundNo

string

optional

Partner Refund No

Example:

Ra7o1bLJAh2oV9eb33129stQc5xFm5s7

refundTime

string

optional

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

Example:

2024-01-01T09:09:00.123

Example

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