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.

Status Understanding:

Scroll inside to view more

Payment Gateway Response	Juspay Transaction Status
Pending	VOID_INITIATED
Success	VOIDED
Failure	VOID_FAILED
Timeout/no response from gateway	AUTHORIZED

Request

Response

API Endpoints

Sandbox Link

POST

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

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-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      txn_uuid
                      *
                      

String

Mandatory

Transaction UUID

Example:- b337a8c9-8eae-4c55-8713-0fe61a5fabfb

Response Body

                      udf1-10
                      
                      

string

                      txn_uuid
                      
                      

string

eulvW58PbNNojAJXR7B

                      txn_id
                      
                      

string

:txn_uuid

                      status_id
                      
                      

integer

                      status
                      
                      

string

VOID_INITIATED

                      return_url
                      
                      

string

https://api.juspay.in

                      refunded
                      
                      

boolean

                      product_id
                      
                      

string

                      payment_method_type
                      
                      

string

CARD

                      payment_method
                      
                      

string

MASTERCARD

                      payment_links
                      
                      

object

web

string

https://api.juspay.in/merchant/pay/ord_be69837b0a4b4fe486967e1ce1cd0477

                      mobile
                      
                      

string

https://api.juspay.in/merchant/pay/ord_be69837b0a4b4fe486967e1ce1cd0477?mobile=true

                      iframe
                      
                      

string

https://api.juspay.in/merchant/ipay/ord_be69837b0a4b4fe486967e1ce1cd0477

                      payment_gateway_response
                      
                      

object

                      txn_id
                      
                      

string

8342jhd9

rrn

string

                      resp_message
                      
                      

string

Void is Pending

                      resp_code
                      
                      

string

PENDING

                      epg_txn_id
                      
                      

string

14327074

                      created
                      
                      

string

2019-03-01T08:38:44Z

                      auth_id_code
                      
                      

string

                      order_id
                      
                      

string

183782

                      merchant_id
                      
                      

string

merchant_id

id

string

ord_be69837b0a4b4fe486967e1ce1cd0477

                      gateway_id
                      
                      

integer

                      date_created
                      
                      

string

2019-03-01T08:37:10Z

                      customer_phone
                      
                      

null

                      customer_id
                      
                      

string

FUR14920977945

                      customer_email
                      
                      

null

                      currency
                      
                      

string

INR

                      card
                      
                      

object

                      using_saved_card
                      
                      

boolean

                      saved_to_locker
                      
                      

boolean

                      name_on_card
                      
                      

string

test

                      last_four_digits
                      
                      

string

                      expiry_year
                      
                      

string

2022

                      expiry_month
                      
                      

string

                      card_type
                      
                      

string

DEBIT

                      card_reference
                      
                      

string

aa301450fe38c65cd813a8c33897942b

                      card_issuer
                      
                      

string

HDFC Bank

                      card_isin
                      
                      

string

541919

                      card_fingerprint
                      
                      

string

6rds4re1p3678ftk333q64gs1g

                      card_brand
                      
                      

string

MASTERCARD

                      bank_error_message
                      
                      

string

Void is Pending

                      bank_error_code
                      
                      

string

PENDING

                      auth_type
                      
                      

string

THREE_DS

                      amount_refunded
                      
                      

integer

                      amount
                      
                      

integer

Response Body

                      status
                      
                      

string

Bad Request

                      error_message
                      
                      

string

Invalid state for void operation.

                      error_code
                      
                      

string

Invalid

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied