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
FieldType—StringFieldParams—ObjectsuccessCallback—FunctionerrorCallback—Function
BondCards
Kind: global class
- new BondCards
- bondCards.show
- bondCards.showMultiple
- bondCards.copy
- bondCards.field
- bonCards.submit
- bondCards.reset
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
StringKind: global typedef
Value: number | cvv | expiry
FieldParams : Object
ObjectKind: global typedef
| Param | Type | Description |
|---|---|---|
[htmlWrapper] | string | "text" |
htmlSelector | string | |
[css] | object | {} |
successCallback : function
functionKind: global typedef
status | string | HTTP status code of HTTPRequest |
response | object | Data object of the response |
errorCallback : function
functionKind: global typedef
| Param | Type | Description |
|---|---|---|
errors | object | Object of the error messages |
Updated 8 months ago