Docs
Lifecycle

Disconnect and erase the credential

POST
/v1/accounts/{id}/disconnect

Takes the account offline and deletes the stored password. The account record stays, with its history, in offline. Reconnecting means sending the password again.

This is the endpoint to call when a customer leaves. A disconnected account that still holds a usable password is a credential nobody is watching.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry an environment (live or test) in the key itself, so a test key pasted into a production config fails immediately instead of at the worst possible moment.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/disconnect"
{  "data": {    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",    "state": "string",    "credentialsRemoved": true  }}