Get Refund Order

After submitting a refund application, use this interface to query the refund status.

Interface Address

Sandbox URL: http://api.testbonuspay.network/sgs/api/crypto/refund/getOrder

Production URL: https://api.bonuspay.network/sgs/api/crypto/refund/getOrder

Request Parameters

Http Header

Field Name	Variable Name	Required	Type	Example	Description
Content-Language	N/A	Optional	String(10)	en	en-English
Sign	Required	String	N/A	N/A	The signature of the request
Partner-Id	Required	String(12)	N/A	N/A	The merchant ID

Http Body

Field Name	Variable Name	Required	Type	Example	Description
Request Time	requestTime	Required	Timestamp(3)	1581493898000	The timestamp of the request
Business Content	bizContent	Required	GetRefundOrderRequest	-	The content of the business

GetRefundOrderRequest

Field Name	Variable Name	Required	Type	Example	Description
Refund Merchant Order No.	refundMerchantOrderNo	Optional	String(64)	Me23484	refundMerchantOrderNo and orderNo are mutually exclusive, can't be both empty and non-empty at the same time
BonusPay Order No.	orderNo	Optional	String(32)	220000000001	-

Request Example

Http Header
{
  "Content-Language": "en",
  "Content-Type": "application/json",
  "sign": "C7WdDZhiHV9tt3AYM4zS4jgTr58XmgpNy7ZzGfbAYADGW0XkSw3rNcqkZJWHQcN6yBW+LBTwuGhZhrOUCg/+79hTnhff266avYAiBZ+T+B6kx6FgYu7S9PSGaE9RxksK8mjgPnbwXmWkC541pj/AQac6x2nxj9EPcjl8iprYvu3bhdZTcLCJjCBK1g9bZ426M/JICKId65Bk5OtS9zKa7n+jn+fqZiT60acMOOHM3N8g1Kyzt4bqDdvVe0hPRXGDwCrPZO8WO62NLqejLwNxwPCbFnlbLMtiZyewX72w2Pt0xw/1y6Eh8Or1sIhgy+z4g6c5sUx0SMAPWxpq91oO3g==",
  "Partner-Id": "200000000888" 
}

Http Body
{
  "requestTime": 1581406091642,
  "bizContent": {
    "refundMerchantOrderNo": "M818494241569"
  }
}

Response Parameters

Http Header

Field Name	Variable Name	Required	Type	Example Value	Description
Signature	sign	Required	String	-

The body field in Http Body will only be returned when applyStatus is SUCCESS and code is 0.

Http Body

Field Name	Variable Name	Required	Type	Example Value	Description
Response Header	head	Required	ResponseHeader	-
Response Body	body	Optional	GetRefundOrderResponse	-

GetRefundOrderResponse

Field Name	Variable Name	Required	Type	Example Value	Description
Refund Order Information	refundOrder	Required	RefundOrder	-

Response Example

Http Header
{
  "sign": "nDdClX1tAyV3qcX/Epay6AXFNRGSsWd8ysWO9SgwPrNTetSePLA9C39mGp6qRbjJeqXLEnYLwSkBu5eKdtyVX3tflGLiV2kvRjVfYpTCjXdVL2Pcnv2w+ghjHe2jL988iklk7q5AjAgdtXNphpHcTes9pk6W3bVCbvijH6at0fExUtZ91L1LrnPGELT1IJm/lFW3w4KLh0Gxs7FzDPI9RDfUemObNlRzV8kCtkWahwPgs/hBnS69GyYDKN7ihQX2UiLuP239wl6IA+VG/ZZKHPhLs8bbuOS+LKWORIp6jRt+JsAx7c/Ot1RNyOnHKxPRKJ8bVTohEp39yUz/HwG8oA=="
}

Http Body
{
  "head": {
    "applyStatus": "SUCCESS",
    "code": "0",
    "msg": "SUCCESS"
  },
  "body": {
    "refundOrder": {
      "refundMerchantOrderNo": "M818494241569",
      "orderNo": "191405406113002297",
      "originMerchantOrderNo": "M965739182419",
      "status": "SUCCESS",
      "amount": {
        "currency": "BUSD",
        "amount": 0.01
      },
      "refundFee": {
        "currency": "BUSD",
        "amount": 0.02
      },
      "reason": "refund",
      "reserved": "order desc"
    },
    "refundSummary": {
      "acquireAmount": {
        "currency": "BUSD",
        "amount": 1.01
      },
      "remainRefundAmount": {
        "currency": "BUSD",
        "amount": 1
      }
    }
  }
}

Return Codes

code	msg	reason	solution
0	SUCCESS	Success
400	INVALID_PARAMETER	Invalid parameter	Adjust request parameters
400	REQUESTTIME_TOO_EARLY	Request time is too early compared to the current time	Adjust request time
400	REQUESTTIME_TOO_LATER	Request time is too late compared to the current time	Adjust request time
402	RATE_LIMIT_REJECT	Request frequency is too high	Reduce request frequency
403	UNAUTHORIZED	Unauthorized API access	Contact BonusPay
404	SERVICE_NOT_AVAILABLE	API service is not available	Contact BonusPay
500	SYSTEM_ERROR	System error	Contact BonusPay, try again later
504	SERVICE_TIMEOUT	Service timeout	Try again later
601	RISK_FAIL	Risk verification failed	Adjust business
77002	ORDER_FAILURE	Failed orders cannot be refunded	Adjust merchant order number
77004	MERCHANT_ORDER_NO_NOT_EXIST	The order with the specified merchant order number does not exist	Adjust merchant order number
77005	REFUND_AMOUNT_EXCEEDED	The refund amount exceeds the amount available for refund Available refund amount is the original order amount minus refunded amount and amount in refund process	Adjust refund amount
77013	REFUND_MERCHANT_ORDER_NO_EXIST	A refund request with the same order number and different business parameters is made	Adjust refund merchant order number
77016	ORDER_NO_NOT_EXIST	The order with the specified BonusPay order number does not exist	Adjust BonusPay order number
77024	ORDER_NOT_PAID	A refund request is made for an unpaid order	Adjust business parameters