Reversal Transaction

Process

Description:

• Merchant calls the Reversal API to cancel transactions that have been Authorized but not yet Captured.
• Releases the held amount for the customer.
• Cannot reverse transactions that have already been Captured — use Refund/Void instead.

API Information

Method: POST

Request — Parameters sent by merchant

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	request_id	String(100)	✅	Unique request ID from Merchant to Baokim
2	request_time	String(20)	✅	Request send time. Format: YYYY-MM-DD H:i:s
3	merchant_code	String(50)	✅	Unique merchant identifier
4	order_code	String(50)	✅	Baokim order code returned from the Authentication step
5	reason	String(255)	✅	Reason for cancellation
6	extend	Object	❌	Extended data

Example Request

{
  "request_id": "MERCHANT050015588AXE014",
  "request_time": "2020-08-11 14:41:00",
  "merchant_code": "MERCHANT",
  "order_code": "VLAD_1753867524",
  "reason": "yêu cầu hủy đơn trả góp",
  "extend": {
    "billing": {
      "firstname": "A",
      "lastname": "NGUYEN VAN",
      "address": "313 Truong Chinh, Dong Da",
      "city": "HANOI",
      "state": null,
      "country": "VN",
      "email": "[email protected]",
      "phone": "0394899999",
      "postal_code": "100000"
    }
  }
}

Response

(Parameters returned by Baokim)

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	code	Number(3)	✅	Baokim error code
2	message	String(200)	✅	Error message
3	data	Object	✅	Data returned

Data Information

No.	Field Name	Data Type	Required	Description
1	order_code	Number	✅	Baokim order code
2	reversal_status	Number	✅	Status: 0-Reversal Pending / 1-Reversed / 2-Fail
3	status	Number	✅	Overall order status of Baokim
4	extend	Object	❌	Extended data

Example Response

{
  "code": 0,
  "message": "Success",
  "data": {
    "order_code": "VLAD_1753867524",
    "reversal_status": 1,
    "status": 1,
    "extend": {}
  }
}

Error Code

Error Code	Description
100	Success
11	Failed
101	Baokim system error
104	OAuth authentication error
105	Signature authentication error
301	Order not found by order_code
302	Card issue (does not exist, expired)
303	Card declined
304	Insufficient card balance
305	User cancelled transaction
306	Incorrect OTP
308	Transaction has not completed Authentication
309	Transaction has not completed Authorization
310	Transaction already reversed, cannot capture
311	Transaction already captured, cannot reverse
313	Bank-side processing error
422	Validation error: RequestId invalid
422	Validation error: RequestTime invalid
422	Validation error: PartnerCode invalid
422	Card_data invalid
422	Amount invalid