Uplift Initialization Configurations
- 17 Oct 2024
- 1 Minute to read
- DarkLight
Uplift Initialization Configurations
- Updated on 17 Oct 2024
- 1 Minute to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Uplift Web API Integration (Payments)
Note: This is exclusive to the Uplift Web API Integration (Payments) product. Please contact your account manager for more information on this product.
Uplift’s Payment library is initialized by using the window.Uplift.Payments.init(initConfig) which takes a parameter initConfig in the form of key-value pairs. Details regarding each key, their value type, allowed values and description is provided below.
| Key | Value Type | Allowed Values | Description |
|---|---|---|---|
| locale | String |
| IETF language tag (first 2 letters are language code, last 2 refer to country code) |
| currency | String |
| 3-letter currency code |
| checkout | Boolean | Any | Type of page (true = payment page; false = non-payment page) |
| channel | String |
| Attribute to distinguish the path that is used to complete the transaction |
| container (required for payment pages) | String | Any, Example: "#up-pay-monthly-container" | CSS selector of DOM container for Uplift Pay Monthly iFrame, exclusive to payment page Refer to the Pay Monthly Selector information |
| onChange (required for payment pages) | Function Name | Any, Example: myOnChangeCallback | Callback handler, exclusive to payment page Refer to callback handler information |
Uplift Agent Connect
Note: This is exclusive to the Uplift Agent Connect product. Please contact your account manager for more information on this product.
Uplift’s Agent Connect library is initialized by using the window.Uplift.Agent.init(initConfig) which takes a parameter initConfig in the form of key-value pairs. Details regarding each key, their value type, allowed values and description is provided below.
| Key | Value Type | Allowed Values | Description |
|---|---|---|---|
| agent | AgentObject | AgentObject | Information relating to the current agent |
| locale | String |
| IETF language tag (first 2 letters are language code, last 2 refer to country code) |
| currency | String |
| 3-letter currency code |
| checkout | Boolean | True | Type of page (payment page = true;) |
| payMonthlyContainer | String | Any Example: "#up-pay-monthly-container" | CSS selector of DOM container for Uplift Pay Monthly iFrame Refer to the Pay Monthly Selector information |
| onChange | Function Name | Any Example: myOnChangeCallback | Callback handler for the different payment page status Refer to callback handler information |
AgentObject
| Key | Value Type | Allowed Values | Description |
|---|---|---|---|
| id | String | Any | Agent's unique identifier |
| agencyId | String | Any | Agent's agency's unique identifier |
| String | Email format (domain) | Agent's email | |
| firstName | String | Any | Agent's first name |
| familyName | String | Any | Agent's family name |
| phoneNumber | String | Only numerical, no special characters | Agent's phone number |
Example:
{
"id": "identifier",
"agencyId": "agency-identifier",
"email": "arthur@uplift.com",
"firstName": "Arthur",
"familyName": "Davis",
"phoneNumber": "0000000000"
}Was this article helpful?