Agents!

agent objects represent branches, employees or contractors of your company. Agents can use our web forms to create sources and the source contains the agent's identifier. Agents are created by you in the dashboard, or by sending us a bulk CSV for import at the back end (contact LotusPay Support for the template). The API allows you to retrieve your agents. You can retrieve individual agents as well as a list of all agents.

The agent object

ATTRIBUTES

Scroll inside to view more
Attribute
Description
id string
Unique identifier for the object.
object string, value is "agent"
String representing the object's type. Objects of the same type share the same value.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
code string
Unique code used by the agent to submit the LotusPay agent web form for souce creation. code is set by you as either email, or identification or mobile, depending on the convention you choose as a company.
email string
Email address of the agent.
identification string
Branch ID or employee ID of the agent.
mobile string
Mobile phone number of the agent.
name string
Name of the agent.
status string
The status of the agent, one of active or inactive.
Last updated 1 year ago