Increase Account Statements API
Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
OpenAPI Specification
openapi: 3.1.0
info:
description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
title: Increase Account Numbers Account Statements API
version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
name: Account Statements
paths:
/account_statements:
get:
operationId: list_account_statements
parameters:
- in: query
name: cursor
required: false
schema:
description: Return the page of entries after this one.
type: string
x-documentation-priority: low
- in: query
name: limit
required: false
schema:
description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
minimum: 1
type: integer
x-documentation-priority: low
- example: account_in71c4amph0vgo2qllky
in: query
name: account_id
required: false
schema:
description: Filter Account Statements to those belonging to the specified Account.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
- in: query
name: statement_period_start.after
required: false
schema:
description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: statement_period_start.before
required: false
schema:
description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: statement_period_start.on_or_after
required: false
schema:
description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
- in: query
name: statement_period_start.on_or_before
required: false
schema:
description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
format: date-time
type: string
x-documentation-priority: low
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/account_statement_list'
description: Account Statement List
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: List Account Statements
x-sandbox-only: false
x-tag: Account Statements
tags:
- Account Statements
/account_statements/{account_statement_id}:
get:
operationId: retrieve_an_account_statement
parameters:
- example: account_statement_lkc03a4skm2k7f38vj15
in: path
name: account_statement_id
required: true
schema:
description: The identifier of the Account Statement to retrieve.
type: string
x-documentation-priority: default
x-id-reference-to: Account Statements
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/account_statement'
description: Account Statement
4XX:
$ref: '#/components/responses/errorResponse'
5XX:
$ref: '#/components/responses/errorResponse'
summary: Retrieve an Account Statement
x-sandbox-only: false
x-tag: Account Statements
tags:
- Account Statements
components:
schemas:
account_statement:
additionalProperties: false
description: Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
example:
account_id: account_in71c4amph0vgo2qllky
created_at: '2020-01-31T23:59:59Z'
ending_balance: 100
file_id: file_makxrc67oh9l6sg7w9yc
id: account_statement_lkc03a4skm2k7f38vj15
loan: null
starting_balance: 0
statement_period_end: '2020-01-31T23:59:59Z'
statement_period_start: '2020-01-31T23:59:59Z'
type: account_statement
properties:
account_id:
description: The identifier for the Account this Account Statement belongs to.
type: string
x-documentation-priority: default
x-id-reference-to: Accounts
created_at:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.
format: date-time
type: string
x-documentation-priority: default
ending_balance:
description: The Account's balance at the end of its statement period.
type: integer
x-documentation-priority: default
file_id:
description: The identifier of the File containing a PDF of the statement.
type: string
x-documentation-priority: default
x-id-reference-to: Files
id:
description: The Account Statement identifier.
type: string
x-documentation-priority: default
x-id-reference-to: Account Statements
loan:
anyOf:
- additionalProperties: false
description: The loan balances.
properties:
due_at:
anyOf:
- description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan payment is due.
format: date-time
type: string
x-documentation-priority: default
- type: 'null'
due_balance:
description: The total amount due on the loan.
type: integer
x-documentation-priority: default
past_due_balance:
description: The amount past due on the loan.
type: integer
x-documentation-priority: default
required:
- due_balance
- past_due_balance
- due_at
title: Account Statement Loan
type: object
x-documentation-priority: default
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Loans
- type: 'null'
starting_balance:
description: The Account's balance at the start of its statement period.
type: integer
x-documentation-priority: default
statement_period_end:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.
format: date-time
type: string
x-documentation-priority: default
statement_period_start:
description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.
format: date-time
type: string
x-documentation-priority: default
type:
description: A constant representing the object's type. For this resource it will always be `account_statement`.
enum:
- account_statement
type: string
x-documentation-priority: default
required:
- type
- id
- account_id
- created_at
- file_id
- statement_period_start
- statement_period_end
- starting_balance
- ending_balance
- loan
title: Account Statement
type: object
x-event-categories:
- account_statement.created
x-stainless-empty-object: false
x-tag: Account Statements
x-title-plural: Account Statements
account_statement_list:
additionalProperties: true
description: A list of Account Statement objects.
example:
data:
- account_id: account_in71c4amph0vgo2qllky
created_at: '2020-01-31T23:59:59Z'
ending_balance: 100
file_id: file_makxrc67oh9l6sg7w9yc
id: account_statement_lkc03a4skm2k7f38vj15
loan: null
starting_balance: 0
statement_period_end: '2020-01-31T23:59:59Z'
statement_period_start: '2020-01-31T23:59:59Z'
type: account_statement
next_cursor: v57w5d
properties:
data:
description: The contents of the list.
items:
$ref: '#/components/schemas/account_statement'
type: array
x-documentation-priority: default
next_cursor:
anyOf:
- description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
type: string
x-documentation-priority: default
- type: 'null'
required:
- data
- next_cursor
title: Account Statement List
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: Account Statement Lists
error:
anyOf:
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- api_method_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- environment_mismatch_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
resource_id:
description: ''
type: string
x-documentation-priority: default
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- idempotency_key_already_used_error
type: string
required:
- type
- title
- detail
- status
- resource_id
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- insufficient_permissions_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 500
type: integer
title:
type: string
type:
enum:
- internal_server_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
reason:
description: ''
enum:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
type: string
x-documentation-priority: default
x-enum-descriptions:
- deleted_credential
- expired_credential
- ip_not_allowed
- no_credential
- no_header
- no_api_access
- wrong_environment
status:
enum:
- 401
type: integer
title:
type: string
type:
enum:
- invalid_api_key_error
type: string
required:
- type
- title
- detail
- status
- reason
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 409
type: integer
title:
type: string
type:
enum:
- invalid_operation_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
errors:
description: All errors related to parsing the request parameters.
items:
additionalProperties: true
properties: {}
title: ErrorsElement
type: object
x-event-categories: []
x-stainless-empty-object: false
x-title-plural: ErrorsElements
type: array
x-documentation-priority: default
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- invalid_parameters_error
type: string
required:
- type
- title
- detail
- status
- errors
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 400
type: integer
title:
type: string
type:
enum:
- malformed_request_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 404
type: integer
title:
type: string
type:
enum:
- object_not_found_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
status:
enum:
- 403
type: integer
title:
type: string
type:
enum:
- private_feature_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
- properties:
detail:
anyOf:
- type: string
- type: 'null'
retry_after:
anyOf:
- description: ''
type: integer
x-documentation-priority: default
- type: 'null'
status:
enum:
- 429
type: integer
title:
type: string
type:
enum:
- rate_limited_error
type: string
required:
- type
- title
- detail
- status
type: object
x-event-categories: []
responses:
errorResponse:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/error'
description: Error
securitySchemes:
bearerAuth:
scheme: bearer
type: http
x-tagGroups:
- name: Accounts
tags:
- Accounts
- Account Numbers
- Account Transfers
- name: Transactions
tags:
- Transactions
- Pending Transactions
- Declined Transactions
- name: Ach Transfers
tags:
- ACH Transfers
- Inbound ACH Transfers
- ACH Prenotifications
- name: Check Transfers
tags:
- Check Transfers
- Inbound Check Deposits
- name: Real Time Payments Transfers
tags:
- Real-Time Payments Transfers
- Inbound Real-Time Payments Transfers
- name: Fednow Transfers
tags:
- FedNow Transfers
- Inbound FedNow Transfers
- name: Swift Transfers
tags:
- Swift Transfers
- name: Wire Transfers
tags:
- Wire Transfers
- Inbound Wire Transfers
- Wire Drawdown Requests
- Inbound Wire Drawdown Requests
- name: Card Transfers
tags:
- Card Tokens
- Card Push Transfers
- Card Validations
- name: Check Deposits
tags:
- Check Deposits
- Lockbox Addresses
- Lockbox Recipients
- Inbound Mail Items
- name: Cards
tags:
- Cards
- Card Payments
- Card Purchase Supplements
- Card Disputes
- Physical Cards
- Digital Card Profiles
- Physical Card Profiles
- Digital Wallet Tokens
- name: Compliance
tags:
- Entities
- Beneficial Owners
- Supplemental Documents
- Entity Onboarding Sessions
- Programs
- name: Events and Webhooks
tags:
- Events
- Event Subscriptions
- Real-Time Decisions
- name: External Accounts
tags:
- Routing Numbers
- External Accounts
- name: Files and Exports
tags:
- Account Statements
- Files
- File Links
- Exports
- name: OAuth
tags:
- Groups
- OAuth Applications
- OAuth Connections
- OAuth Tokens
- name: Intrafi
tags:
- IntraFi Account Enrollments
- IntraFi Balances
- IntraFi Exclusions