Void API
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
Method | URL |
---|---|
POST | https://api.juspay.in/v2/txns/:txn_uuid/void |
Type | Params | Values | Description |
---|---|---|---|
HEADER | api_key | string | |
EMBEDDED | txn_uuid | string | txn_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 Params | Values | Description |
---|---|---|
order_id | string | OrderID for which the payment is being started. |
txn_id | string | Transaction ID for the payment attempt. |
status | string | Status of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete. Please do not validate this at your end. |
payment | string | Contains the payment authentication details. |
authentication | string | Contains the authentication details. |
method | string | HTTP Method for authentication. Can be one of GET or POST |
url | string | URL to which the user has to be taken to for completing the authentication |
params | object | Present only when method is POST. Parameter map that has to be sent along with the URL for authentication. |
Updated over 2 years ago