Web SDK Documentation

API documentation for the Bond Web SDK

Bond Web SDK

BondCards

BondCards
This represents the BondCards SDK. It allows developers to make all calls to the APIs that securely store PCI data with a single function.

Typedefs

BondCards

Kind: global class

new BondCards

new BondCards({ live: false })

Create a BondCards instance.

ParamTypeDefaultDescription
livebooleanfalseSets the Bond platform environment, true to work with live, false for sandbox.

bondCards.show

bondCards.show(cardId, identity, authorization, field, [htmlWrapper], htmlSelector, [css]) ⇒ <code>Promise</code>

Display appropriate card data.

Kind: instance method of BondCards
Returns: Promise—Returns a Promise that, when fulfilled, will either return an iFrame with the appropriate data or an error.

ParamTypeDefaultDescription
cardIdstringUnique ID used to identify a specific card
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token
fieldnumber/cvv/expiryField to get/show
[htmlWrapper]string"text"Expected type of response data. 'image' is wrapped in an HTML tag. 'text' is inserted into an element inside the iframe
htmlSelectorstringSelector for the field/element where the iframe will be placed
[css]objectObject of the CSS rules to apply to the response

bondCards.showMultiple

bondCards.showMultiple(cardId, identity, authorization, fields) ⇒ <code>Promise</code>

Display appropriate card data.

Kind: instance method of BondCards
Returns: Promise—Returns a Promise that, when fulfilled, will either return list of iFrames with the appropriate data or an error.

ParamTypeDefaultDescription
cardIdstringUnique ID used to identify a specific card
identitystringTemporary identity token that allows the call
authorizationstringTemporary Authorization token
fieldsobjectObject containing the requested fields

bondCards.copy

bondCards.copy(iframe, htmlSelector, [css], [text], [callback]) ⇒ <code>Promise</code>

Copy card data (one of number, expiry, cvv).

Kind: instance method of BondCards
Returns: Promise—Returns a Promise that, when fulfilled, will either return an iFrame with the appropriate data or an error.

ParamTypeDefaultDescription
iframeobjectIframe object returned from show method
htmlSelectorstringSelector for the field/element where the iframe will be placed
[css]objectAn object of CSS rules to apply to the response
[text]stringText of button
[callback]functionfunction() {}Function to call when copy handler called

bondCards.field

bondCards.field(selector, type, [css], [placeholder], [successColor], [errorColor], [color], [lineHeight], [fontSize], [fontFamily], [disabled], [readOnly], [autoFocus]) ⇒ <code>Promise</code>

Initialize a field in a form to submit for card manipulation.

Kind: instance method of BondCards
Returns: Promise—Returns a Promise that, when fulfilled, will either initialize the field or return an error.

ParamTypeDefaultDescription
selectorstringCSS selector that points to the element where the field will be added
type'new_pin' | 'confirm_pin'Type of the field targeted
[css]object{}Object of CSS rules to apply to the field
[placeholder]stringText to display when the field is empty
[successColor]stringText color when the field is valid
[errorColor]stringText color when the field is invalid
[color]stringText color
[lineHeight]stringLine height value
[fontSize]stringSize of text
[fontFamily]stringFont family used in the text
[disabled]Specifies that the input field is disabled
[readOnly]Specifies that the input field is read only
[autoFocus]stringSpecifies that the input field should automatically be in focus when the page loads
[hideValue]booltrueSpecifies that the input field should be masked with ****

bondCards.submit

bondCards.submit(cardId, identity, authorization, newPin, confirmPin, callback, callback) ⇒ <code>Promise</code>

Show appropriate card data.

Kind: instance method of BondCards
Returns: Promise—Returns a Promise that, when fulfilled, will either return an iFrame with the appropriate data or an error.

ParamTypeDefaultDescription
cardIdstringUnique ID used to identify a specific card
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token
newPinstringNew pin number
confirmPinstringRepeated new pin number
successCallbacksuccessCallbackFunction that will be executed when the HTTPRequest finishes successfully
errorCallbackerrorCallbackFunction Error handling callback. Triggered if one of the fields has an invalid value on submission. By default, pushes the error messages to the console

bondCards.reset()

Reset the form or a field.

Kind: Instance method of BondCards

FieldType : String

Kind: global typedef

Value: number | cvv | expiry

FieldParams : Object

Kind: global typedef

ParamTypeDefaultDescription
[htmlWrapper]string"text"Expected type of response data. 'image' is wrapped in an HTML tag. 'text' is inserted into an element inside the iframe
htmlSelectorstringSelector for the field/element where the iframe will be placed
[css]object{}Object of CSS rules to apply to the field

successCallback : function

Kind: global typedef

ParamTypeDescription
statusstringHTTP status code of HTTPRequest
responseobjectResponse object

errorCallback : function

Kind: global typedef

errorsobjectObject with error messages

BondExternalAccounts

For a complete specification and interactive examples, see Linking external accounts in the Bond API Reference.

Kind: global class

new BondExternalAccounts

new BondExternalAccounts({ live: false })
Create a BondExternalAccounts instance.

ParamTypeDefaultDescription
livebooleanfalseSets the Bond environment, true to work with live, false for sandbox.

bondExternalAccounts.linkAccount

bondExternalAccounts.linkAccount({ customerId | businessId, identity, authorization }) ⇒ Promise
Connect external account.

Kind: instance method of BondExternalAccounts.

ParamTypeDefaultDescription
[customerId]stringCustomer to link an account for (supply only one of customerId or businessId)
[businessId]stringBusiness to link an account for (supply only one of customerId or businessId)
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token

bondExternalAccounts.microDeposit

bondExternalAccounts.microDeposit({ linkedAccountId, identity, authorization }) ⇒ Promise
Micro deposit.

Kind: instance method of BondExternalAccounts

ParamTypeDefaultDescription
linkedAccountIdstringLinked account ID requiring a microdeposit
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token

bondExternalAccounts.deleteExternalAccount

bondExternalAccounts.deleteExternalAccount({ linkedAccountId, identity, authorization }) ⇒ Promise
Micro deposit.

Kind: instance method of BondExternalAccounts

linkedAccountIdstringLinked account to delete
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token