Delete B2C transaction

You can delete a B2C QR transaction by sending a POST request to B2C QR code API with the following request headers.

Request Method

POST

Request URL

{{HOST}}/einv/v1/b2c/delete

Request Headers

Parameter	Data Type	Field Validations	Description
X-Cleartax-Auth-Token	String	NA	Mandatory. The auth token generated from ClearTax user id and password.
Content-Type	String	NA	Mandatory. This will always be "application/json" for JSON
Gstin	String	NA	Mandatory. GSTIN number for the user.

Request Path Params

There are no path parameters for this API.

Request Query Params

There are no query parameters for this API.

Request Body

Parameter	Data Type	Field Validations	Description
transaction_id	String	NA	Mandatory. Value of transaction_id received from Generate B2C QR Code API response.

Response Status Code

HTTP Status Code	Description
200	For a successfully processed request (may be a success or validation error).
401	If the user is not authenticated for the operation.
403	If the user is not authorised for the operation.
500	If there are any unhandled exceptions on the Clear side.

Response Schema

On Successful deletion, you will receive HTTP Status Code 200 OK in the API response.

Sample Request and Response

Request

[
    "29AAFCD5862R000_B2CTest1_INV_2025"
]

Response (Success)

HTTP Status Code: 200 OK

1

Response (Failure)

HTTP Status Code: 401

{
    "error_code": "401",
    "error_message": "Authentication failed.",
    "error_source": "CLEARTAX"
}

API Validations

Currently there are no known validations for this API.

API Constraints

Record for the provided transaction id needs to be present in Clear database.