PIpismo
Statement

List transaction balances

List transaction balances.

Use this endpoint to retrieve the details for one or more transactions. This endpoint could be useful if your customer has a dispute or needs credit card refinancing.

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/v1/accounts/{accountId}/transactions-balance

Request

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

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

statementIdinteger
Example:1

Statement ID

transactionIdsinteger[]

Transaction IDs

[
  1,
  2
]
transactionTypeIdinteger[]

One or more transaction type IDs

[
  101,
  112
]
hasBalanceboolean
Example:true

Should returned transactions have a positive balance? true: Return only transactions with balance > 0. false: Return only transactions with balance = 0. Default is all transactions.

pageinteger
Example:1

Page number

perPageinteger
Example:10

Items per page. Default is 10.

withStatementsboolean
Example:true

If true, a 200 response includes the following additional fields for each transaction.

  • statement_id
  • cycle
  • cycle_closing_date
  • due_date
  • real_due_date
  • previous_balance
  • debits
  • credits
  • current_balance
  • minimum_payment
  • status
balanceType'OPEN' | 'CLOSED' | 'CLOSED_NOT_DUE' | 'FUTURE'
Example:OPEN

Filter the results by balance type. Possible values:

  • OPEN: Statement is open. This is the current statement, before cycle closing.
  • CLOSED: Statement is closed, and the due date has already passed.
  • CLOSED_NOT_DUE: Statement is closed, but the due date has not yet passed. In other words, the current date is between the statement's cycle closing date and due date.
  • FUTURE: Future statement. That is, a statement that has not been opened yet. Statements with this status usually include installments from purchases that will be due in future billing cycles.

<b>Note:</b> You can only filter by balance type if with_statement is set to true. If with_statement is not set or is set to false, the balanceType parameter is ignored.

Response

Ok

current_pageinteger

Current page

per_pageinteger

Items per page

total_itemsinteger

Number of items found

pagesinteger

Number of pages

is_last_pageboolean

Is this the last page?

Example response

{
  "current_page": 2,
  "per_page": 10,
  "total_items": 100,
  "pages": 4,
  "is_last_page": true,
  "items": [
    {
      "transaction_id": 77489,
      "program_id": 1052,
      "statement_id": 9497889,
      "amount": 150,
      "tax_amount": 7.99,
      "interest_rate": 15.99,
      "interest_amount": 12.35,
      "balance_amount": 43,
      "event_datetime": "2023-02-22T15:17:05",
      "installment_number": 1,
      "number_of_installments": 8,
      "transaction_type_id": 342,
      "statement": {
        "statement_id": 9497889,
        "cycle": 1,
        "cycle_closing_date": "2021-05-14",
        "due_date": "2021-05-24",
        "real_due_date": "2021-05-24",
        "previous_balance": 99.99,
        "debits": 42.5,
        "credits": 20,
        "current_balance": 99.99,
        "minimum_payment": 10.35,
        "status": "CLOSED"
      }
    }
  ]
}

Changes

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