queryCustomerDepositOrderPage

This interface provides a pagination query function for crypto TOPUP orders.

State Machine

CustomerDepositOrderStatus

Status	Description
SUCCESS	Successful
CREATED	Created

Interface Address

Integration URL:https://api.testbonuspay.network/sgs/api/ccdeposit/queryCustomerDepositOrderPage

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

Request Parameters

Http Header

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

Http Body

Field Name	Variable Name	Required	Type	Example Value	Description
Request Time	requestTime	Required	Timestamp(3)	1581493898000
Business Content	bizContent	Required	JSON	-	Business content
Start Time	-startTime	Required	Timestamp(3))	1625918382343	Maximum of 30 days in the past
End Time	-endTime	Required	Timestamp(3)	1626782382346	Maximum interval between start and end time is 24 hours
Pagination Parameters	-pageParam	Required	PageParam

Request Example

Http Header
{
    "Content-Language": "en",
    "Content-Type": "application/json",
    "sign": "IXJI/QicPQotIsIDBcSGIg6jtJUXs1rTuifQFZUNd3KDTl25GKmpYO7OrkaKkTV0shDRitLmkxJCe3Z60zHE2ZSeVczrhwrnmuMG+bX9N22Hw821H6MydsXetYHRnyf5dPbgpmVja582w49grA6jRlVFAVMYdxKJDPSCb2X/IpltvyrLQ1Wt+lqr+fnpYXvyON6/PIZIQIknC8BVddVahxJnaC6HEagvJf6gskz22/DFfPHT1mlMA9pg8qrbh4O7DYZahf8TB3nIzAPc/FHOUZkYYTT2c8m4eLL8740nJVK7D3IOSqSnBAU/iJ2omjPPFvRCCSqzz17pkGsT7AW91w==",
    "Partner-Id": "200000000888"
}

Http Body
{
	"requestTime": 1581404947666,
	"bizContent":{
        "endTime":1626782382346,
        "pageParam":{
            "number":0,
            "size":10
        },
        "startTime":1625918382343
    }
}

Response Parameters

Http Header

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

Http Body's "body" field is only returned when "applyStatus" is SUCCESS and "code" is 0.

Http Body

Field Name	Variable Name	Required	Type	Example Value	Description
Response Header	head	Required	JSON	-
Request Status	-applyStatus	Required	String(16)	SUCCESS	SUCCESS-Application Successful<br/>FAIL-Application Failed<br/>ERROR-Application Exception
Returned Error Code	-code	Required	String(10)	0	Return code
Returned Message	-msg	Required	String(200)	-	Returned message
Response Body	body	Optional	JSON	-
Order Pagination Information	-customerDepositOrderPage	Required	Pagination<CustomerDepositOrder>	-

Response Example

Http Header
{
  "sign": "XBRRQzTFvIKPE4bhBLKXF23RBeJn7WytxwhQXutCTZgO7NmzVE0YufjbSUSFKB5Eg6EtrVMVFM/FmTSSI/hWBJnk0j8rBxb+K3FlplTw1ydStM7upkvxLOe2uoOkac8FFXZIvjRWDNY7+VXwo40yI33Ct3YLTwu5kQHhVCEf6ClvnkTynXuy6hxALFsbJchKOZNbqm5WA24x2VtFbNe+jz+CRwD4MD8xg6npPMwfTc0b4sZ7SkUAKYlttxm+nO9qFjczbp55R7LdajxfCXxgpTp0hc576pwo2AqyNDcMjzunynX+AR7pzDqwkgC1NIc/eax67HPq/X+v/T8t671sHg=="
}

Http Body
{
    "body":{
        "customerDepositOrderPage":{
            "items":[
                {
                    "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"
                }
            ],
            "sortPageParam":{
                "number":0,
                "size":10,
                "sortParamList":[
                    {
                        "direction":"DESC",
                        "property":"confirmedTime"
                    }
                ]
            },
            "totalElements":1,
            "totalPages":1
        }
    },
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "success":true,
        "traceCode":"122489"
    }
}

Return Codes

code	msg	Reason	Solution
0	SUCCESS	Success
400	INVALID_PARAMETER	Parameter error	Adjust request parameters
400	REQUESTTIME_TOO_EARLY	Request time too early	Adjust request time
400	REQUESTTIME_TOO_LATER	Request time too late	Adjust request time
402	RATE_LIMIT_REJECT	Request too frequent	Reduce request frequency
403	UNAUTHORIZED	API not authorized	Contact BonusPay
404	SERVICE_NOT_AVAILABLE	API service unavailable	Contact BonusPay
500	SYSTEM_ERROR	System error	Contact BonusPay, try again later
504	SERVICE_TIMEOUT	Service timeout	Try again later
601	RISK_FAIL	Risk check failed	Adjust business
75004	TIME_RANGE_OVER_LIMIT	Time range exceeded	Adjust time parameters
75005	STARTTIME_TOO_EARLY	Start time earlier than 30 days	Adjust start time
75006	ENDTIME_LESS_THAN_STARTTIME	End time earlier than start time	Adjust end time