deletePaymentToken mutation

The deletePaymentToken mutation deletes a payment token from the system. Use the customerPaymentTokens query to retrieve all stored payment methods associated with a particular customer.

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

Syntax

mutation: {deletePaymentToken(public_hash) {DeletePaymentTokenOutput}}

Example usage

The following example deletes the Discover Card listed in the results of the customerPaymentTokens query. The public_hash you specify will be unique to your application.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
mutation {
  deletePaymentToken(
    public_hash: "377c1514e0..."
  ) {
    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": "f5816fe2ab...",
            "payment_method_code": "braintree",
            "type": "card"
          }
        ]
      }
    }
  }
}

Input attributes

The deletePaymentToken object must contain the following attributes.

Output attributes

The top-level DeletePaymentTokenOutput object is listed first. All child objects are listed in alphabetical order.

DeletePaymentTokenOutput attributes

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

CustomerPaymentTokens attributes

The CustomerPaymentTokens output object contains an array of items.

PaymentToken attributes

The PaymentToken object defines characteristics of a token stored in the payment vault.

Errors

Related topics

customerPaymentTokens query