Constructor
new UnionPay(options)
You cannot use this constructor directly. Use braintree-web.unionpay.create instead.
Parameters:
Name | Type | Description |
---|---|---|
options |
object |
See unionpay.create. |
- Source:
Methods
enroll(options, callbackopt) → {void}
Enrolls a UnionPay card. Use fetchCapabilities to determine if the SMS enrollment process is required.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
UnionPay enrollment options: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
callback |
callback |
<optional> |
The second argument, |
- Source:
fetchCapabilities(options, callbackopt) → {Promise|void}
Fetches the capabilities of a card, including whether or not the SMS enrollment process is required.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
UnionPay fetchCapabilities options Properties
|
|||||||||||||||||||
callback |
callback |
<optional> |
The second argument, |
- Source:
teardown(callbackopt) → {Promise|void}
Cleanly remove anything set up by create. This only needs to be called when using UnionPay with Hosted Fields.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
callback |
<optional> |
Called on completion. If no callback is provided, returns a promise. |
- Source:
tokenize(options, callbackopt) → {Promise|void}
Tokenizes a UnionPay card and returns a nonce payload.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
UnionPay tokenization options: Properties
|
|||||||||||||||||||||||||||||||||||||||||||||
callback |
callback |
<optional> |
The second argument, |
- Source:
Type Definitions
enrollPayload :object
Properties:
Name | Type | Description |
---|---|---|
enrollmentId |
string |
UnionPay enrollment ID. This value should be passed to |
smsCodeRequired |
boolean |
UnionPay |
- Source:
fetchCapabilitiesPayload :object
Properties:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
isUnionPay |
boolean |
Determines if this card is a UnionPay card. |
|||||||||
isDebit |
boolean |
Determines if this card is a debit card. This property is only present if |
|||||||||
unionPay |
object |
UnionPay specific properties. This property is only present if Properties
|
- Source:
tokenizePayload :object
Properties:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nonce |
string |
The payment method nonce. |
||||||||||||
type |
string |
Always |
||||||||||||
details |
object |
Additional account details: Properties
|
||||||||||||
description |
string |
A human-readable description. |
- Source: