Investor Journey

Create investor journey. Platform merchant JWT required.

Operations

Create investor journey

Request

Creates an investor portal URL for the given email, PAN, and scheme. Requires a platform merchant JWT.

Security

JWT

Bodyapplication/jsonrequired

emailstring, (email)required

The investor's email address. Surrounding whitespace is removed and the address is lower-cased before it is checked. The part before @ can be at most 64 characters, with no leading, trailing or consecutive dots; the domain must contain a dot and end in a top-level domain of 2–63 letters; and the whole address can be at most 254 characters. An invalid address returns 400.

Example:"investor@example.com"

panstring^[A-Z]{3}P[A-Z][0-9]{4}[A-Z]$required

The investor's PAN: five letters, four digits and a final letter, where the fourth letter must be P. Surrounding whitespace is removed before the check. An invalid PAN returns 400.

Example:"ABCPD1234E"

scheme_nostringrequired

Example:"HGEMR"

curl -i -X POST \
  https://api.glomopay.com/api/v1/investor-journey \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "investor@example.com",
    "pan": "ABCPD1234E",
    "scheme_no": "HGEMR"
  }'

Responses

Success

Bodyapplication/json

urlstring, (uri)required

The investor portal URL to send the investor to. The journey details travel encrypted in the URL fragment (#payload=…), so pass the URL on unchanged.

Example:"https://investor-portal.glomopay.com#payload=..."

Response

{
  "url": "https://investor-portal.glomopay.com#payload=..."
}