Get statement dates

Retrieve statement dates based on the given program GUID and range.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json

Request body containing program GUID and range

program_guid
required
string <uuid>

Program unique identifier.

account_guid
string or null <uuid>

Account unique identifier.

range
integer or null <int32> [ 1 .. 1827 ]

Range in days to look back for statement dates. Default is 180 days. Lookback period range is a max of 5 years/1827 in days

limit
integer <int32> [ 1 .. 1000 ]

Limit number of results to retrieve (Will be defaulted to 100 if none specified)

start_index
integer <int32>

Index used for pagination of the result.

Responses
200

Returns the statement dates

400

Bad request

401

Unauthorized

500

Server Error

post/api/{version}/statements/statementdates
Request samples
application/json
{
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "range": 1,
  • "limit": 1,
  • "start_index": 0
}
Response samples
application/json
{
  • "count": 0,
  • "start_index": 0,
  • "end_index": 0,
  • "has_more": true,
  • "data": [
    • {
      • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "statement_cycle_start_date": "2019-08-24T14:15:22Z",
      • "statement_cycle_end_date": "2019-08-24T14:15:22Z",
      • "statement_frequency": "string"
      }
    ],
  • "check_statuses": [
    • "string"
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.