Request Refund

POST

/cancellation/credit-card/refund

Environment
Sandbox - https://api-sandbox.doku.com
Production - https://api.doku.com

These are the possible Response Status:

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

Notification will be sent to merchant's configured endpoint URL upon successful refund or void.

Request

Header Params

Body Params application/json

Example

{
    "order": {
        "invoice_number": "INV-20210118-0001"
    },
    "payment": {
        "original_request_id": "b266c265-3d61-4708-9860-c0d5b9a98f8c"
    },
    "refund": {
        "amount": 11
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/cancellation/credit-card/refund' \
--header 'Client-Id: 10791114622547' \
--header 'Request-Id: e71fe02a-bfef-4af9-a6f6-2cf1f03b00e7' \
--header 'Request-Timestamp: 2020-11-18T08:45:42Z' \
--header 'Signature: HMACSHA256=vl9DBTX5KhEiXmnpOD0TSm8PYQknuHPdyHSTSc3W6Ps=' \
--header 'Content-Type: application/json' \
--data '{
    "order": {
        "invoice_number": "INV-20210118-0001"
    },
    "payment": {
        "original_request_id": "b266c265-3d61-4708-9860-c0d5b9a98f8c"
    },
    "refund": {
        "amount": 11
    }
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "order": {
        "invoice_number": "INV-20210118-0001"
    },
    "payment": {
        "original_request_id": "b266c265-3d61-4708-9860-c0d5b9a98f8c"
    },
    "refund": {
        "amount": 11,
        "type": "FULL_REFUND",
        "status": "SUCCESS",
        "message": "Approved",
        "approval_code": "12321"
    }
}

🟠400Bad Request

🔴500Server Error

Modified at 2026-11-02 08:08:29

Capture Authorized Payment

Unbind Token