JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Void API

This will be used to void an authorized transaction. With this, amount will be refunded to the original source.

Status Understanding:

Scroll inside to view more

Payment Gateway Response	Juspay Transaction Status	Description
Pending	VOID_INITIATED	Void API was initiated from Juspay, and the request is pending at the gateway's end.
Success	VOIDED	Void API was initiated, and void transaction was successfully completed.
Failure	VOID_FAILED	Void API was initiated, but the void transaction failed.
Timeout/no response from gateway	AUTHORIZED	Void API request initiated from Juspay, but the request timed out, and no response is received from the gateway.

Request

Response

API Endpoints

Production Link

POST

https://api.juspay.in/v2/txns/{txn_uuid}/void

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

String

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      txn_uuid
                      
                      

String

Max Length :128

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of RTP transaction

Response Body

                      udf1-10
                      
                      

string

UDFs passed during order creation will be received

                      txn_uuid
                      
                      

string

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction. Its txn_uuid apssed in the capture request.

                      txn_id
                      
                      

string

Transaction ID of specified txn_uuid

                      status_id
                      
                      

integer

Status ID of the transaction

                      status
                      
                      

string

Status of the void transaction

                      return_url
                      
                      

string

Redirectional URL once the transaction is completed.URL passed in the request will be received

                      refunded
                      
                      

boolean

Denotes whether transaction is refunded or not

                      payment_method_type
                      
                      

string

payment method type of transaction

                      payment_method
                      
                      

string

payment method of transaction

                      payment_gateway_response
                      
                      

object

Lists the response received from the gateway

                      txn_id
                      
                      

string

Transaction ID of specified txn_uuid

rrn

string

RRN provided by bank for tracking status

                      resp_message
                      
                      

string

Denotes the response received from gateway

                      resp_code
                      
                      

string

Denotes response code of the transaction

                      epg_txn_id
                      
                      

string

Transaction id created at the void transaction processed gateway

                      created
                      
                      

string

Denotes the status updation time

                      order_id
                      
                      

string

Order ID of the transaction

                      gateway_id
                      
                      

integer

Denotes Juspay gateway ID with which the transaction was processed

                      date_created
                      
                      

string

Response time

                      currency
                      
                      

string

Currency of the processed transaction

                      card
                      
                      

object

Card details passed in the transaction request

                      bank_error_message
                      
                      

string

Error message in case of transaction failure

                      bank_error_code
                      
                      

string

error code for the transaction failure

                      auth_type
                      
                      

string

Type of transaction

                      amount_refunded
                      
                      

integer

specifies the Refunded amount

                      amount
                      
                      

integer

Transaction amount

Response Body

                      error_message
                      
                      

String

Provides the reason for the error

Example:- Sample Response:Cannot Void AUTHENTICATION_FAILED Transaction

                      status
                      
                      

String

Error status

Example:- Response:Bad Request

                      error_code
                      
                      

String

Specifies the Error code

Example:- Sample Response:Invalid

                      error_info
                      
                      

JSON

Additional information on the error message

                      user_message
                      
                      

String

Error message can be displayed to the user

Example:- Sample Response:Invalid request params. Please verify your input.

                      developer_message
                      
                      

String

Detailed info on the error

Example:- Sample Response:Cannot Void AUTHENTICATION_FAILED Transaction

                      category
                      
                      

String

category of the error

Example:- Response: USER_ERROR

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

Error Codes:

Scroll inside to view more

Scenario	Error Codes	Description	Sample Error Message
Performing VOID on AUTHENTICATION_FAILED transaction	400	Bad Request	{"error_message":"Cannot Void AUTHENTICATION_FAILED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Void AUTHENTICATION_FAILED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Performing void on charged transaction	400	Bad Request	{"error_message":"Cannot Void CHARGED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Void CHARGED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Performing void on charged transaction	400	Bad Request	{"error_message":"Cannot Void CHARGED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Void CHARGED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Adding double slash at the end of the endpoint of void curl	404	Not Found
Passing Invalid txn_uuid in void curl	400	Bad Request	{"status":"NOT_FOUND","error_info":{"user_message":"Cannot process your request as txn not found.","developer_message":"Txn not found.","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"},"status_id":40}
Passing V1 in place of V2 in void curl	404	Not Found
Performing Void on transaction which is in'PENDING' status	400	Bad Request	{"error_message":"Cannot Void PENDING_VBV Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Void PENDING_VBV Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}