Delete Payment Card v2.0Beta

The Delete Payment Card endpoint deletes a payment card from a customer profile at our payment processor. The card will immediately be removed from the customer profile at the payment processor.

Request

DELETE /v2.0/customers/{profileKey}/payments/cards/{cardId}

Authorization

An OAuth 2.0 Bearer token with the Payment.Write scope is required. For more information, see Authentication.

Path Parameters

A list of the supported path parameters is described below.

Name	Required	Type	Description
profileKey	true	string	The profile key for the customer. This value can be retrieved from the profileKey claim in the token returned from our SSO solution.
cardId	true	string	The identifier for the card that must be deleted.

Response

200

OK

Returns an ApiResponse envelope.

Response Body

The endpoint returns our ApiResponse envelope.

Sample

{
    "message": "The operation succeeded!",
    "notifications": [
        {
            "severity": "Success",
            "text": "The card was deleted.",
            "code": null,
            "additionalData": null
        }
    ]
}

Errors

The standard error responses apply.

400

Bad Request

When the request fails validation.

401

Unauthorized

When authentication fails.

403

Forbidden

When authorisation fails.

404

Not Found

When the card cannot be found.