Onboarding Status Model
Onboarding Status Model
This model is referenced in the response of #onboarding-status
uid
string
example: 52c8e55d-26dc-4935-9214-e3fccf6c8bcf The ID of the created onboarding
message
string
example: Merchant with this license id already exist
The error message in case the onboarding process failed
status
string
example: Approved
The status of the onboarding process, can be "Approved", "Failed", "Pending"
merchant
object
The merchant details in case the onboarding process succeeds (status is "Approved")
merchant.merchant_info
object
The merchant information inserted on the onboarding creation request
merchant.merchant_info.category
string
The merchant's category
merchant.merchant_info.city
string
The merchant's city
merchant.merchant_info.country
string
The merchant's country
merchant.merchant_info.email
string
The merchant's email
merchant.merchant_info.house_number
number
The merchant's house number
merchant.merchant_info.phone_number
string
The merchant's phone number
merchant.merchant_info.social_id
string
The merchant's EIN
merchant.merchant_info.name
string
The merchant's name
merchant.merchant_info.state
string
The merchant's state
merchant.merchant_info.street
string
The merchant's street
merchant.merchant_info.website
string
The merchant's website
merchant.merchant_info.locale
string
The merchant's locale (default is USA if nothing was filled)
merchant.merchant_owner_info
object
The merchant's owner information inserted on the onboarding creation request
merchant.merchant_owner_info.email
string
The merchant's owner's email
merchant.merchant_owner_info.name
string
The merchant's owner's name
merchant.merchant_owner_info.phone_number
string
The merchant's owner's phone number
merchant.merchant_owner_info.social_id
string
The merchant's owner's social id
merchant.active
boolean
If the merchant is active or not (true/false)
merchant.verified
boolean
If the merchant is verified or not (true/false)
merchant.status
object
The merchant's status object
merchant.status.uid
string
The merchant's status uinque identifier
merchant.status.name
string
The merchant's status name
merchant.uid
string
The merchant's uinque identifier
merchant.created
string
The merchant's created date
merchant.displayName
string
The merchant's display name (title)
merchant.logo
string
The merchant's logo
merchant.locations
array of objects
The merchant's locations (stores) array
merchant.locations.active
boolean
If the merchant's location is active or not (true/false)
merchant.locations.verified
boolean
If the merchant's location is verified or not (true/false)
merchant.locations.uid
string
If the merchant's location unique identifer
merchant.locations.created
string
If the merchant's location created date
merchant.locations.dispaly_name
string
If the merchant's location display name (title)
merchant.locations.number
string
If the merchant's location number
merchant.locations.apiKey
string
If the merchant's location api key
Last updated