Skip to main content

FUNDS WITHDRAWAL CANCELLATION

This API allows users to cancel pending fund withdrawal requests before they are processed by the system.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample
productIdstringYesProduct ID associated with the withdrawal request"1"
amountstringYesAmount of the withdrawal request to be cancelled"10000"
TxnRefNostringYesTransaction reference number of the withdrawal request"TXN123456"

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Withdrawal cancellation request processed successfully"
dataobjectCancellation response detailsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
ResponseStringstringResponse 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.