Payment Methods API

Delete a saved payment method

DEL
https://api.sandbox.primer.io/payment-instruments/:paymentMethodToken

Delete a saved payment method.

Path parameters

paymentMethodToken
string

Saved payment method token to delete.

Response

This endpoint return an object.
analyticsId
optional string

Unique analytics identifier corresponding to a payment method

createdAt
optional datetime

Creation date & time of the object (UTC)

customerId
optional string

The ID representing the customer

default
optional boolean

Whether or not this payment method is the default

deleted
optional boolean

Whether or not this object has been revoked.

deletedAt
optional datetime

Date & time when this object was revoked. (UTC)

description
optional string

A friendly description given by the user

isVerified
optional boolean

Whether or not this payment method was verified

paymentMethodData
optional union

Payment method data

paymentMethodType
optional enum

Payment method type associated with a token.

token
optional string

The vaulted payment method token.

tokenType
optional string
  • MULTI_USE a vaulted token that can be re-used with subsequent payments

Errors

DEL
/payment-instruments/:paymentMethodToken
1
2
curl -X DELETE "https://api.sandbox.primer.io/payment-instruments/payment-method-token" \
     -H "X-API-KEY: <apiKey>"
Response
1
2
3
{
  "paymentMethodType": "PAYMENT_CARD"
}