NameDescriptionTypeAdditional information
Id

GUID Id for Merchant. Assigned by system on Create. [REQUIRED]

globally unique identifier

None.

PlanId

GUID PlanId for Merchant. [NULL]

globally unique identifier

None.

StripeToken

The Stripe Token. Generated by Portal. Used for billing. [NULL]

string

None.

StripeCustomerId

The Stripe CustomerId. Generated by Portal. Used for billing [NULL]

string

None.

CompanyName

The name of the company. [NULL]

string

None.

UserId

The UserId for the Merchant. [NULL]

string

String length: inclusive between 0 and 128

Active

Indicates whether the Merchant account is active or not. [REQUIRED]

boolean

None.

Deleted

Indicates whether the Merchant has been deleted or not. Set to false on Create by system. Set to true on delete by system. [REQUIRED]

boolean

None.

TimeZone

Time zone of the Merchant. Example: "Central Standard Time" [NULL]

string

String length: inclusive between 0 and 50

User

Gets the User for the Merchant using UserId.

User

None.

Plan

Get the Plan for the Merchant using the PlanId.

Plan

None.

MerchantLocations

Collection of MerchantLocation

None.