This will be used to void an authorized transaction.

📘

NOTE: Please note the transaction status in response to Void API, when the underlying Payment gateways send:

  • Pending => VOID_INITIATED
  • Success => VOIDED
  • Failure => VOID_FAILED
  • Timeout/no response from PG => AUTHORIZED

The orders should be voided within 7 days of transaction initiation.

Request

TypeParamsValuesDescription
HEADERapi_keystring
EMBEDDEDtxn_uuidstringtxn_uuid available in Order Status API response

Example

curl -X POST https://api.juspay.in/v2/txns/euhlsjbd8yhjdm/void 
-u your_api_key:

Response

Response ParamsValuesDescription
order_idstringOrderID for which the payment is being started.
txn_idstringTransaction ID for the payment attempt.
statusstringStatus of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete. Please do not validate this at your end.
paymentstringContains the payment authentication details.
authenticationstringContains the authentication details.
methodstringHTTP Method for authentication. Can be one of GET or POST
urlstringURL to which the user has to be taken to for completing the authentication
paramsobjectPresent only when method is POST. Parameter map that has to be sent along with the URL for authentication.

Did this page help you?