Delete Account

Delete a WiPay user account by account number. In MMA workflows, accounts not originally created under the MMA may instead be de-authorized rather than fully removed.

This endpoint is part of the conditional MMA account-management workflow, not a general-purpose account-deletion endpoint for every verified WiPay PERSONAL or BUSINESS account.

Endpoint

DELETE /accounts/{account_number}

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-accounts-delete`, or `wapi-accounts-all`
Rate Limit	5 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

Path Parameters

Parameter	Type	Required	Description
`account_number`	string	Yes	The account number to delete

Notes:

account_number must be a numeric string.
The account must already be authorized under the authenticated MMA before the request can succeed.

Responses

200 OK

{
  "message": "OK"
}

400 Bad Request

{
  "message": "The selected account number is invalid."
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

Insufficient permissions

{
  "message": "Forbidden"
}

Account is not authorized under this MMA

{
  "message": "The provided account number must be authorized before proceeding."
}

Invalid scopes

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X DELETE https://ttsb.wipayfinancial.com/wapi/accounts/1428855397 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page