Skip to main content

credit-card-online-refund-section

You can request void or refund using this API.

Requirements
  1. If you are using Credit Card Aggregator service, you can process Void or Refund.
  2. 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

TypeValue
HTTP MethodPOST
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
ParameterDescription
Client-IdClient ID retrieved from DOKU Back Office
Request-IdUnique random string (max 128 characters) generated from merchant side to protect duplicate request
Request-TimestampTimestamp 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
SignatureSecurity 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
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatoryInvoice number of the transaction that being refunded
payment.original_request_idstringMandatoryRequest ID from payment initiation of the transaction that being refunded
refund.amountnumberMandatoryTransaction amount that wants to be refunded

API Response

After hitting the above API request, DOKU will give the response.

TypeValue
HTTP Status200
ResultSUCCESS

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
ParameterDescription
Client-IdSame as the request
Request-IdSame as the request
Response-TimestampTimestamp Response on UTC with format ISO8601 UTC+0 from DOKU
SignatureSignature 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
ParameterTypeMandatoryDescription
order.invoice_numberstringMandatorySame as the request
payment.original_request_idstringMandatorySame as the request
refund.amountnumberMandatorySame as the request
refund.typestringMandatoryRefund type based on the transaction
Possible value: VOID, PARTIAL_REFUND, FULL_REFUND
refund.statusstringMandatoryRefund status
Possible value: SUCCESS, FAILED
refund.messagestringOptionalRefund message description
refund.approval_codestringOptionalAcquiring approval code for the refund transaction if the refund.status = SUCCESS
List Of Error Code
APIError messageError CodeHTTP Status CodeExplanation
RefundInvalid Client-Idinvalid_client_id400Invalid Client ID
RefundHeader Client-Id is requiredinvalid_header_request400empty client id
RefundInvalid Header Signatureinvalid_signature400Payment charge with invalid signature
RefundNo Original Transaction AvailableTRANSACTION_NOT_FOUND400Invalid original request id, invoice number
RefundVoid Transaction Must Be Full AmountPAYMENT_FAILED400partial void
RefundTotal Refund amount is Bigger than Original TransactionPAYMENT_FAILED 400refund bigger than original transaction
Refund Type
  • VOID: If the funds has not settled to your bank account. The refund.amount must equal to order.amount, otherwise will fail
  • PARTIAL_REFUND: If the funds has settled to your bank account, and the refund.amount is less than order.amount
  • FULL_REFUND: If the funds has settled to your bank account, and the refund.amount is equal to order.amount