shopeepay-online-refund-section

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/shopeepay-emoney/v2/refund
API endpoint (Production)	https://api.doku.com/shopeepay-emoney/v2/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": "MINV20201231468"
    },
    "shopeepay_payment": {
        "identifier": [
            {
                "name": "PAYMENT_REFERENCE_ID",
                "value": "REF-12345678"
            }
            {
                "name": "TRANSACTION_SN",
                "value": "000000012345678"
            }
        ]
    }
}

Request Body Explanation

Parameter	Type	Mandatory	Description
order.invoice_number	string	Mandatory	Invoice number of the transaction that being refunded
shopeepay_payment.identifier	Array	Mandatory	Get from payment notification response

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:

{
    "service": {
        "id": "EMONEY”
    },
    "acquirer": {
        "id": "SHOPEE_PAY”
    },
    "channel": {
        "id": "EMONEY_SHOPEE_PAY”
    },
    “order”: {
        "invoice_number":"MINV20201231468",
        "amount":150000
    },
    "transaction": {
        "status": "REFUNDED”,
        "date": "2020-08-11T08:45:42Z",
        "original_request_id": "asdak1238912381"
    },
    "refund”: {
        "status": "SUCCESS",
        "date": "2020-08-11T08:45:42Z",
        "original_request_id": "asdak1238912381"
    },
    "additional_info": {
    },
    "shopeepay_configuration": {
        "merchant_ext_id": "846609710695590”,
        "store_ext_id”: "99012984”
    },
    "shopeepay_payment": {
        "identifier": [
            {
                "name": "PAYMENT_REFERENCE_ID”,
                "value": "REF-12345678”
            },{
                "name": "TRANSACTION_SN”,
                "value": "000000012345678”
            },{
                "name": "USER_ID_HASH”,
                "value": "dhfas0yd0ayf0sadf7nys0af0san7”
            },
        ],
        "transaction_status”: "3”,
        “transaction_message”: “Transaction successful”
    },
    "shopeepay_refund”: {
        "identifier": [
            {
                "name": "PAYMENT_REFERENCE_ID”,
                "value": "REF-12345678”
            },{
                "name": "TRANSACTION_SN”,
                "value": "000000012345678”
            },{
                "name": "USER_ID_HASH”,
                "value": "dhfas0yd0ayf0sadf7nys0af0san7”
            },
        ],
        "transaction_status”: "3”,
        “transaction_message”: “Transaction successful”
    }
}

Response Body Explanation

Parameter	Type	Mandatory	Description
service.id	string	Mandatory	Same as the request
acquirer_id	string	Mandatory	Same as the request
channel.id	number	Mandatory	Same as the request
order.invoice_number	string	Mandatory	Merchant invoice number, must unique per request per merchant
order.amount	number	Mandatory	Amount per request per merchant
transaction.status	string	Mandatory	Transaction status Possible value: REFUNDED, SUCCESS, FAILED
transaction.date	string	Mandatory	Time Stamp request on UTC time in ISO8601 format
transaction.original_request_id	string	Mandatory	Request Id from create order request
refund.status	string	Mandatory	Refund status Possible value: SUCCESS, FAILED
refund.date	string	Mandatory	Time Stamp request on UTC time in ISO8601 format
refund.original_request_id	string	Mandatory	Request Id from create order request
additional_info	string	Mandatory	Additional info
shopeepay_configuration.merchant_ext_id	string	Mandatory	Merchant identifier
shopeepay_configuration.store_ext_id	string	Mandatory	Merchant identifier
shopeepay_payment.identifier	string	Mandatory	Transaction data identifier
shopeepay_payment.transaction_status	string	Mandatory	Transaction data status
shopeepay_payment.transaction_message	string	Mandatory	Transaction message description
shopeepay_refund.identifier	string	Mandatory	Refund data identifier
shopeepay_refund.transaction_status	string	Mandatory	Refund data status
shopeepay_refund.transaction_message	string	Mandatory	Refund message description