FUNDS WITHDRAWAL CANCELLATION
This API allows users to cancel pending fund withdrawal requests before they are processed by the system.
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
📑 Request Body Parameters
| Field | Type | Required | Description | Example |
|---|
| productId | string | Yes | Product ID associated with the withdrawal request | "1" |
| amount | string | Yes | Amount of the withdrawal request to be cancelled | "10000" |
| TxnRefNo | string | Yes | Transaction reference number of the withdrawal request | "TXN123456" |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | Success message | "Withdrawal cancellation request processed successfully" |
| data | object | Cancellation response details | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|
| ResponseString | string | Response message received from the withdrawal web service | "Withdrawal request cancelled successfully" |
📝 Notes
- Only pending withdrawal requests can be cancelled.
TxnRefNo must match the transaction reference number of the withdrawal request.
amount should match the amount of the original withdrawal request.