SDK Documentation

Changelog

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

Classes

BondCards
This represents the Bond Cards SDKSDK - A collection of software development tools in one installable package. They facilitate the creation of applications by having a compiler, debugger, and sometimes a software framework.. 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.

Param

Type

Default

Description

live

Boolean

True

Set 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.

Param

Type

Default

Description

cardId

String

Unique ID used to identify a specific card

identity

String

Temporary identity token allowing the call

authorization

String

Temporary Authorization token

field

number'/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

htmlSelector

String

Selector for the field/element where the iFrame will be placed

[css]

Object

Object 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.

Parameter

Description

cardId

Unique ID used to identify a specific card

identity

Temporary identity token that allows the call

authorization

Temporary Authorization token

fields

Object 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.

Param

Type

Default

Description

iframe

Object

Iframe object returned from show method

htmlSelector

String

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

Function

function() {}

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.

Param

Type

Default

Description

Version

selector

String

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

String

Text to display when the field is empty

[successColor]

String

Text color when the field is valid

[errorColor]

String

Text color when the field is invalid

[color]

String

Text color

[lineHeight]

String

Line height value

[fontSize]

String

Size of text

[fontFamily]

String

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

String

Specifies that the input field should automatically be in focus when the page loads

[hideValue]

Boolean

true

Specifies 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.

Param

Type

Description

cardId

String

Unique ID used to identify a specific card

identity

String

Temporary identity token allowing the call

authorization

String

Temporary Authorization token

currentPin

String

Current pin number

newPin

String

New pin number

confirmPin

String

Repeated new pin number

callback

successCallback

Function that will be executed when the HTTPRequest finishes successfully

callback

errorCallback

Function 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

Param

Type

Description

[htmlWrapper]

String

"text"

htmlSelector

String

[css]

Object

{}

successCallback : function

Kind: global typedef

status

String

HTTP status code of HTTPRequest

response

Object

Data object of the response

errorCallback : function

Kind: global typedef

Param

Type

Description

errors

Object

Object of the error messages


Did this page help you?