Skip to main content
DELETE
Delete a processor key

Delete a Processor Key

Revoke the stored key and remove it. The response is 204 with no body. An id that is not yours, or that no longer exists, returns 404.

Deleting a default key

Deleting a default key is always allowed. A payment type it covered falls back to a default both key if you have one. Only the types no other default covers are affected: until you add or promote another default for them, borrowers enrolled without a merchant_ref are skipped on those types. GET /v1/payment_connections lists them in missing_default_rails.
To swap credentials on a key that is in use, replace the key instead of deleting and re-adding it. The tag and default status carry over, and there is no moment with no key.
Payment results already read through this key are kept.

Authorizations

Authorization
string
header
required

Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Path Parameters

id
string<uuid>
required

The key's id, as returned when it was added or listed.

Response

The key was revoked and removed.