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://api.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==

                      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 UPI transaction

Response Body

                      udf1-10
                      *
                      

string

Required

                      txn_uuid
                      *
                      

string

Required

Example : eulvW58PbNNojAJXR7B

                      txn_id
                      *
                      

string

Required

Example : txn_uuid

                      status_id
                      *
                      

integer

Required

                      status
                      *
                      

string

Required

Example : VOID_INITIATED

                      return_url
                      *
                      

string

Required

Example : https://api.juspay.in

                      refunded
                      *
                      

boolean

Required

                      product_id
                      *
                      

string

Required

                      payment_method_type
                      
                      

string

Example : CARD

                      payment_method
                      
                      

string

Example : MASTERCARD

                      payment_links
                      *
                      

object

Required

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

Required

                      txn_id
                      
                      

string

Example : 8342jhd9

rrn

string

                      resp_message
                      *
                      

string

Required

Example : Void is Pending

                      resp_code
                      *
                      

string

Required

Example :PENDING

                      epg_txn_id
                      *
                      

string

Required

Example :14327074

                      created
                      *
                      

string

Required

Example :2019-03-01T08:38:44Z

                      auth_id_code
                      
                      

string

Example :NA

                      order_id
                      *
                      

string

Required

Example : 183782

                      merchant_id
                      *
                      

string

Required

Example : merchant_id

                      id
                      *
                      

string

Required

Example : ord_be69837b0a4b4fe486967e1ce1cd0477

                      gateway_id
                      
                      

integer

                      date_created
                      *
                      

string

Required

2019-03-01T08:37:10Z

                      customer_phone
                      *
                      

null

Required

                      customer_id
                      *
                      

string

Required

Example : FUR14920977945

                      customer_email
                      *
                      

null

Required

                      currency
                      *
                      

string

Required

Example : BRL

                      card
                      
                      

object

                      using_saved_card
                      
                      

boolean

                      saved_to_locker
                      
                      

boolean

                      name_on_card
                      
                      

string

Example : test

                      last_four_digits
                      
                      

string

                      expiry_year
                      
                      

string

Example : 2022

                      expiry_month
                      
                      

string

Example : 07

                      card_type
                      
                      

string

Example : DEBIT

                      card_reference
                      
                      

string

Example : aa301450fe38c65cd813a8c33897942b

                      card_issuer
                      
                      

string

Example : HDFC Bank

                      card_isin
                      
                      

string

Example : 541919

                      card_fingerprint
                      
                      

string

Example : 6rds4re1p3678ftk333q64gs1g

                      card_brand
                      
                      

string

Example : MASTERCARD

                      bank_error_message
                      
                      

string

Example : Void is Pending

                      bank_error_code
                      
                      

string

Example : PENDING

                      auth_type
                      
                      

string

Example : THREE_DS

                      amount_refunded
                      *
                      

integer

Required

                      amount
                      *
                      

integer

Required

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

Have questions?
Need help? Contact support
LLM? Read llms.txt