maas-schemas

customer Schema

http://maasglobal.com/maas-backend/customers/customer.json

MaaS customer schema

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	No	Develop	No	Forbidden	Forbidden	maas-backend/customers/customer.json

Schema Hierarchy

• customer http://maasglobal.com/maas-backend/customers/customer.json
  • units http://maasglobal.com/core/components/units.json
  • personalData http://maasglobal.com/maas-backend/customers/personalData.json
  • region http://maasglobal.com/core/region.json

customer Properties

Property	Type	Required	Nullable	Defined by
authorizations	authorization	Required	No	customer (this schema)
balances	fare	Required	No	customer (this schema)
favoriteLocations	object[]	Optional	No	customer (this schema)
identityId	complex	Optional	No	customer (this schema)
paymentSources	paymentSource	Required	No	customer (this schema)
personalData	personalData	Required	No	customer (this schema)
personalDocumentConsents	agencyId	Optional	No	customer (this schema)
personalDocuments	object[]	Optional	No	customer (this schema)
profileImageUrl	string	Optional	No	customer (this schema)
region	region	Required	No	customer (this schema)

authorizations

authorizations

• is required
• type: authorization
• defined in this schema

authorizations Type

Array type: authorization

All items must be of the type:

• authorization – http://maasglobal.com/core/components/authorization.json

balances

balances

• is required
• type: fare
• defined in this schema

balances Type

Array type: fare

All items must be of the type:

• fare – http://maasglobal.com/core/components/fare.json

favoriteLocations

favoriteLocations

• is optional
• type: object[]
• defined in this schema

favoriteLocations Type

Array type: object[]

All items must be of the type: object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

identityId

identityId

• is optional
• type: complex
• defined in this schema

identityId Type

Any following options needs to be fulfilled.

Option 1

string

All instances must conform to this regular expression

^[aepus]{2}-[\w]{4}-\d:[a-f\d]{8}(-[a-f\d]{4}){3}-[a-f\d]{12}$

• test example: eu-west-1:4828507e-683f-41bf-9d87-689808fbf958

Option 2

string

All instances must conform to this regular expression

^[A-Fa-f0-9]{8}(-[A-Fa-f0-9]{4}){3}-[A-Fa-f0-9]{12}$

• test example: 4828507e-683f-41bf-9d87-689808fbf958

identityId Examples

"eu-west-1:4828507e-683f-41bf-9d87-689808fbf958"

"4828507e-683f-41bf-9d87-689808fbf958"

paymentSources

paymentSources

• is required
• type: paymentSource
• defined in this schema

paymentSources Type

Array type: paymentSource

All items must be of the type: object with following properties:

Property	Type	Required
alias		Optional
billingCountry		Optional
billingZip		Optional
cardNumbers	string	Optional
expiryMonth	number	Optional
expiryYear	number	Optional
gatewayName		Required
isDefault	boolean	Required
isValid	boolean	Optional
issuer	string	Optional
paymentSourceId		Required
setupIntentId		Optional
status		Required
type		Required

alias

alias

• is optional
• type: alias

alias Type

• alias – #/definitions/alias

billingCountry

billingCountry

• is optional
• type: country

billingCountry Type

• country – http://maasglobal.com/core/components/station.json#/definitions/country

billingZip

billingZip

• is optional
• type: zipCode

billingZip Type

• zipCode – http://maasglobal.com/core/components/address.json#/definitions/zipCode

cardNumbers

cardNumbers

• is optional
• type: string

cardNumbers Type

string

• minimum length: 10 characters

expiryMonth

expiryMonth

• is optional
• type: number

expiryMonth Type

number

• minimum value: 1
• maximum value: 12
• must be a multiple of 1

expiryYear

expiryYear

• is optional
• type: number

expiryYear Type

number

• minimum value: 2018
• must be a multiple of 1

gatewayName

gatewayName

• is required
• type: gatewayName

gatewayName Type

• gatewayName – #/definitions/gatewayName

isDefault

isDefault

• is required
• type: boolean

isDefault Type

boolean

isValid

isValid

• is optional
• type: boolean

isValid Type

boolean

issuer

issuer

• is optional
• type: string

issuer Type

string

• minimum length: 2 characters

paymentSourceId

paymentSourceId

• is required
• type: paymentSourceId

paymentSourceId Type

• paymentSourceId – #/definitions/paymentSourceId

setupIntentId

setupIntentId

• is optional
• type: setupIntentId

setupIntentId Type

• setupIntentId – #/definitions/setupIntentId

status

status

• is required
• type: status

status Type

• status – #/definitions/status

type

type

• is required
• type: type

type Type

• type – #/definitions/type

Payment source

personalData

personalData

• is required
• type: personalData
• defined in this schema

personalData Type

• personalData – http://maasglobal.com/maas-backend/customers/personalData.json

personalDocumentConsents

personalDocumentConsents

• is optional
• type: agencyId
• defined in this schema

personalDocumentConsents Type

Array type: agencyId

All items must be of the type: string

• minimum length: 2 characters
• maximum length: 64 characters

personalDocuments

personalDocuments

• is optional
• type: object[]
• defined in this schema

personalDocuments Type

Array type: object[]

All items must be of the type: object with following properties:

Property	Type	Required
status		Required
type		Required

status

status

• is required
• type: documentStatus

status Type

• documentStatus – http://maasglobal.com/core/personal-document.json#/definitions/documentStatus

type

type

• is required
• type: documentType

type Type

• documentType – http://maasglobal.com/core/personal-document.json#/definitions/documentType

profileImageUrl

profileImageUrl

• is optional
• type: string
• defined in this schema

profileImageUrl Type

string

• minimum length: 10 characters
• maximum length: 1024 characters

region

region

• is required
• type: region
• defined in this schema

region Type

• region – http://maasglobal.com/core/region.json

This site is open source. Improve this page.