Vault endpoint

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.

Query

The customerPaymentTokens query returns an array of stored payment methods.

You must specify the customer’s authorization token in the header of the call.

Syntax

{customerPaymentTokens{CustomerPaymentTokens}}

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

Example usage

The following example returns all the current customer’s payment tokens.

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": "f5816fe2ab7d200c3ff84d42804b65144f9cb0a2401ce1dad1b52d3b3115fd1a",
          "payment_method_code": "braintree",
          "type": "card"
        },
        {
          "details": "{\"type\":\"DI\",\"maskedCC\":\"1117\",\"expirationDate\":\"11\\/2023\"}",
          "public_hash": "377c1514e0bce7107a9348ddf38bc059b2f1b9e0a8bedf168a98b04807e17ff5",
          "payment_method_code": "braintree",
          "type": "card"
        }
      ]
    }
  }
}

Mutation

The deletePaymentToken mutation deletes a payment token from the system.

You must specify the customer’s authorization token in the header of the call.

Syntax

mutation: {deletePaymentToken(public_hash) {DeletePaymentTokenOutput}}

DeletePaymentTokenOutput attributes

The DeletePaymentTokenOutput object contains the result of the operation and details about the remaining customer payment tokens.

Attribute Data Type Description
customerPaymentTokens CustomerPaymentTokens Contains an array of customer payment tokens
result Boolean A value of true indicates the request was successful

CustomerPaymentTokens

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

Example usage

The following example deletes the Discover Card listed in the results of the customerPaymentTokens query.

Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
mutation {
  deletePaymentToken(
    public_hash: "377c1514e0bce7107a9348ddf38bc059b2f1b9e0a8bedf168a98b04807e17ff5"
  ) {
    result
    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
{
  "data": {
    "deletePaymentToken": {
      "result": true,
      "customerPaymentTokens": {
        "items": [
          {
            "details": "{\"type\":\"VI\",\"maskedCC\":\"1111\",\"expirationDate\":\"09\\/2022\"}",
            "public_hash": "f5816fe2ab7d200c3ff84d42804b65144f9cb0a2401ce1dad1b52d3b3115fd1a",
            "payment_method_code": "braintree",
            "type": "card"
          }
        ]
      }
    }
  }
}