Skip to main content

Statements

An account statement is a list of all transactions for an account over a monthly period. The statement includes deposits, charges and withdrawals, as well as the starting and ending balance for the period.

Account-holders generally review their bank statements every month to help keep track of expenses and spending, as well as monitor for any fraudulent charges or mistakes. It is required, by regulation, that an account statement is available to all account owners.

Unit provides white-labeled HTML based account statements, supporting all browsers, devices and standard screen resolutions, and eliminating any need for custom development work on your side.

Statement Example
info
  • Statements are created at the end of every calendar month.
  • A statement will be created even if an account had no activity during a certain month.
  • If an account is created during a certain month, a statement for that month would be created, as long as it was created prior to 7pm (EST) on the last day of that month.
  • If an account is closed during a certain month, a statement for that period would be created.

List#

List statement resources. Filtering and paging can be applied.

VerbGET
Urlhttps://api.s.unit.sh/statements
Required Scopestatements

Query Parameters#

NameTypeDefaultDescription
page[limit]integer100Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]integer0Number of resources to skip. See Pagination.
filter[accountId]string(empty)Optional. Filters the results by the specified account id.
filter[customerId]string(empty)Optional. Filters the results by the specified customer id.
sortstringsort=periodOptional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
curl -X GET 'https://api.s.unit.sh/statements?page[limit]=20&page[offset]=10' \-H "Authorization: Bearer ${TOKEN}"

Response#

Response is a JSON:API document.

200 OK#

FieldTypeDescription
dataArray of StatementArray of statement resources.
Example Response:
{  "data": [    {      "type": "statement",      "id": "1",      "attributes": {        "period": "2020-07"      },      "relationships": {        "account": {          "data": {            "type": "account",            "id": "1000"          }        },        "customer": {          "data": {            "type": "customer",            "id": "1"          }        }      }    },    {      "type": "statement",      "id": "2",      "attributes": {        "period": "2020-08"      },      "relationships": {        "account": {          "data": {            "type": "account",            "id": "1000"          }        },        "customer": {          "data": {            "type": "customer",            "id": "1"          }        }      }    }  ]}

Get HTML by Id#

Get a statement HTML output by id.

VerbGET
Urlhttps://api.s.unit.sh/statements/{id}/html
Required Scopestatements

Query Parameters#

NameTypeDefaultDescription
filter[customerId]string(empty)Optional. Verify that the statements belongs to the customer.
language"en" or "es""en"Optional. Select the statement language. en - English, es - Spanish

Response#

Response is a HTML document.

curl -X GET 'https://api.s.unit.sh/statements/1/html' \-H "Authorization: Bearer ${TOKEN}"