Get Recharge Status
Query the status and crediting information of a recharge order by recharge order number, and return the current wallet balance. The API also attempts to verify pending orders with the payment channel.
Interface Address:
text
/papi/wallet/recharge/getRequest Method:
text
POSTContent-Type:
text
application/jsonHeader Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Access-Key | string | Yes | API access key ID. See API Rules for authentication |
| X-Signature | string | Yes | Signature value, Base64-encoded HMAC-SHA256 result |
| X-Timestamp | string | Yes | Millisecond-level Unix timestamp (13 digits) |
| X-Nonce | string | Yes | Random string, 10~32 lowercase letters and digits |
Body Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| rechargeNo | string | Yes | Recharge order number returned by Create Wallet Recharge |
Request Example:
json
{
"rechargeNo": "MO202611021000000000001"
}Response Parameters:
| Parameter | Type | Description |
|---|---|---|
| code | integer | Error code. See Error Codes |
| data | object | Return data |
| ├─ rechargeNo | string | Recharge order number, same as orderNo |
| ├─ orderNo | string | Associated order number |
| ├─ amount | string | Recharge amount, in cents |
| ├─ currency | string | Currency code |
| ├─ currencySymbol | string | Currency symbol, e.g. $ for USD |
| ├─ rechargeStatus | string | Recharge status: CREATED pending confirmation, CREDITED credited |
| ├─ creditedTime | long | Credited time, Unix timestamp in milliseconds |
| ├─ paymentNo | string | System payment number |
| ├─ paymentStatus | integer | Payment status |
| ├─ payUrl | string | Payment URL provided by the channel |
| ├─ qrCodeUrl | string | Payment QR code URL |
| ├─ payParams | string | Payment channel parameters as a string, varies by channel |
| ├─ balance | string | Current wallet balance, in cents |
| msg | string | Error message |
Response Example:
json
{
"code": 0,
"data": {
"rechargeNo": "",
"orderNo": "",
"amount": "1000",
"currency": "USD",
"currencySymbol": "$",
"rechargeStatus": "CREDITED",
"creditedTime": 1793577600000,
"paymentNo": "",
"paymentStatus": 0,
"payUrl": "",
"qrCodeUrl": "",
"payParams": null,
"balance": "2250"
},
"msg": ""
}Notes:
- Only
rechargeStatus=CREDITEDmeans the recharge has been credited; do not treat other statuses as success. - The final crediting of a recharge is determined by the
CREDITEDstatus of this API.
