Skip to content

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/get

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10~32 lowercase letters and digits

Body Parameters:

ParameterTypeRequiredDescription
rechargeNostringYesRecharge order number returned by Create Wallet Recharge

Request Example:

json
{
  "rechargeNo": "MO202611021000000000001"
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectReturn data
├─ rechargeNostringRecharge order number, same as orderNo
├─ orderNostringAssociated order number
├─ amountstringRecharge amount, in cents
├─ currencystringCurrency code
├─ currencySymbolstringCurrency symbol, e.g. $ for USD
├─ rechargeStatusstringRecharge status: CREATED pending confirmation, CREDITED credited
├─ creditedTimelongCredited time, Unix timestamp in milliseconds
├─ paymentNostringSystem payment number
├─ paymentStatusintegerPayment status
├─ payUrlstringPayment URL provided by the channel
├─ qrCodeUrlstringPayment QR code URL
├─ payParamsstringPayment channel parameters as a string, varies by channel
├─ balancestringCurrent wallet balance, in cents
msgstringError 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=CREDITED means the recharge has been credited; do not treat other statuses as success.
  • The final crediting of a recharge is determined by the CREDITED status of this API.

OpenAPI Docs