Integration Flow

Check Business

Functionality: This API checks if a business with a specified PAN already exists within the system. It's essential for avoiding duplicate registrations.
Flow: When a business attempts to onboard, this API is first called to ensure the PAN is unique. If the business is found ('EXISTING'), further action may depend on the business needs; if not found ('NEW'), the process proceeds to registration.

Use the below endpoint to Check Business.

POST: https://api.zwitch.io/v1/bharat-connect/onboarding/business/search

Below is a sample request and response for the Check Business API.

{
   "pan":"ABCTY1239H",
   "name_on_pan":"ZXC Tech",
   "pan_type": "COMPANY"
}

{
    "id":"bcbc_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business.check",
    "businesses": [
        {
            "status": "EXISTING", //EXISTING,NEW
            "name": "Business Name",
            "b2b_ids": [
                "zw_b2bid_1730970483a8b539acf65f1279026529",
                "zw_b2bid_1730970483a8b539acf65f1211232123"
            ],
            "bbps_business_object_id": "ORG1730970483a8b539acf65f3859174743",
            "ai_org_connection": "" //YES,NO
        }
    ]
}

Register Business

Functionality: Registers a new business by capturing comprehensive details such as name, contact info, KYC, and banking details. This API also helps in creation of a BBPS ID for the user.
Flow: Once the business passes the Check Business API, it can formally register to use Bharat Connect services, enabling it to transact over the BBPS network.
Use the below endpoint to Check Business.

POST: https://api.zwitch.io/v1/bharat-connect/onboarding/business/register

Below is a sample request and response for the Register Business API.

{
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "9888763451",
    "b2b_id": "",
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "KA",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "Rahul Reddy",
        "mcc_code": "4112",
        "business_type": "partnership",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ]
    },
    "documents": [
        {
            "type": "customer_photo",
            "id": "doc_69ec2a9d8dbaf5ea1bc"
        },
        {
            "id": "doc_Ix0xZ13phVqfcwwpvPmQi3122",
            "type": "shop_and_establishment_license",
            "reference_number": "910192182120",
            "date_of_issue": "2016-12-18"
        },
        {
            "type": "customer_signature",
            "id": "doc_9c4O9c5DJQ3lie3SADVAHWFDT"
        }
    ],
    "addresses": [
        {
            "type": "OTHER",
            "address": "sarjapur",
            "city": "Bengaluru",
            "postal_code": "560010",
            "state_code": "KA",
            "state": "KARNATAKA"
        }
    ],
    "bank_details": [
        {
            "vpa": "test@vpa",
            "account_type": "SAVINGS",
            "bank_account_number": "67334963307",
            "name_of_account_holder": "Rahul Reddy",
            "bank_ifsc_code": "SBIN0070305",
            "bank_name": "abcd"
        }
    ],
    "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
    }
}

{
    "id": "bhb_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business",
    "b2b_id": "zwch_4234233551",
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "9888763451",
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "KA",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "Rahul Reddy",
        "mcc_code": "4112",
        "business_type": "partnership",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ],
	  "status":""
    },
    "documents": [
        {
            "type": "customer_photo",
            "id": "doc_69ec2a9d8dbaf5ea1bc"
        },
        {
            "id": "doc_Ix0xZ13phVqfcwwpvPmQi3122",
            "type": "shop_and_establishment_license",
            "reference_number": "910192182120",
            "date_of_issue": "2016-12-18"
        },
        {
            "type": "customer_signature",
            "id": "doc_9c4O9c5DJQ3lie3SADVAHWFDT"
        }
    ],
    "addresses": [
        {
            "type": "OTHER",
            "address": "sarjapur",
            "city": "Bengaluru",
            "postal_code": "560010",
            "state_code": "KA",
            "state": "KARNATAKA"
        }
    ],
    "bank_details": [
        {
            "vpa": "test@vpa",
            "account_type": "SAVINGS",
            "bank_account_number": "67334963307",
            "name_of_account_holder": "Rahul Reddy",
            "bank_ifsc_code": "SBIN0070305",
            "bank_name": "abcd"
        }
    ],
    "status":"ACTIVE",
    "metadata": {
        "key_1": "DD",
        "key_2": "XOF"
    },
    "response": {
        "status": "", //get from bbps resp
        "message": ""
    }
}

Fetch Business Data

Functionality: Retrieves detailed information about a registered business, which is crucial for maintaining accurate records and facilitating transactions.
Flow: This API can be used anytime after registration to fetch or verify business details, ensuring all transactional information is up-to-date.

Use the below endpoint to Check Business.

POST: https://api.zwitch.io/v1/bharat-connect/onboarding/business/details

Below is a sample request and response for the Check Business API.

{
    "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
    "fetch_parameters": {
       "bbps_business_object_id": "ORG1731304320a8b539acf65f5629622526",
       "pan": "ABCTY3241X"
    }
}

{
    "id": "bcbd_k3pbaALyh1CmzTPTOToHywYey",
    "object": "bharat_connect.business.details",
    "name": "Business Name",
    "mobile_number": "9876543210",
    "email": "[email protected]",
    "phone": "",
    "bbps_business_id": "ORG1731304320a8b539acf65f5629622526",
    "b2b_id": "zwch_1731304320a8b539acf65f1337854926",
    "b2b_id_details": [
        {
            "b2b_id": "zwch_qwerty12341",
            "status": "ACTIVE",
            "private": true,
            "bank_account": null,
            "business_identifier": {
                "document_name": "GSTIN",
                "registered_name": "ZXC Tech",
                "value": "22AAAAA0001A3Z9"
            }
        },
        {
            "b2b_id": "zwch_1731414335a8b539acf65f0982718126",
            "status": "ACTIVE",
            "private": true,
            "bank_account": null,
            "business_identifier": {
                "document_name": "GSTIN",
                "registered_name": "ZXC Tech",
                "value": "22AAAAA0001A3Z9"
            }
        }
    ],
    "kyc": {
        "city": "Bangalore",
        "postal_code": "560005",
        "state_code": "",
        "pan": "ABCTY1239H",
        "company_name": "ZXC Tech",
        "contact_person": "",
        "mcc_code": "4112",
        "primary_business_identifier": {
            "type": "GST",
            "reference_number": "22AAAAA0000A1Y7",
            "registered_name": "ZXC Tech"
        },
        "other_business_identifiers": [
            {
                "type": "",
                "reference_number": "",
                "registered_name": ""
            }
        ]
    },
    "addresses": [
        {
            "address_line1": "sarjapur",
            "address_line2": "",
            "city": "Bengaluru",
            "country": "INDIA",
            "pincode": "560010",
            "state": "KARNATAKA",
            "type": "OTHER"
        }
    ],
    "bank_accounts": [
        {
            "ac_num": "67334963307",
            "beneficiary_name": "Rahul Reddy",
            "business_vpa": "test@vpa",
            "ifsc": "SBIN0070305",
            "type": "SAVINGS"
        }
    ],
    "response": {
        "status": "",
        "message": ""
    }
}