customerPaymentTokens query
When the vault feature is supported by a payment integration and enabled, customers have the option during checkout to save their credit card information. (Braintree supports the vault feature. Third-party payment integrations may support this feature as well.) During subsequent checkouts, the customer is presented with a list of saved payment options. If Instant Purchase is enabled, customers can even by-pass the two-step checkout process and place the order from the product page.
The customerPaymentTokens
query returns an array of stored payment methods. Use the deletePaymentToken mutation to delete a payment token from the system.
You must specify the customer’s authorization token in the header of the call.
Syntax
{customerPaymentTokens{CustomerPaymentTokens}}
Example usage
The following example returns all the current customer’s payment tokens. The public_hash
output values will be unique to your application.
Request:
1
2
3
4
5
6
7
8
9
10
query {
customerPaymentTokens {
items {
details
public_hash
payment_method_code
type
}
}
}
Response:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"customerPaymentTokens": {
"items": [
{
"details": "{\"type\":\"VI\",\"maskedCC\":\"1111\",\"expirationDate\":\"09\\/2022\"}",
"public_hash": "377c1514e0...",
"payment_method_code": "braintree",
"type": "card"
},
{
"details": "{\"type\":\"DI\",\"maskedCC\":\"1117\",\"expirationDate\":\"11\\/2023\"}",
"public_hash": "f5816fe2ab...",
"payment_method_code": "braintree",
"type": "card"
}
]
}
}
}
Output attributes
CustomerPaymentTokens attributes
The CustomerPaymentTokens
output object contains an array of items
.
Attribute | Data Type | Description |
---|---|---|
items |
[PaymentToken]! | Contains an array of customer payment tokens |
PaymentToken attributes
The PaymentToken
object defines characteristics of a token stored in the payment vault.
Attribute | Data Type | Description |
---|---|---|
details |
String | Stored account details |
payment_method_code |
String! | The payment method code associated with the token |
public_hash |
String! | The public hash of the token generated by the vault provider |
type |
PaymentTokenTypeEnum! |
card or account |