Get PaymentEventList

After obtaining the deposit address, merchants can query deposit events by calling this API.

You can compare the "depositedAmount" value returned by this interface with the "amount" value in the acquire order to render different order status pages.

DepositedAmount=0

The customer has not made the payment yet.

DepositedAmount<Order.Amount

The customer has paid an amount less than the order total. This indicates that the customer has underpaid. The merchant can choose to accept the payment and proceed with the transaction or reject the transaction through the portal. In case of rejection, the merchant can initiate a refund for the transaction.

DepositedAmount>Order.Amount

The customer has paid an amount more than the order total. This indicates that the customer has overpaid. The merchant can choose to accept the payment and proceed with the transaction or reject the transaction through the portal. In case of rejection, the merchant can initiate a refund for the transaction.

Interface Address

Sandbox URL: http://api.testbonuspay.network/sgs/api/crypto/getPaymentDepositEventList

Production URL: https://api.bonuspay.network/sgs/api/crypto/getPaymentDepositEventList

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	OrderIndexRequest	-	Business Content

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": {
    "MerchantOrderNo": "M818494241569"
  }
}

Response 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	OrderIndexRequest	-	Business Content

GetPaymentDepositEventListResponse

Field Name	Variable Name	Required	Type	Example	Description
Chain Payment Order	chainPaymentOrder	Optional	ChainPaymentOrder	-
Payment Deposit Event List	paymentDepositEventList	Optional	List<PaymentDepositEvent>	-

Response Example

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

Http Body
{
    "body":{
        "chainPaymentOrder":{
            "network":"TRON",
            "address":"TPBvRUZbFUKZNWS1sszwgaFm81aeZ14oZZ",
            "depositedAmount":{
                "currency":"USDT",
                "amount":10
            },
            "paidTime":1682411580195,
            "status":"COMPLETED",
            "createdTime":1682411425427
        },
        "paymentDepositEventList":[
            {
                "id":20230425000000827,
                "createdTime":1682411580172,
                "amount":{
                    "currency":"USDT",
                    "amount":10
                },
                "payerAddress":"TZFHrW5oJxtX1xoxDUAJJRQn6stDKfMWVE",
                "chainCode":"TRON",
                "receiverAddress":"TPBvRUZbFUKZNWS1sszwgaFm81aeZ14oZZ",
                "confirmedTime":1682411580057,
                "txHash":"1dfbcc97dbd1efeff61f5ee85c2b276552382e3ebc97b30068abaa939d21e204"
            }
        ]
    },
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "traceCode":"000000"
    }
}

Response Code

code	msg	reason	solution
0	SUCCESS	Success
400	INVALID_PARAMETER	Invalid parameter	Adjust request params
400	REQUESTTIME_TOO_EARLY	Request time too early	Adjust request time
400	REQUESTTIME_TOO_LATER	Request time too later	Adjust request time
402	RATE_LIMIT_REJECT	Request too frequent	Reduce request rate
403	UNAUTHORIZED	API unauthorized	Contact BonusPay
404	SERVICE_NOT_AVAILABLE	API service not available	Contact BonusPay
500	SYSTEM_ERROR	System error	Contact BonusPay, try later
504	SERVICE_TIMEOUT	Service timeout	Try later
601	RISK_FAIL	Risk verification failed	Adjust business
77004	MERCHANT_ORDER_NO_NOT_EXIST	Merchant order not exist	Adjust merchant order number
77016	ORDER_NO_NOT_EXIST	BonusPay order not exist	Adjust BonusPay order number