Payments.RemoveCreditCard

Endpoint

Method: POST
Route: Payments/RemoveCreditCard
Authentication: Authorize

Request Schema

Headers

Header	Required	Notes
`X-Api-Key`	Required when tenant is not resolved by subdomain	Resolves the tenant/customer database.
`Authorization: Bearer {token}`	Required for authorized endpoints	Get a token from `Auth/Token` or `Session/Create`.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status	Notes
`200 OK`	Returned by the controller for this operation.
`400 Bad Request`	The customer is configured to deny removing the last payment method and this is the only remaining method. Returns a `ProblemDetails` with `errorCode` `ValidationError`.

Success Body

Response type: string

The response body is a status message returned by PaymentsController.RemoveCreditCard.

Response Sample

"Successfully removed"

Error Body

{
  "title": "Validation failed.",
  "status": 400,
  "detail": "Cannot delete the last payment method. Please add a new payment method before removing this one.",
  "errorCode": "ValidationError"
}