Funds Withdrawal Cancellation
This API allows you to cancel a pending funds withdrawal request. You need to provide the product ID, withdrawal amount, and the transaction reference number.
| Header | Type | Description | Example/ENUM |
|---|
| Authorization | string | Bearer token for authenticating the request. | Bearer {{access_token}} |
| Content-Type | string | Specifies the media type of the request body. | application/json |
| x-api-key | string | API key provided to access the service. | {{x-api-key}} |
📦Request Body Schema
| Parameter | Type | Description | Example/ENUM |
|---|
| productId | string | ID of the product from which the withdrawal was requested. | "100" |
| amount | string | Amount of the withdrawal request that needs to be canceled. | "2500" |
| TxnRefNo | string | Unique transaction reference number of the withdrawal request. | "TXN123456" |
🟢Success Response - 200 Ok
| Field | Type | Description | Example/ENUM |
|---|
| status | string | Indicates the status of the API call. | "success" |
| code | string | Response code related to the result of the request. | "s-101" |
| message | string | Descriptive message about the cancellation result. | "success message" |
| data | object | Optional object containing additional response data. | {Details below} |
📘Data Object Field
| Field | Type | Description | Example/ENUM |
|---|
| ResponseString | string | Additional message or technical status returned by the system. | "Request for Withdrawal Cancellation has been successfully sent. Transaction Reference No: 22040113700000016" |