Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
uid
string
example: 52c8e55d-26dc-4935-9214-e3fccf6c8bcf The ID of the onboarding created
url
string
example: https://partner.sandbox.sensepass.com/partnersOnBoarding/52c8e55d-26dc-4935-9214-e3fccf6c8bcf
The URL to the onboarding IFrame
status
string
example: Pending
The status of the onboarding process
API for retrieving the current status of a given onboarding.
GET
/api/partners/onboarding/{onboarding_uid}
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
See Onboarding Status entity schema: # Onboarding-status-entity
Full Onboarding Status Entity schema: # Onboarding-status-entity
This page describes the Iframe of the onboarding for partners
Once you get the onboarding URL from the initiate endpoint (see API section) you can use it in the src property of an iframe HTML tag, for example:
In the Pending status (if the onboarding process has not been yet started), the merchant will see the following screen:
After checking the terms and conditions checkbox and pressing the Next button any of the following can occur:
The process was completed successfully: The merchant can now access SensePass merchant portal using the credentials he can copy NOTICE: After pressing the Close button a SUCCESS message will be posted to the parent window of the iframe, the message will be as follow: { type: 'SUCCESS', message: 'On Boarding completed successfully', uid: 'c4c1c291-9a18-45bc-9199-76ffcd1b70e2' } After refreshing the screen:
The process failed, for example, the merchant already existed: In addition, after pressing the Close button an ERROR message will be posted to the parent window of the iframe, the message will be as follow: { type: 'ERROR', message: 'Merchant with this license id already exist', uid: 'c4c1c291-9a18-45bc-9199-76ffcd1b70e2' }
See our Partner API documentation here:
onboarding_uid*
String
Onboarding unique identifier
Authorization
String
Auth token from auth/token API
API for getting onboarding configuration pages for the merchant, this API creates Onboarding Page Model
POST
/api/partners/onboarding/pages/:merchant_uid
This API creates new onboarding request based on the fields below.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
See Onboarding entity schema: # onboarding-entity
Basic request example to get onboarding pages:
merchant_uid*
String
The merchant unique identifier (uid) which you can get after on boarding process is completed successfully by usin on boarding status API
Authorization*
String
Auth token from auth/token API
sessionTimeoutMinutes
number
The number of minutes the session will be valid for the merchant to use
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 |
API for creating new onboarding requests, this API creates
POST
/api/partners/onboarding/v1
This API creates new onboarding request based on the fields below.
Name | Type | Description |
---|
Name | Type | Description |
---|
See Onboarding entity schema: # onboarding-entity
Basic request example to create a new onboarding process.
Full Onboarding Entity schema:
Authorization* | String | Auth token from auth/token API |
name* | string | The business name of the merchant that will be created |
house_number* | number | The house number of the merchant that will be created |
street* | string | The street of the merchant that will be created |
title* | string | The display name of the merchant that will be created |
phone* | string | The phonse number of the merchant that will be created |
country* | string | The countrty of the merchant that will be created |
city* | string | The city of the merchant that will be created |
logo | string | The logo of the merchant that will be created |
website | string | The website of the merchant that will be created |
owner.first_name* | string | The first name of the merchant's owner |
owner.last_name* | string | The last name of the merchant's owner |
email* | string | The email address of the merchant that will be created |
locale | string | The locale of the merchant that will be created, can be one of the following: IL, Russia, Canada, USA |
state | string | The state of the merchant that will be created |
category* | string | The business category of the merchant that will be created |
owner.phone* | string | The phone number of the merchant's owner |
owner.email* | string | The email address of the merchant's owner |
owner.locale | string | The locale of the merchant's owner, can be one of the following: IL, Russia, Canada, USA, USD - PST |
locations* | array of objects | An array of the merchant's locations (stores) example: [{ "name": "store1" }] |
locations.name* | String | The name of the merchant's location (store) |
EIN* | string | The Employer Identification Number of the merchant that will be created |
locations.number | String | The number of the merchant's location (store), the default, if no value is provided, is 1 |
locations.logo | String | The logo of the merchant's location (store) |
owner* | object |