Get All Trust Accounts

Gets all trust accounts.

Resource Information


Deprecated scope name:   get_trustaccounts

App TypeAll
Authorization TypeAccess token
URI /v4/trustAccounts/?offset={offset}&limit={limit}&fields={fields}&lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNoComma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.
langStringNoIndicates the language applied.
limitlongNoIndicates the number of items that are returned in each page.
offsetlongNoIndicates the offset start of each page by the number specified.

Response Information

FieldTypeDescriptionAutomation Version
result.accountstringThe account ID number for the trust account.
result.associationsresult.associations{}The trust account associations.
result.associations.textstringThe localized display text.
result.associations.valuestringThe value for the specified parameter.
result.balancedoubleThe balance of the trust account in dollars.
result.descriptionstringThe description of the trust account.
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.
result.isPrimarystringIndicates whether or not to designate the trust account as the primary source.
result.ledgerAccountstringThe ledger account of the trust account.
result.overdraftstringIndicates whether or not the trust account can use the overdraft option.
result.overdraft.textstringThe localized display text.
result.overdraft.valuestringThe value for the specified parameter.
result.overdraftLimitDoubleThe overdraft limit amount, in dollars, for the trust account.
result.serviceProviderCodestringThe unique agency identifier.
result.statusstringThe status of the trust account.
result.status.textstringThe localized display text.
result.status.valuestringThe value for the specified parameter.
result.thresholdAmountDoubleThe minimum amount required in a trust account.
statusintegerThe record status.