Delete a payment method

Changed on

Remove an obsolete or invalid payment method from a customer. Removing a payment method will also delete the payment method token from the Ezypay Vault if no other customers are linked to that token. However, a payment method with an active subscription or is the customer’s only (i.e. primary) payment method cannot be removed.

delete/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}

Request

  • Base URL
    https://api-sandbox.ezypay.com/v2
  • URL
    https://api-sandbox.ezypay.com/v2/billing/customers/{customerId}/paymentmethods/{paymentMethodToken}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://identity-sandbox.ezypay.com/token

Path parameters

paymentMethodTokenstring required

Auto-generated unique identifier of the payment method token generated by vault.

customerIdstring required

Auto-generated unique identifier of the customer.

Headers

merchantstring required

Merchant ID

Response

200

entityIdstring
deletedboolean

Changes