{ "token" : { "clientId" : "Your RIBBIT Client ID", "clientSecret" : "Your RIBBIT Client Secret" }, "customer" : { "customerId" : "The unique Customer ID from your system", "firstName" : "John", "lastName" : "Smith", "emailAddress" : "test@noemail.com", "phoneNumber" : "1112223333", "address" : { "addressLine1" : "123 Main St", "city" : "Oxford", "state" : "OH", "zip" : "12345" } }, "terms" : { "fullAmount" : 500, "amount" : 100, "loanTerms" : "biweekly_oblig" }, "settings" : { "webhookURL" : "https://your.webhook.url/api (optional)", "bankId" : "1234567", "transactionHistoryDays" : 93 }, "notificationType" : 0 }
customer
object will be saved with your customer.
customer
object.
You can choose to have CONNECT ignore conflicting data, or update our database with the new data.
If your settings are set to ignore conflicting data, any data passed in through the customer
object will not be saved/updated if the customer is an existing customer,
unless the data is marked as required and it is missing in our database.
customer
object),
your customer will not be prompted for their personal information. CONNECT will automatically prompt the user to provide missing data that has been set to required in your settings.
{ customerId : "string(100)", firstName : "string(100)", lastName: "string(100)", emailAddress: "string(100)", phoneNumber: "string(10)", address: { addressLine1: "string(150)", addressLine2: "string(150)", city: "string(50)", state: "string(2)", zip: "string(10)" } }
Once the session has been created through API call, CONNECT can be initialized in JavaScript using the following parameters.
const CONNECT = new RIBBITConnect({
target: 'ribbit-container',
token: session_token,
environment: 'Test',
settings: {
canOpenNewWindows: true
}
// Add optional parameters here. See below
});
CONNECT.open();
<div id="connect"></div>
string
- Requiredstring
string
boolean
boolean
Name | Type | Default | Description |
---|---|---|---|
resize | boolean | false | If resize=true, CONNECT resizes itself to fit its child content. Might be useful if inline=true |
closeButton | boolean | false | Display an "x" close button on the top right of CONNECT, allowing the user to directly initiate the CONNECT.close() method and the "exit" event |
mobileWidth | int | 650 | If the width of the CONNECT target element is reduced below this count of display pixels, CONNECT will switch to fullscreen for a seamless mobile experience |
canOpenNewWindows | boolean | true | Whether or not the CONNECT interface can manage opening new browser windows. Used to handle OAuth and if a user clicks on any links. If this is not handled, you must handle the onLinkOpen event. |