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

FieldType—String
FieldParams—Object
successCallback—Function
errorCallback—Function

BondCards

Kind: global class

new BondCards

new BondCards({ live: false })

Create a BondCards instance.

Param	Type	Default	Description
`live`	boolean	false	Sets 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.

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.

Param	Type	Description
`cardId`	string	Unique ID used to identify a specific card
`identity`	string	Temporary identity token that allows the call
`authorization`	string	Temporary Authorization token
`fields`	object	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		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
`selector`	string		CSS 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]`	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]`			Specifies that the input field is disabled
`[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]`	bool	true	Specifies 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.

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
`newPin`	string	New pin number
`confirmPin`	string	Repeated new pin number
`successCallback`	successCallback	Function that will be executed when the HTTPRequest finishes successfully
`errorCallback`	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	Default	Description
`[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 CSS rules to apply to the field

successCallback : `function`

Kind: global typedef

Param	Type	Description
`status`	string	HTTP status code of HTTPRequest
`response`	object	Response object

errorCallback : `function`

Kind: global typedef


`errors`	object	Object 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.

Param	Type	Default	Description
`live`	boolean	`false`	Sets 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.

Param	Type	Description
`[customerId]`	string	Customer to link an account for (supply only one of `customerId` or `businessId`)
`[businessId]`	string	Business to link an account for (supply only one of `customerId` or `businessId`)
`identity`	string	Temporary identity token allowing the call
`authorization`	string	Temporary Authorization token

bondExternalAccounts.microDeposit

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

Kind: instance method of BondExternalAccounts

Param	Type	Description
`linkedAccountId`	string	Linked account ID requiring a microdeposit
`identity`	string	Temporary identity token allowing the call
`authorization`	string	Temporary Authorization token

bondExternalAccounts.deleteExternalAccount

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

Kind: instance method of BondExternalAccounts


`linkedAccountId`	string	Linked account to delete
`identity`	string	Temporary identity token allowing the call
`authorization`	string	Temporary Authorization token

Bond Web SDK

BondCards

Typedefs

BondCards

new BondCards

bondCards.show

bondCards.showMultiple

bondCards.copy

bondCards.field

bondCards.submit

bondCards.reset()

FieldType : String

FieldParams : Object

successCallback : function

errorCallback : function

BondExternalAccounts

new BondExternalAccounts

bondExternalAccounts.linkAccount

bondExternalAccounts.microDeposit

bondExternalAccounts.deleteExternalAccount

FieldType : `String`

FieldParams : `Object`

successCallback : `function`

errorCallback : `function`