PayOrbit
Sign in

Financial Services · Lead generation

Lead Status

Check the status of a lead

GET request

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

Body

{
    "lead_code": "BS-LEAD-987654"
}

Include a valid Bearer token with every request

Code sample

curl -X GET "https://api.vizodigital.com/api/v1/leads/status?lead_code=BS-LEAD-987654" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Success Response

{
    "fee": 0.1,
    "data": {
        "lead_code": "BS-LEAD-987654",
        "lead_status": "approved"
    },
    "status": "success",
    "message": "Lead status fetched",
    "wallet_balance": 999.9
}

Failure response

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

Overview

Returns the current status for a lead_code from Create Lead.

Possible lead_status values

  • pending
  • submitted
  • success
  • approved
  • failed
  • rejected

Access & billing

  • Admin must enable Lead generation (lead_generation) and set the per-lead fee.
  • pending, submitted, failed, and rejected are not billed (fee = 0).
  • When lead_status is new compared with the last stored value and is approved, the per-lead fee is charged once.
  • Hitting this API again while the status is still approved does not charge again.

Authenticate with a Bearer token.

Parameters

  • lead_code · query · string required

    Lead code returned by Create Lead.

    Example: BS-LEAD-987654

Responses

  • 200 · application/json default

    Successful response

    Example

    {
        "fee": 0.1,
        "data": {
            "lead_code": "BS-LEAD-987654",
            "lead_status": "approved"
        },
        "status": "success",
        "message": "Lead status fetched",
        "wallet_balance": 999.9
    }

Rate Limits

60/min