PIpismo
Statement

List statements

List account statements. For more information about statements, refer to Understanding statements.

The filter parameters have the following order of precedence:

  1. startFromCurrentCycle
  2. presentToFront
  3. presentToPast

That is, if startFromCurrentCycle is true, then presentToFront and presentToPast are ignored. If startFromCurrentCycle is false (or not set), and presentToFront is true, then presentToPast is ignored.

Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

get/statements-v2/v3/accounts/{accountId}/statements

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v3/accounts/{accountId}/statements
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

statementIdinteger
Example:1

Statement ID

startCycleinteger
Example:12

Cycle to start statements list. Only used when startFromCurrentCycle is true.

startFromCurrentCycleboolean
Example:true

If startFromCurrentCycle is true and startCycle is not set, the request lists all cycles starting from the current cycle. For example, if the current cycle is cycle 10, the endpoint returns the cycles in this order: 10, 9, 8, 7, 6, 5, 4, 3, 2, 1.

If startFromCurrentCycle is true and startCycle is set, the request lists all cycles starting from startCycle. For example, if the current cycle is cycle 10, and startCycle is 5, the endpoint returns the cycles in this order: 5, 4, 3, 2, 1.

presentToFrontboolean

List all statements starting from the current cycle? <b>Note:</b> This field is ignored if startFromCurrentCycle is set to true.

presentToPastboolean
Example:true

Exclude future statements? If true, the endpoint returns only the current cycle and all previous cycles. <b>Note:</b> This field is ignored if startFromCurrentCycle or presentToFront are set to true.

beginDueDatestring date
Example:2025-02-01

Beginning due date. Don't return statements with a due date earlier than this.

If beginDueDate is provided, endDueDate must also be provided.

endDueDatestring date
Example:2025-06-01

Ending due date. Don't return statements with a due date later than this.

If endDueDate is provided, beginDueDate must also be provided.

maxClosedCyclesinteger
Example:2

Maximum number of closed statements to return. For example, if a customer has 20 past statements, and maxClosedCycles = 5, the endpoint only returns the last 5 closed statements.

pageinteger
Example:1

Page number

perPageinteger
Example:10

Items per page. Default is 10.

Response

Ok

current_pageinteger

Current page

per_pageinteger

Items per page

total_itemsinteger

Number of items found

items_on_pageinteger

Number of items on this page

pagesinteger

Number of pages

is_last_pageboolean

Is this the last page?

Example response

{
  "items": [
    {
      "statement_id": 9497889,
      "status": "CLOSED",
      "cycle": 1,
      "previous_balance": 99.99,
      "debits": 42.5,
      "credits": 20,
      "current_balance": 99.99,
      "posted_date": "2022-02-11",
      "minimum_payment": 10.35,
      "amount_due": 705,
      "amount_paid_until_due_date": 300,
      "calendar": {
        "calendar_id": 57868,
        "program_due_date_id": 3812,
        "program_id": 1052,
        "cycle_closing_date": "2021-05-14",
        "due_date": "2021-05-24",
        "real_due_date": "2021-05-24"
      },
      "evolve_to_delinquency": true
    }
  ],
  "current_page": 2,
  "per_page": 10,
  "total_items": 100,
  "items_on_page": 5,
  "pages": 4,
  "is_last_page": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.