Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
Financial Account

Update financial account status

Update financial account status

post/v1/financial_accounts/{financial_account_token}/update_status

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for financial account.

Request body

status'OPEN' | 'CLOSED' | 'SUSPENDED' | 'PENDING' required

Status of the financial account

substatus'CHARGED_OFF_FRAUD' | 'END_USER_REQUEST' | 'BANK_REQUEST' | 'CHARGED_OFF_DELINQUENT' | 'INTEREST_AND_FEES_PAUSED' | 'DELINQUENT' required

Substatus for the financial account

user_defined_statusstring

User-defined status for the financial account

Example request

{
  "status": "CLOSED",
  "substatus": "END_USER_REQUEST"
}

Response

OK

tokenstring uuid required

Globally unique identifier for the account

createdstring date-time required
updatedstring date-time required
routing_numberstring nullable
account_numberstring nullable
nicknamestring nullable required
account_tokenstring uuid nullable required
status'OPEN' | 'CLOSED' | 'SUSPENDED' | 'PENDING' required

Status of the financial account

substatus'CHARGED_OFF_DELINQUENT' | 'CHARGED_OFF_FRAUD' | 'END_USER_REQUEST' | 'BANK_REQUEST' | 'DELINQUENT' | 'INTEREST_AND_FEES_PAUSED' required

Substatus for the financial account

user_defined_statusstring nullable required

User-defined status for the financial account

is_for_benefit_ofboolean required

Whether financial account is for the benefit of another entity

Example response

{
  "token": "b68b7424-aa69-4cbc-a946-30d90181b621"
}