getCustomerDepositOrder

Query order information

Interface Address

Sandbox URL:https://api.testbonuspay.network/sgs/api/ccdeposit/getCustomerDepositOrder

Production URL: https://api.bonuspay.network/sgs/api/ccdeposit/getCustomerDepositOrder

Request Parameters

Http Header

Field Name	Variable Name	Required	Type	Example	Description
Language	Content-Language	Optional	String(10)	en	en-English
Signature	Sign	Required	String
Partner ID	Partner-Id	Required	String(12)

Http Body

Field Name	Variable Name	Required	Type	Example	Description
Request Time	requestTime	Required	Timestamp(3)	1581450087000
Business Content	bizContent	Required	JSON	-	Business content
BonusPay Order No.	-orderNo	Required	String(32)	22000000000001

Request Example

Http Header
{
  "Content-Language": "en",
  "Content-Type": "application/json",
  "sign": "Tu3fopHy1opsWVTAk12FSr8KsGMcFTQB0dOH4fPGrG8iKvhcGCsmCr4kOy3CBmv7zXpBNfMxoRW33YPz0Zm6503CDnqxlOZGaOCFSmwnsE01vDzZL489wPj5HEKJ7kk70/muDMiUwJubZoXVtmOGhpvvczJDYIhP/5kpwSkucdkjZwrlp7IGqoFHrgKgZXXieOsUlGJHb9xg+HchtCqCYaOvX+gIK/o88SdgogvGm8NW/N4dzBhnfbwPcC7ue3MO8mwCDkJ/5KavK8TEotSeTvFEyhAvzrd41ccg47SWXZ4UnhvwT06iIYZ67G4Xg24Bc97cQe1XFM9CPd+/8w7uDA==",
    "Partner-Id": "200000000888"
}

Http Body
{
  "requestTime": 1581405884647,
  "bizContent": {
    "orderNo": "20210720000000252"
  }
}

Response Parameters

Http Header

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

Http Body will only return the 'body' field when 'applyStatus' is SUCCESS and 'code' is 0.

Http Body

Field Name	Variable Name	Required	Type	Example	Description
Response Header	head	Required	JSON	-
Request Status	-applyStatus	Required	String(16)	SUCCESS	SUCCESS-Application successful<br/>FAIL-Application failed<br/>ERROR-Application exception<br/>
Return Error Code	-code	Required	String(10)	0	Return code
Return Message	-msg	Required	String(200)	-	Return message
Response Body	body	Optional	JSON	-
Order Information	-customerDepositOrder	Optional	CustomerDepositOrder	-

Response Example

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

Http Body
{
    "body":{
        "customerDepositOrder":{
            "confirmedTime":1626766860411,
            "customerId":"test001",
            "depositAmount":{
                "amount":0.02,
                "currency":"ETH"
            },
            "settledAmount":{
                "amount":0.01,
                "currency":"ETH"
            },
            "fee":{
                "amount":0.01,
                "currency":"ETH"
            },
            "network":"ETH",
            "orderNo":"20210720000000252",
            "product":"CTOPUP",
            "status":"SUCCESS",
            "txHash":"0x8847644b885ebc4342aaca100ae13bc6e5655a74f5e18d10dd832bce1633bec2"
        }
    },
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "success":true,
        "traceCode":"722493"
    }
}

Response Codes

Code	Message	Description	Solution
0	SUCCESS	Success
400	INVALID_PARAMETER	Invalid parameter	Adjust request parameters
400	REQUESTTIME_TOO_EARLY	Request time is too early	Adjust request time
400	REQUESTTIME_TOO_LATER	Request time is too late	Adjust request time
402	RATE_LIMIT_REJECT	Request frequency is too high	Reduce request frequency
403	UNAUTHORIZED	API is not authorized	Contact BonusPay
404	SERVICE_NOT_AVAILABLE	API service is not available	Contact BonusPay
500	SYSTEM_ERROR	System error	Contact BonusPay or try again later
504	SERVICE_TIMEOUT	Service timeout	Try again later
601	RISK_FAIL	Risk verification failed	Adjust the business
75001	ORDER_NO_NOT_EXIST	BonusPay order does not exist	Adjust the BonusPay order number