Closes the cardholder's account permanently. This cannot be undone.
- The available balance, if any, is unloaded to your funding account.
- The account and its card are closed at the processor.
An account can be closed when its account_status (from Get a cardholder by ID) reads active, suspended or fraud. If it holds a balance, that balance must be unloadable first; the close is refused with 422 when account_status, or the cards[].status of an account's only card, reads suspended or fraud, when an active card has expired, or when the card is unassigned.
If the processor close fails, the response is 502 cardholder_closure_failed, the account is normally still open, and any unloaded balance has been reloaded onto the card. If that reload also fails, the response is 500 cardholder_closure_balance_rollback_failed: the account is still open and its balance is in your funding account. Contact Berkeley Payments support.
| Status | type | When |
|---|---|---|
| 404 | cardholder_not_found | No cardholder with this id in your company |
| 404 | card_order_item_not_found | The card has no inventory record |
| 409 | cardholder_already_closed | The account is already closed |
| 409 | bulk_update_count_mismatch | Another request changed the card at the same time; check the cardholder before retrying |
| 422 | cardholder_closure_not_closable | account_status reads something other than active, suspended or fraud, for example lost, stolen, expired, never activated or delinquent |
| 422 | cardholder_suspended, cardholder_fraud_blocked, cardholder_expired, cardholder_not_assigned | The account holds a balance that cannot be unloaded in this state |
| 422 | invalid_status_transition | The card's inventory record cannot be closed: the card was replaced, or is being transferred between offices |
| 422 | value_load_* | The processor refused the balance unload, for example a velocity or limit check |
| 502 | cardholder_closure_failed | The processor close failed; the account is open with its balance |
| 500 | cardholder_closure_balance_rollback_failed | The processor close failed and the balance is in your funding account |
| 502, 504 | value_load_processor_failure, value_load_processor_timeout, cardholder_processor_balance_failed | The processor failed before the close; check the balance before retrying |
| 500 | internal_server_error | Reading the card's status failed unexpectedly; nothing changed |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||