POST Cancel Recharge endpoint.
Endpoint
POST
/web/v1/partner/recharges/{bizId}/cancel WEBAuthentication
- Chain: WEB
- JWT Token: true
- API Key: false
- Permissions: ["recharge:cancel"]
- Secure Channel: REQUIRED
Rate Limit
120 requests per 60 seconds.
Headers
Frontend Headers
| Header | Required | Description |
|---|---|---|
| X-LOCALE | Yes | 用户的 locale |
| Accept-Language | No | 语言偏好 |
Cloudflare Headers
| Header | Required | Description |
|---|---|---|
| CF-Connecting-IP | Yes | Client IP from Cloudflare |
| CF-IPCountry | Yes | Client country code |
| CF-Ray | Yes | Cloudflare Ray ID |
| CF-Visitor | Yes | Visitor scheme |
| X-Real-IP | Yes | Real client IP |
Nginx Headers
| Header | Required | Description |
|---|---|---|
| X-PORTAL-ACCESS-CODE | Yes | Portal access code |
| X-Real-IP | Yes | 客户端真实 IP |
| X-Forwarded-For | Yes | 代理链 |
| X-Forwarded-Proto | Yes | 协议 |
Request Parameters
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| bizId | String | Yes | Recharge order business ID |
Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| cancelReason | String | No | Cancel reason |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| bizId | String | Recharge order business ID |
| workspaceBizId | String | Workspace business ID |
| channelBizId | String | Channel business ID |
| currency | String | Currency code |
| amount | BigDecimal | Recharge amount |
| userFeeAmount | BigDecimal | User fee amount |
| channelFeeAmount | BigDecimal | Channel fee amount |
| netAmount | BigDecimal | Net amount |
| status | Integer | Order status |
| expiredAt | Instant | Expiry time |
| proofFileBizId | String | Proof file business ID |
| proofUploadedAt | Instant | Proof upload time |
| operatorRemark | String | Operator remark |
| cancelReason | String | Cancel reason |
| channelConfigSnapshot | String | Channel config snapshot |
| createdAt | Instant | Creation time |
| completedAt | Instant | Completion time |