Get B2C Transaction

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

Request Method

GET

Request URL

{{HOST}}/einv/v1/b2c

Request Headers

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

Request Path Params

There are no path parameters for this API.

Request Query Params

Parameter	Data Type	Field Validations	Description
transaction_ids	String	NA	Mandatory. Unique transaction ID that you get from Generate Payment QR Code API.

Request Body

There is no request body for this API.

Response Status Codes

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

Parameter	Data Type	Field Validations	Description
transaction_id	String	NA	Transaction id received in response from Generate B2C QR Code API.
qrcode_status	Status	GENERATED	Status of B2C QR Code
qrcode	String	NA	QR Code String

Sample Request and Response

Request

NA

Response (Success)

HTTP Status Code: 200 OK

[
    {
        "owner_id": null,
        "tag_identifier": null,
        "gstin": "29AAFCD5862R000",
        "group_id": null,
        "transaction_id": "29AAFCD5862R000_B2CTest2_INV_2025",
        "custom_fields": null,
        "is_deleted": false,
        "transaction": {
            "Version": "1.1",
            "DocDtls": {
                "Dt": "24/06/2025",
                "No": "B2CTest2",
                "Typ": "INV"
            },
            "TranDtls": {
                "TaxSch": "GST",
                "RegRev": "Y",
                "SupTyp": "B2C",
                "IgstOnIntra": "N"
            },
            "SellerDtls": {
                "Gstin": "29AAFCD5862R000",
                "LglNm": "NIC company pvt ltd",
                "TrdNm": "NIC Industries",
                "Addr1": "5th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "GANDHINAGAR",
                "Pin": 560037,
                "Stcd": "29",
                "Ph": "9000000000",
                "Em": "[email protected]"
            },
            "BuyerDtls": {
                "LglNm": "XYZ company pvt ltd",
                "TrdNm": "XYZ Industries",
                "Pos": "12",
                "Addr1": "7th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "GANDHINAGAR",
                "Pin": 562160,
                "Stcd": "29",
                "Ph": "91111111111",
                "Em": "[email protected]"
            },
            "DispDtls": {
                "Nm": "ABC company pvt ltd",
                "Loc": "Banagalore",
                "Pin": "562160",
                "Stcd": "29"
            },
            "ShipDtls": {
                "LglNm": "CBE company pvt ltd",
                "TrdNm": "kuvempu layout",
                "Addr1": "7th block, kuvempu layout",
                "Addr2": "kuvempu layout",
                "Loc": "Banagalore",
                "Pin": "562160",
                "Stcd": "29"
            },
            "ItemList": [
                {
                    "SlNo": "1",
                    "PrdDesc": "Rice",
                    "IsServc": "N",
                    "HsnCd": "10019920",
                    "Barcde": "123456",
                    "Qty": 100.345,
                    "FreeQty": 10,
                    "Unit": "BAG",
                    "UnitPrice": 99.545,
                    "TotAmt": 9988.84,
                    "Discount": 10,
                    "PreTaxVal": 1,
                    "AssAmt": 9978.84,
                    "GstRt": 12,
                    "IgstAmt": 1197.46,
                    "CgstAmt": 0,
                    "SgstAmt": 0,
                    "CesRt": 5,
                    "CesAmt": 498.94,
                    "CesNonAdvlAmt": 10,
                    "StateCesRt": 12,
                    "StateCesAmt": 1197.46,
                    "StateCesNonAdvlAmt": 5,
                    "OthChrg": 10,
                    "TotItemVal": 12897.7,
                    "OrdLineRef": "3256",
                    "OrgCntry": "AG",
                    "PrdSlNo": "12345",
                    "BchDtls": {
                        "Nm": "123456",
                        "ExpDt": "05/05/2023",
                        "WrDt": "05/05/2023"
                    },
                    "AttribDtls": [
                        {
                            "Nm": "Rice",
                            "Val": "10000"
                        }
                    ]
                }
            ],
            "ValDtls": {
                "AssVal": 9978.84,
                "CgstVal": 0,
                "SgstVal": 0,
                "IgstVal": 1197.46,
                "CesVal": 508.94,
                "StCesVal": 1202.46,
                "Discount": 10,
                "OthChrg": 20,
                "RndOffAmt": 0.3,
                "TotInvVal": 12908,
                "TotInvValFc": 12897.7
            },
            "PayDtls": {
                "Nm": "ABCDE",
                "Mode": "Cash",
                "PayeeUPI": "gfdgwg@ff"
            },
            "RefDtls": {
                "InvRm": "TEST",
                "DocPerdDtls": {
                    "InvStDt": "01/05/2023",
                    "InvEndDt": "05/05/2023"
                },
                "PrecDocDtls": [
                    {
                        "InvNo": "DOC/002",
                        "InvDt": "01/05/2023",
                        "OthRefNo": "123456"
                    }
                ],
                "ContrDtls": [
                    {
                        "RecAdvRefr": "Doc/003",
                        "RecAdvDt": "01/05/2023",
                        "TendRefr": null,
                        "ContrRefr": null,
                        "ExtRefr": null,
                        "ProjRefr": null,
                        "PORefr": null,
                        "PORefDt": null
                    }
                ]
            },
            "ExpDtls": {
                "ShipBNo": "A-248",
                "ShipBDt": "01/05/2023",
                "Port": "INABG1",
                "RefClm": "N",
                "ForCur": "AED",
                "CntCode": "AE"
            }
        },
        "qrcode_status": "GENERATED",
        "qrcode": "iVBORw0KGgoAAAANSUhEUgAAAcIAAAHCAQAAAABUY/ToAAAHBElEQVR4Xu2aQYrrSBBEy3ihpY+gm9gXM7hBF5NvoiN4qYVwTrxI9QxWN2j4m2FIFbSQVRW1CDKjIrO6xR+OsW2//NtxIPfGgdwbB3JvHMi9cSD3xoHcGwdybxzIvbEix9ZaF697697tEXo7R7vFVz+fXuvPuTHxfGnhqSLyqT99vrcYL198GqZ4N230jCH0dp60UbDHIxfXQ75a370vwzRfeZyE1NIhZgjW29L7LUx/XaRCsFeQ3RVgItjRR+BN8837trv2qI0k5kRrTMEe3XiBWy1tJKm+PULpWhYZ5GeSiVDF0mA0Cda+yk+DfsnPIkiR2VCwfvfRfjsdfqz67fH/Rq7jC6FaenNL9IlRuB2Vmqgagvb3KIYUtz3xRfS1dVylZfOVt5N8QnLLbiu8GDKwA1DYIVTNp+D1orNPcOWnZgXKn9+AYkg+W61muNSCcwq9zYKdlKJvcQq3jYIVQfJFJkpv78uiTw43M4oH9x7slktqIkWrvCbi9XpM1Cb2T8myHtgG9tApiKoVRI5eCplwC62TjZUCr63eYfWaZ6+vhwySj3qlc2hR+KLxHIoxCeT1C1Q3BK0gclTezQi4Yk6gJiPuQ9FdgUD8Mz/hFsNeDxmu6C5yTZRwqH3r0liRroAyLFfdL4h0t0QEyx3YJ6Dx4V5AlnoB33p4o5LIlHeEnuRzpClJKXepg82tU9in5Uf0VUHq7KPkbzhv9DzNwgNGF5KUxJWWzRD8yW0VpEQd9gbkabBtcEOA9Xpclbh5FNJ7+9T4KsjsIhF92X98ucO99CL4niA7hhS0W02k8hOvNLOeDJysapyHk3Uf+ISgbfKzCjI4/+010ah03hBMQoJ09toiOEALIkf0vFnUxZ7tgLNSj4VvZ8o6b7nltgqSDjcP1CromxCMBB4R6XpPVZ7gNOU2tWARJK6Jz6lWzUa8AcJwitEzdbCZvzt7ayLDoXVDvLzHkzc7dLi1B4d0L6mHTF/pyxDii2EjblH3BO7Km3vLekjy0yZAvnzAYYpMBxlb+gRYkT4UKyJHSzmVLjKmcNNhB1w8DvRN/C3dOLFZEPmm5uWLIo07N75Rw3jLIHtpu1ERcxZUROLGcQKEoBZAIb6caxHWM0s/TtzqrShSyRcIOH0TYi7rFW1EuUvzBMdgO7XxYEWQogsVV/S5/d8UczQJOPu05Zu+ydPiTw1TE5nl2oNMtUZ9QabC7YZumeW8ZRL4Mz/rIH3+O/qsYOvVpJei9o3zsNfy8yY/6yDPk+yABXzxUvnyoM+m/Mzbo7evSl5cBJRE6s92QMO5SDFHLl7dUNGbJZ+JTVegCnK8uKpdQzDzk5NxXq1T+iwk/6dPqIF0aQt7dlL+0OibdFzZ2kQFLSfBB5gviLQ8PUG6b4Jkdey25ieCZjtFvfJ5ClZBWrsVgtlZCow4SOCL49A9pszemkh7AoUW7//wyDxksttMMErj5TVvJZHoOampSIv137KQdyTLjIZb30yQpAWRtggic1JqLrRMlszKb+/w5VnodwlcEPkkDVmwVnRoGf1bDsX+u45bqGHuWzdeBIlPCCw50Rc2C2zUaDStE9c04vBdEfler4smP/BUfP8+Be0O6DF5ovvgtgqS1AyKFreXNO1TEMnPYviMd6Azh03PUQxpY0AIOjX9ZneVjZLVHZj+x8ZrVkFCYbj9f8p+P0nKbhgIZ+rMDQEP5K4g0vl5IyFPPGjAUQL3a/Q55gBhOLdOqgaS1LQTCNykSri7izl+CokJ9T2SWHZjtyByhMzRhlNeE25RK9e8Djwpe+AdiM11FEMGvYAx1w8mc6JlYtKZtok600bZdpaqIEfpOLolAc+jUAWeGBW3OCkak0Sflig/Nz6hCtI2SQ/eWC84jLJlD9+IF/A0nAWRqNValnAeAici+6DS9YWkz0P3B0jhekg4c96ZPan4AIXDZIeJY3DzBJ+wvQOogpRXomajoKWqFXya/ZNT0MHoZTPly2f0lUHCmbiFTNHq9VnfprlUzr7l0J2pPx1GBaSbkPinRgMuqFfgliaBZOy99m973wZsTsEiSDoAotC0plpRAlvBznAr3aLlRPRh2Asiia9GDxs3KY3X2RfUKzPX245IjYV2QbMdrYdM+MueINu0Mgt2nUmwHpyMml2+AcWQIrN1PLTAPaa7qxRxi7FyNfNMS36nrCuI5AcqLriRtpmYc3Qr6KA4Px2lXlwPKR47N5DaOjI/Oyx5o/oNVM0TGwWrhVz4TJAlt/xHVkPjzS356SrvN25rIHEHOec2N17TPsGFDCxjp2zTKyL1R2oGTsp9bfRcdqpl2xKWDdLsL5ldADkq8TI/b3pYvBpvnYth7FTGpmxDHpTlkH8wDuTeOJB740DujQO5Nw7k3jiQe+NA7o0DuTf+E+RflGhKvkKf2tgAAAAASUVORK5CYII=",
        "raw_qrcode": null,
        "error_response": null,
        "upi_id": null,
        "b2c_response": {
            "Success": "Y"
        },
        "updated_at": null,
        "generated_on": null,
        "deleted": false
    }
]

Response (Failure)

HTTP Status Code: 200 OK

If there are no records in the applied filter -

[
    {
        "owner_id": null,
        "tag_identifier": null,
        "gstin": null,
        "group_id": null,
        "transaction_id": null,
        "custom_fields": null,
        "is_deleted": false,
        "transaction": null,
        "qrcode_status": null,
        "qrcode": null,
        "raw_qrcode": null,
        "error_response": null,
        "upi_id": null,
        "b2c_response": null,
        "updated_at": null,
        "generated_on": null,
        "deleted": false
    }
]

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.