Sign in
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
blockchain_addressesobject nullable

Provisioned blockchain deposit addresses for this financial account, keyed by the full name of the blockchain network that each address belongs to (e.g. ETHEREUM)

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",
  "blockchain_addresses": {
    "ETHEREUM": "0x5f2b9e8a1c4d7f0e3a6b9c2d5e8f1a4b7c0d3e6f"
  }
}

Changes

Changed in 4 of the 83 revisions of this API.34

  • 50e7b24888361See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • fd53f07a8b1f1See the full diff
    • ○

      added the new DELINQUENT enum value to the request property /

      request-property-enum-value-added

  • bce16144ab192See the full diff
    • ○

      removed the CHARGEBACK enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the INTERCHANGE enum value from the / response property for the response status

      response-property-enum-value-removed

  • 968332d811093See the full diff
    • ●

      added the new CHARGEBACK enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new INTERCHANGE enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROVISIONAL_CREDIT_ACCOUNT enum value to the / response property for the response status

      response-property-enum-value-added