OpenApi SpecContact Us
API Reference

Close an account

post
https://sandbox-api.helix.q2.com/account/close

Close an account. If the account balance is greater than $0 or any interest is owed on the account those amounts are calculated and a transaction is implicitly created with the sum of those amounts being credited into the given closeToAccountId. That transaction's tag property is also assigned the value in the transactionTag property (if specified).

Body Params
int32
required
≥ 1
int32
required
≥ 1
int32
≥ 1

The Helix-assigned ID for the account to receive remaining funds. This can be the accountId of an account or the externalAccountId of an externalAccount. Notes: closeToAccountId is required if the account has a balance or earns interest. To close to a petty cash account, use the Helix Admin Console or the Bulk Account Close Process.

string
length ≤ 50

A program-wide unique identifier that is to be associated with the transaction created to move any funds out of the account being closed.

string
enum

The following values are not enabled by default and require additional configuration. Contact the Helix Support team for more information.

  • re-CIP
  • Risk-Related
  • Member Requested
  • Negative Balance (Reopen Eligible)
  • Negative Balance (Reopen Ineligible)
  • ID Theft
  • Account Take Over
  • Dormant
string
length ≤ 255

Required if closeReason is Other

Responses

Updated 5 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 days ago