Generate B2C Payment QR Code
You can generate a B2C QR code by sending a POST
request to B2C QR code API.
Request Method
POST
Request URL
{{HOST}}/einv/v1/b2c/generate-qr-code
Request Headers
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
Response Status Codes
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 authorized for the operation.
500
If there are any unhandled exceptions on the Clear side.
Response Schema
transaction_id
String
NA
Created by ClearTax. To be used in print/delete APIs.
qr_code
String
NA
QR code string in base 64 format. Value will be null in negative case scenario.
raw_qrCode
String
NA
Always be Null. Can be ignored.
error
List
NA
List of Error objects. Will be null in a successful API call.
Error Details Object
error_code
Number
NA
Specific code as per the error.
error_message
String
NA
Specific message as per the error.
error_source
String
CLEARTAX
Source of the error.
Sample Request and Response
Request
{
"transaction": {
"Version": "1.1",
"TranDtls": {
"TaxSch": "GST",
"SupTyp": "B2C",
"RegRev": "Y",
"EcmGstin": null,
"IgstOnIntra": "N"
},
"DocDtls": {
"Typ": "INV",
"No": "TESTB2C5",
"Dt": "09/05/2023"
},
"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": {
"Gstin": "",
"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",
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "Banagalore",
"Pin": 562160,
"Stcd": "29"
},
"ShipDtls": {
"Gstin": "",
"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.0,
"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",
"AccDet": null,
"Mode": "Cash",
"FinInsBr": null,
"PayTerm": null,
"PayInstr": null,
"CrTrn": null,
"DirDr": null,
"CrDay": null,
"PaidAmt": null,
"PaymtDue": null,
"PayeeUPI": "mehrotra@prakhar"
},
"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": "Abc001",
"Contrrefr": "Co123",
"Extrefr": "Yo456",
"Projrefr": "Doc-456",
"Porefr": "Doc-789",
"PoRefDt": "01/05/2023"
}
]
},
"ExpDtls": {
"ShipBNo": "A-248",
"ShipBDt": "01/05/2023",
"Port": "INABG1",
"RefClm": "N",
"ForCur": "AED",
"CntCode": "AE"
},
"custom_fields": {
"customfieldLable1": "CustomFieldValue1",
"customfieldLable2": "CustomFieldValue2",
"customfieldLable3": "CustomFieldValue3"
}
}
}
Response (Success)
HTTP Status Code: 200 OK
{
"transaction_id": "29AAFCD5862R000_TESTB2C5_INV_2023",
"qr_code": "iVBORw0KGgoAAAANSUhEUgAAAcIAAAHCAQAAAABUY/ToAAAG70lEQVR4Xu2bQY7qSBBEE7FgyRF8E7gYkpF8MbgJR+ilF4iceJFmZppuyaO/mUW6pKbbropaxM+MisziR/7huMXnm/86NuTa2JBrY0OujQ25Njbk2tiQa2NDro0NuTYW5C0iDq/j9IhdPofMr/Ghx2vkKy7DIXNiid7dv7Rw1xF5149ej4/U+uFwO055yK/LECfB9TEJxBJtWYv7Ib9iEJnPIeKYDyGvMUPhvBN8PrPHOa+DSL+E9+iJvGvBOw6fw3xS4CURKeT+4TiMc29k5jUqtATn0fBYEhIkVHdFJvkppHgcExkLQMpUCCZd57Pe/ZafTZAiMxx9qx9vqrshPchKlJ05/QXVsVNYittnQLAy9Z/VzZDidtD6K3oulnnEJ1TOegB/C1pHJKskT2POwQIcgxXMWyohZRv4a464RE/kMnexuQwtGB/BHgdPvABxABKMZSDaIVFxh5ZZhlttJE8V8K0PideNYHwdvbwh0jaTVZxzeE1vJJ9wTiXkTh+in/yE9HNLpN7IGMhSLkKVVHR2UvvEg5dX1+P4qWBdkEdzu08TVxmIZEnGVAfLl4cnyNSP/OyCvInW+URCwp7I5ChUugalirNyxjFoyeT1/ZBIFtw6DYMDsNQ+bQx2dQKMLF9Ybof0KpnLwTbz3Vly0XLBgyssT1gJBd9gQEMk9QpIRB04nsDdkglVm7ASSmGG1rVESrvjeA2fgiVoclLAlZ/eEm6DOMyuSAT8HzLN8pX8TIzBhHcoGdNuHZF/u4Ok+PdGQYFXFiFhdEGOdFAaIhONCuTJGo+gSa2wnqJVYemYm3Cinz6hD/JC3T/BLUeh27lpMvdmPmjiQqsPxYZImv7lNXe0KKE53RVA/K1bB3uHWz12RNKmRcrtDsKnYCmYJ6A1gg43sWlENySdkXKTZCAyRgNpUvSxGz7h3TcxvCMSjWd9nYJ2TTssgknnBLBZMLc9kXe3aV3CMUcWkpBLfvrRYamBnWqJzIfia6QssWu6stQFivkmcfEO1Lzf87ML8hV7SrhM3xTNtgj2n7ZYN9pLaBmG8+MU7IK8V0PAkjVxFGoPCdrDSZq2mcG+KF1bZC31TZstZWIM3Hbz+pIx029ENyQXauSnyl3FHAQTjPZUOg9puzldXb4oXRsiXeSWeNGdvNNZSk5BItKlHntwMn5qfBek9ZwDkFwsjfIVf+1xK3kXtzC/jGbISs2y33ubBfdNBltP2txsjm3ASnz/V2mCdM2Lm7RjcDD6AOQ8fFR+WsHM/LkjklOQ+ELUxwReu7m5jbxL97Ul3uEXn9ADibJT2p5sp7TK34X0tb+WUr5QyBCbBrRD1rUIbhKvmdR2OIaBnB0o5mQWIFiST/Y2RGr9YHlfOv8UeK5vT4SbtQwFw0k1RXIKVgbSolQcjgSZl2riheGE/mDiu8Z3QdoTULhhFuAxkyYBORvcr13ss9LfM/7U+DbIirlcrFNAq/bAO2iPJT/nYPREwijuQBpvPX96wYOjcDDzB5g/eF2dkd2QeCWHYNZ5yKVJnXjP8k/Bd5CCiU+f0ANZFOq3G3BQSMwlWvaeUGya9A9uuyBf2Ez6t5hL6tvKz6gJmai0G3d6Hnoi9Ua/plyIY6mRt1oqtfduP51UF6SiL6RREnqdcwSZrBMRWSUcpHOPNOATiMOGSPew75huSjjBx3JNMzUMJ2PNMvGmvyHSpYojTVk52VPRRrHrnJi9LK6zJZLXysB9HYC2lAeMOPUKLe1puUIC9MODtUA6P/GVs9sAfBBzqJXfWdoUfeTnMpohJVSOuX9lZRV4pKu1TBJvi8VsR2RyLeIMtIwpKwm3JyEoS36neUKV90t+dkHSVEpMwEzD1h0A75GWNix5UPiaVkjviAzyc+KFgowit2zmOfEJFnqkjbCMb9HXBXlzP+ltJOE2nalJfrpP6YqOzX9kdg+kM1C0PuoAhGBiTpNfJfSVn4Sg+e6IdPWGZNlTWdB4dwe5M1K7ZYlXRyTRJ1FHz30HgHjZZgL3VwGQd9crvGuIlImSfwqas9y5nclPdCvwnx7OSvkE79sQeafFdsc6oVF6GySk3i3KHoM1XpvHz/xsgay/CcE4mkdl6s2dJRsIXwSgYEx8vwPoghSZgdc0d/4L66Rh8bphGzgKa4I4bIck5Tj2qpVUwUg7cqntmOWMRPfrsR/SdwCE1gluoXrGHfC/GyF4SlcuC/NtkapNbCQfenENKroh/SUIDKdZDvb9hds2SO5jdxZ1TLdd552NaBd4N2/eFKkfr5JGjWj81aL+cCuumtuuV+6/+IQeSBLS4iUTQFknuMxlEH1LuqJvzt7fTocGyD8YG3JtbMi1sSHXxoZcGxtybWzItbEh18aGXBv/C/IvesN+XciFDysAAAAASUVORK5CYII=",
"raw_qrCode": null,
"error": null
}
Response (Failure)
HTTP Status Code: 200 OK
{
"transaction_id": "29AAFCD5862R000_WARB2C6_INV_2023",
"qr_code": null,
"raw_qrCode": null,
"error": {
"errors": [
{
"error_code": "107",
"error_message": "null : UPI Id can not be left blank",
"error_source": "CLEARTAX"
}
]
}
}
API Validations
Currently there are no known validations for this API.
API Constraints
Payee UPI Id is mandatory to generate B2C QR Code.
Last updated
Was this helpful?