Query API Code Status
Query the API code info of a certain wallet.Use the inactivated
API code in any request will activate it. Once activated, the currently activated API code will immediately become invalid.
Request
VIEW
GET /v1/sofa/wallets/{WALLET_ID}/apisecret
Withdrawal Wallet
Deposit Wallet
Deposit-withdrawal Wallet
Delegated Wallet
Response Body
Field | Type | Description |
---|---|---|
valid | object | The activated API code |
inactivated | object | Not active API code |
api_code | string | API code for querying wallet |
exp | int64 | API code expiration unix time in UTC |
Use an invalid API code, the caller will get a 403 Forbidden error.
Error Code
HTTP Code | Error Code | Error | Message | Description |
---|---|---|---|---|
403 | - | Forbidden. Invalid wallet ID | - | No wallet ID found |
403 | - | Forbidden. Header not found | - | Missing X-API-CODE , X-CHECKSUM header or query param t |
403 | - | Forbidden. Invalid timestamp | - | The timestamp t is not in the valid time range |
403 | - | Forbidden. Invalid checksum | - | The request is considered a replay request |
403 | - | Forbidden. Invalid API code | - | X-API-CODE header contains invalid API code |
403 | - | Invalid API code for wallet {WALLET_ID} | - | The API code mismatched |
403 | - | Forbidden. Checksum unmatch | - | X-CHECKSUM header contains wrong checksum |
403 | - | Forbidden. Call too frequently ({THROTTLING_COUNT} calls/minute) | - | Send requests too frequently |
403 | 385 | API Secret not valid | - | Invalid API code permission |
Sample Request
API
/v1/sofa/wallets/488471/apisecret
Response Body
{
"valid": {
"api_code": "H4Q6xFZgiTZb37GN",
"exp": 1583144863
},
"inactivated": {
"api_code": "32PmGCjNzXda4mNHX"
}
}
Sample cURL Command
Designed for the mock server
curl -X GET http://localhost:8889/v1/mock/wallets/{WALLET_ID}/apisecret