Constructor
new Card(options)
Creates an instance of the client's card
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object
|
configuration parameters |
Methods
getCards() → {Promise}
Get all the cards for an account holder
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
Returns:
- Type:
-
Promise
- the http request promise
updateCardATMControl() → {Promise}
Update ATM withdrawal control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether ATM withdrawals should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardControl() → {Promise}
Update a card control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether the control should be should be locked. Set to false to lock, true to unlock. |
parameters.endpoint |
string
|
the last segment of the endpoint name |
Returns:
- Type:
-
Promise
- the http request promise
updateCardGamblingControl() → {Promise}
Update gambling payments control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether gambling payments should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardLock() → {Promise}
Update card lock
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether the card should be locked. Set to false to lock, true to unlock. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardMagstripeControl() → {Promise}
Update magstripe payments control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether magstripe payments should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardMobileWalletControl() → {Promise}
Update mobile wallet payments control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether mobile wallet payments should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardOnlineControl() → {Promise}
Update online payments control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether online payments should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise
updateCardPresentControl() → {Promise}
Update card present payments (contactless and chip and pin) control
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
parameters.apiUrl |
string
|
the API URL |
parameters.accessToken |
string
|
the oauth bearer token |
parameters.cardUid |
string
|
the card uid |
parameters.enabled |
boolean
|
Whether card present payments (contactless and chip and pin) should be allowed. Set to false to block, true to allow. |
Returns:
- Type:
-
Promise
- the http request promise