Discharge tracking

List discharges

Track discharges for an account. A discharge occurs when a credit transaction is used to reduce the balance of a debit transaction. This endpoint returns a list of credit transactions along with the debit transactions that they were used to discharge. You can filter the list by creditTransactionId, CreditTransactionBeginDate, and CreditTransactionEndDate.

If an invalid value is entered for creditTransactionBeginDate or creditTransactionEndDate, the endpoint returns 400 - Bad Request. An example of an invalid value would be if creditTransactionEndDate is an earlier date than creditTransactionBeginDate or if creditTransactionBeginDate is more than 184 days in the past.

get/statements-v2/v1/accounts/{accountId}/discharges-tracking

Request

Base URL
https://sandbox.pismolabs.io
URL
https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}/discharges-tracking
Auth
HTTP bearer

Path parameters

accountIdinteger required

Example:101

Account ID

Query parameters

creditTransactionIdinteger

Example:1

Credit transaction ID

creditTransactionBeginDatestring date

Example:2023-01-01

Start date to filter credit transactions. If not provided, it defaults to today's date minus 184 days. Format = yyyy-mm-dd.

This endpoint returns no credit transactions older than 184 days, so creditTransactionBeginDate must be greater than the current date minus 185 days.

creditTransactionEndDatestring date

Example:2023-01-01

End date to filter credit transactions. If not provided, it defaults to creditTransactionBeginDate plus 184 days. Format = yyyy-mm-dd.

pageinteger

Example:1

Page number

perPageinteger

Example:10

Items per page. Default is 10.

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Response

current_pageinteger

Current page

is_last_pageboolean

Is this the last page?

items_on_pageinteger

Number of items on this page

pagesinteger

Number of pages

per_pageinteger

Items per page

total_itemsinteger

Number of items found

Example response

{
  "current_page": 2,
  "is_last_page": true,
  "items": [
    {
      "discharge_order": 4,
      "payment_hierarchy_id": "e4259b9a-db06-4ff0-9812-204cef409465",
      "transaction_id": 77489,
      "statement_id": 9497889,
      "transaction_amount": 150,
      "transaction_type_id": 342,
      "customer_id": 12456721,
      "account_id": 1010,
      "program_id": 1052,
      "program_type_id": 1,
      "event_datetime": "2023-02-22T15:17:05",
      "payment_datetime": "2021-04-14T12:00:00-03:00",
      "target": [
        {
          "transaction_id": 77489,
          "statement_id": 9497889,
          "transaction_type_id": 342,
          "customer_id": 12456721,
          "account_id": 1010,
          "event_datetime": "2023-02-22T15:17:05",
          "discharge_datetime": "2023-02-22T15:17:05",
          "transaction_amount": 150,
          "discharge_amount": 600,
          "previous_balance": 99.99
        }
      ]
    }
  ],
  "items_on_page": 5,
  "pages": 4,
  "per_page": 10,
  "total_items": 100
}

Changes

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