Skip to navigation

Delete payment method

View as Markdown

Deletes a payment method. You cannot delete the default payment method — set another as default first.

Path Parameters

ParameterTypeRequiredDescription
payee_idUUIDYesID of the payee
payment_method_idUUIDYesID of the payment method to delete
  • You cannot delete a payment method that is currently set as default. Set a different verified payment method as default first.

Response

204 No Content – The payment method was successfully deleted.

Success Responses

Status CodeDescription
204No Content – The payment method was successfully deleted.

Error Responses

Status CodeError CodeDescription
400DEFAULT_PAYMENT_METHODCannot delete the default payment method. Set another payment method as default first.
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing.
403AUTHORIZATION_ERRORYou do not have permission to perform this action.
404NOT_FOUNDThe specified payment method was not found.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

OR
AuthorizationBearer

Short-lived session JWT from the Session Tokens API. Send as Authorization: Bearer <token>. Accepted on payment-method endpoints for a specific payee or payer; mint tokens with an API key.

Path parameters

payee_idstringRequiredformat: "uuid"
payment_method_idstringRequiredformat: "uuid"

Response

Payment method deleted successfully (no content)