Skip to main content

Void

Cancel a card transaction before it has been settled.


Endpoint

MethodPOST
Path/cards-refund/reverse
Sandboxhttps://sandbox.simpaisa.com/cards-refund/reverse

Headers

HeaderValue
client-idYour Client ID (e.g. YOUR_CLIENT_ID)
Content-Typeapplication/json
merchantIdYour unique merchant ID (e.g. YOUR_MERCHANT_ID)
modecards
regionPK
versionV5

Request Body

ParameterRequiredDescription
request.apiOperationYesVOID to cancel the transaction
request.referenceYesReference of the transaction to void
request.transactionDateYesOriginal transaction date (YYYY-MM-DD)
request.amountNoAmount to void
request.additionalParameter.additionalString1NoAdditional string parameter
request.additionalParameter.additionalString2NoAdditional string parameter
request.additionalParameter.additionalString3NoAdditional string parameter
request.additionalParameter.additionalInteger1NoAdditional integer parameter
request.additionalParameter.additionalInteger2NoAdditional integer parameter
request.additionalParameter.additionalDateNoDate parameter (YYYY-MM-DD)
signatureYesRSA signature of the request body

Response Body

ParameterDescription
response.action_idUnique action ID for the void request
response.statuse.g. Declined, Refunded
response.response_codeOutcome code (e.g. 0 for success)
response.response_summarye.g. Transaction Refunded Successfully.
response.referenceReference of the original transaction
response.RefundReferenceNumberReference number for the voided transaction
signatureRSA signature of the response body

Sample Request

curl --location 'https://sandbox.simpaisa.com/cards-refund/reverse' \
--header 'client-id: YOUR_CLIENT_ID' \
--header 'merchantId: YOUR_MERCHANT_ID' \
--header 'mode: cards' \
--header 'region: PK' \
--header 'version: V5' \
--header 'Content-Type: application/json' \
--data-raw '{
"request": {
"apiOperation": "VOID",
"reference": "haf261",
"amount": "9",
"transactionDate": "2025-02-06",
"additionalParameter": {
"additionalString1": "drhehxnndngtdtdhthjjy",
"additionalString2": "string_value_2",
"additionalString3": "string_value_3",
"additionalInteger1": 12345,
"additionalInteger2": 67890,
"additionalDate": "2024-09-13"
}
},
"signature": "YOUR_SIGNATURE"
}'

Sample Response

{
"response": {
"apiOperation": "VOID",
"action_id": "act_59f6fe8ab8264bb4a5cc2390ba",
"status": "Refunded",
"response_code": "0",
"response_summary": "Transaction Refunded Successfully.",
"reference": "haf261",
"RefundReferenceNumber": "2025020611273607100030",
"additionalParameter": {
"additionalString1": "drhehxnndngtdtdhthjjy",
"additionalString2": "string_value_2",
"additionalString3": "string_value_3",
"additionalInteger1": 12345,
"additionalInteger2": 67890,
"additionalDate": "2024-09-13"
}
},
"signature": "YOUR_SIGNATURE"
}