Financial Services · Lead generation

Create Lead

Create a product application lead

POST request

URL: https://api.payorbit.in/api/v1/leads

Body

{
    "product_id": "12345",
    "category_id": 3,
    "customer_id": "aUczK1BLZm1lRmtSNEZ6SGJTaHl0QT09",
    "required_amount": 50000
}

Include a valid Bearer token with every request

Code sample

curl -X POST "https://api.vizodigital.com/api/v1/leads" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "product_id": "12345",
    "category_id": 3,
    "required_amount": 50000,
    "customer_id": "aUczK1BLZm1lRmtSNEZ6SGJTaHl0QT09"
}'

Success Response

{
    "fee": 0,
    "data": {
        "lead_code": "BS-LEAD-987654",
        "campaign_url": "https://apply.example.test/campaign/xyz789"
    },
    "status": "success",
    "message": "Lead created",
    "wallet_balance": 1000
}

Failure response

{
    "status": "error",
    "message": "Request failed. Check credentials, wallet balance, or validation errors."
}

Overview

Creates a lead for a product from Products by Category. Returns a lead_code and campaign_url.

Call Create / Update Customer Profile first and pass the returned customer_id here. If customer_id is omitted, the portal default customer id from Settings is used.

UAT vs Production

UAT tokens return a sample response. No provider call, fee = 0.
Production tokens create a live lead. Create Lead is not billed (fee = 0).

Access & billing (Production)

Admin must enable Lead generation (lead_generation) and set the per-lead fee.
Categories, products, details, profile, and create lead are included (fee = 0).
The per-lead fee is charged on Lead Status the first time the status becomes approved.
Provider credentials (API key, IV) are applied server-side.

product_id is required. customer_id, category_id, and required_amount are optional (required_amount is used for loans).

Authenticate with a Bearer token.

Body

application/json required

Create lead request body

Schema

{
    "type": "object",
    "required": [
        "product_id"
    ],
    "properties": {
        "product_id": {
            "type": "string",
            "description": "Product id from Products by Category"
        },
        "category_id": {
            "type": "integer",
            "description": "Optional category id"
        },
        "customer_id": {
            "type": "string",
            "description": "Encrypted customer id from Create / Update Customer Profile"
        },
        "required_amount": {
            "type": "number",
            "description": "Optional amount, e.g. for loans"
        }
    }
}

Example

{
    "product_id": "12345",
    "category_id": 3,
    "customer_id": "aUczK1BLZm1lRmtSNEZ6SGJTaHl0QT09",
    "required_amount": 50000
}

Responses

200 · application/json default

Successful response

Example

{
    "fee": 0,
    "data": {
        "lead_code": "BS-LEAD-987654",
        "campaign_url": "https://apply.example.test/campaign/xyz789"
    },
    "status": "success",
    "message": "Lead created",
    "wallet_balance": 1000
}

Rate Limits

60/min