SDK Documentation

Bond card management SDK details.

Changelog

04/01/2021 - Added method showMultiple
04/16/2021 - Added new property hideValue to method field

Classes

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])

Create a BondCards instance.

ParamTypeDefaultDescription
livebooleanTrueSet to "True" to work with live data. "False" for sandbox data

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/expiry`Field 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.

ParameterDescription
cardIdUnique ID used to identify a specific card
identityTemporary identity token that allows the call
authorizationTemporary Authorization token
fieldsObject 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]object{}An object of CSS rules to apply to the response
[text]string"Copy"Text 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.

ParamTypeDefaultDescriptionVersion
selectorstringCSS selector that points to the element where the field will be added
type'current_pin' | '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]'disabled'Specifies that the input field is disabled
[readOnly]'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]booleantrueSpecifies that the input field should be masked with ****1.6.0 and above

bondCards.submit

bondCards.submit(cardId, identity, authorization, currentPin, 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.

ParamTypeDescription
cardIdstringUnique ID used to identify a specific card
identitystringTemporary identity token allowing the call
authorizationstringTemporary Authorization token
currentPinstringCurrent pin number
newPinstringNew pin number
confirmPinstringRepeated new pin number
callbacksuccessCallbackFunction that will be executed when the HTTPRequest finishes successfully
callbackerrorCallbackFunction 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

ParamTypeDescription
[htmlWrapper]string"text"
htmlSelectorstring
[css]object{}

successCallback : function

Kind: global typedef

statusstringHTTP status code of HTTPRequest
responseobjectData object of the response

errorCallback : function

Kind: global typedef

ParamTypeDescription
errorsobjectObject of the error messages