Delete payment method

DEL https://api.invunion.com/api/v1/payment-methods/:code payment_methods:write Markdown

Delete a catalog payment method.

Permanently deletes the catalog instrument. Default instruments and instruments with linked transactions cannot be deleted. Bank-connection rows cannot be deleted here. Counterparties and issued invoices are kept: this instrument is unlinked from them rather than deleted or moved to Default System. Shared associations for this instrument are removed. Existing matches are unchanged.

Path parameters

NameTypeRequired
code

Payment method code (`code`).

Example: PM-001

string

Max 50

Required

Errors

This operation can return the following errors in addition to generic HTTP failures.

Error HTTP code Description
Missing Bearer token 401 The Authorization header is missing or is not a Bearer token.
Invalid or revoked API key 401 The API key is unknown, malformed, expired, or has been revoked.
API key is missing scope payment_methods:write 403 The key does not include payment_methods:write. A write scope does not imply the matching read scope.
Too many requests, please try again later 429 Wait and retry. The Retry-After header is the number of seconds to wait.
Payment method not found 404 No catalog payment method with this code exists in the authenticated tenant.
Enable Banking accounts are managed from Bank connections, not from payment methods. 403 The row is a bank-connection account, not a catalog instrument.
Cannot delete a default payment method. Reassign it first. 403 The instrument is the counterparty Default and is not deletable.
Cannot delete payment method with linked transactions. Unlink them first. 409 Transactions still point at this instrument.
Internal server error 500 Unexpected server error. The JSON body includes correlationId. Retry with backoff.