credit-card-online-refund-section
You can request void or refund using this API.
Requirements
- If you are using Credit Card Aggregator service, you can process Void or Refund.
- If you are using Credit Card Direct service, please consult with your acquiring bank to learn more whether your credential (MID) supports refund or not.
To request a refund, you will need to hit this API through your backend:
API Request
Type | Value |
---|---|
HTTP Method | POST |
API endpoint (Sandbox) | https://api-sandbox.doku.com/cancellation/credit-card/refund |
API endpoint (Production) | https://api.doku.com/cancellation/credit-card/refund |
Here is the sample of request header to generate payment URL:
Client-Id: MCH-0001-10791114622547
Request-Id: 6cc9f8b1-d83d-4c24-b853-a3223f43a744
Request-Timestamp: 2020-08-12T09:45:42Z
Signature: HMACSHA256=9UPUFzOqJc47aJzD9ESOTcWg6TMsg3mqSP+DnUO8ENE=
Request Header Explanation
Parameter | Description |
---|---|
Client-Id | Client ID retrieved from DOKU Back Office |
Request-Id | Unique random string (max 128 characters) generated from merchant side to protect duplicate request |
Request-Timestamp | Timestamp request on UTC time in ISO8601 UTC+0 format. It means to proceed transaction on UTC+7 (WIB), merchant need to subtract time with 7. Ex: to proceed transaction on September 22th 2020 at 08:51:00 WIB, the timestamp should be 2020-09-22T01:51:00Z |
Signature | Security parameter that needs to be generated on merchant Backend and placed to the header request to ensure that the request is coming from valid merchant. Please refer to this section to generate the signature |
Here is the sample request body to request a refund:
{
"order": {
"invoice_number": "INV-20210118-0001"
},
"payment": {
"original_request_id": "b266c265-3d61-4708-9860-c0d5b9a98f8c"
},
"refund": {
"amount": 90000
}
}
Request Body Explanation
Parameter | Type | Mandatory | Description |
---|---|---|---|
order.invoice_number | string | Mandatory | Invoice number of the transaction that being refunded |
payment.original_request_id | string | Mandatory | Request ID from payment initiation of the transaction that being refunded |
refund.amount | number | Mandatory | Transaction amount that wants to be refunded |
API Response
After hitting the above API request, DOKU will give the response.
Type | Value |
---|---|
HTTP Status | 200 |
Result | SUCCESS |
Here is the sample response header:
Client-Id: MCH-0001-10791114622547
Request-Id: 6cc9f8b1-d83d-4c24-b853-a3223f43a744
Response-Timestamp: 2020-08-11T08:45:42Z
Signature: HMACSHA256=1jap2tpgvWt83tG4J7IhEwUrwmMt71OaIk0oL0e6sPM=
Response Header Explanation
Parameter | Description |
---|---|
Client-Id | Same as the request |
Request-Id | Same as the request |
Response-Timestamp | Timestamp Response on UTC with format ISO8601 UTC+0 from DOKU |
Signature | Signature generated by DOKU based on the response body |
Here is the sample of response body:
{
"order": {
"invoice_number": "INV-20210118-0001"
},
"payment": {
"original_request_id": "b266c265-3d61-4708-9860-c0d5b9a98f8c"
},
"refund": {
"amount": 90000,
"type": "FULL_REFUND",
"status": "SUCCESS",
"message": "Approved",
"approval_code": "12321"
}
}
Response Body Explanation
Parameter | Type | Mandatory | Description |
---|---|---|---|
order.invoice_number | string | Mandatory | Same as the request |
payment.original_request_id | string | Mandatory | Same as the request |
refund.amount | number | Mandatory | Same as the request |
refund.type | string | Mandatory | Refund type based on the transaction Possible value: VOID, PARTIAL_REFUND, FULL_REFUND |
refund.status | string | Mandatory | Refund status Possible value: SUCCESS, FAILED |
refund.message | string | Optional | Refund message description |
refund.approval_code | string | Optional | Acquiring approval code for the refund transaction if the refund.status = SUCCESS |
List Of Error Code
API | Error message | Error Code | HTTP Status Code | Explanation |
---|---|---|---|---|
Refund | Invalid Client-Id | invalid_client_id | 400 | Invalid Client ID |
Refund | Header Client-Id is required | invalid_header_request | 400 | empty client id |
Refund | Invalid Header Signature | invalid_signature | 400 | Payment charge with invalid signature |
Refund | No Original Transaction Available | TRANSACTION_NOT_FOUND | 400 | Invalid original request id, invoice number |
Refund | Void Transaction Must Be Full Amount | PAYMENT_FAILED | 400 | partial void |
Refund | Total Refund amount is Bigger than Original Transaction | PAYMENT_FAILED | 400 | refund bigger than original transaction |
Refund Type
- VOID: If the funds has not settled to your bank account. The
refund.amount
must equal toorder.amount
, otherwise will fail - PARTIAL_REFUND: If the funds has settled to your bank account, and the
refund.amount
is less thanorder.amount
- FULL_REFUND: If the funds has settled to your bank account, and the
refund.amount
is equal toorder.amount