Delete a Payment Default

Deletes or submits a deletion request for a payment default, depending on its current status.
- If the status was PENDING, the record is deleted immediately. If the status was ACTIVE, ENDED, or DISPUTED, a deletion request is submitted for manual review instead. In both cases, a 200 OK response is returned.
- If the payment default status is ACTIVE, ENDED, or DISPUTED the deleteReason parameter is required.

A 422 Unprocessable Entity error is returned if:
- deleteReason is missing (required when status is ACTIVE, ENDED, or DISPUTED).
- deleteReason exceeds 1,000 characters.
- A deletion request has already been submitted for this payment default.

A 404 Not Found error is returned if no payment default with the given ID exists.

Path Params
integer
required

Unique identifier of the payment default to delete.

Body Params
string
length ≤ 1000

Reason for the deletion request. Required when the payment default status is ACTIVE, ENDED, or DISPUTED. Maximum 1,000 characters.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json