API reference / Payment methods
Remove a payment method
/v1/payment-methods/{id} Removes the card at the card processor too, so nobody can charge it again (PAYMENT_METHOD_REMOVED). Removing one already removed is fine. 409 4090401 when the processor can't remove it right now (retry shortly).
Path parameters
idstringRequired
Headers
AuthorizationstringRequiredBearerplus your API key. See Authentication.
Responses
200 OK
Payment method removed (code 2000401).
What data holds
payment_methodobject16 fields in
payment_methodidstringtypestringOne of:CARDstatusstringPENDINGuntil your customer saves it and their bank confirms it;ACTIVE(chargeable);FAILEDwhen that never happens;REMOVED.One of:PENDINGACTIVEFAILEDREMOVEDcustomerobject3 fields in
customeridstringnamestring | nullemailstring | null
cardobject | nullOnce saved. Never the card number.4 fields in
cardbrandstringFrom the card processor.One of:VISAMASTERCARDJCBlast4stringexp_monthinteger | nullThe expiry month your customer typed. Ask them for a new card before it passes (expires_byon the list).At least 1At most 12exp_yearinteger | nullFour digits.
labelstring | nullTo show your customer.next_actionobject2 fields in
next_actiontypestring | nullOne of:REDIRECTcheckout_urlstring (uri) | nullWeav's save page, whilePENDING.
success_urlstring (uri) | nullcancel_urlstring (uri) | nullwebhook_urlstring | nullexpires_atstring (date-time) | nullWhen the save link ends, whilePENDING.activated_atstring (date-time) | nullfailed_atstring (date-time) | nullremoved_atstring (date-time) | nullcreated_atstring (date-time)updated_atstring (date-time)
401 Unauthorized
Missing, malformed or unknown API key (code 4010000).
403 Forbidden
The key can't make this request (code 4030000): an address outside the key's IP allowlist, a live key before your live mode is on, or an account that isn't active. A live key sent from a browser is refused (code 4030001): keep live keys on your server.
404 Not Found
Not found in this mode for your account (code 4040000).
409 Conflict
The request conflicts with the current state, e.g. an Idempotency-Key reused with a different body (4090001), a request still in progress (4090002), a payment that can't be canceled (4090101) or can't be canceled at the provider yet (4090102, retry shortly), or a webhook still being sent (4090201).