Delete Account

​

Soft-deletes the account and cascades to everything beneath it. The delete fans out recursively: every child (sub-)account is soft-deleted, and for the account and each descendant Koard soft-deletes its API keys, locations, and terminals and deactivates its merchant credentials. An account-deleted webhook is emitted. All of this is a soft delete (a deleted_at timestamp is stamped), so the records are retained for audit. Transactions are never deleted -- historical transaction data is kept intact for reporting and settlement.

Path Parameters
  • account_id
    Type: string · Account Id
    required

    The ID of the account to delete

Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for delete/v1/accounts/{account_id}
curl 'https://api.uat.koard.com/v1/accounts/{account_id}' \
  --request DELETE \
  --header 'Accept: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN'

{
  "id": null,
  "message": "Resource deleted successfully",
  "success": true
}

Successful Response