PIpismo
Program transaction categories

List program transaction categories

List program transaction categories with filtering options.

get/statements-v2/v1/transactions-categories

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/transactions-categories
  • Auth
    HTTP bearer

Query parameters

transactionCategoryIdinteger[]

One or more program transaction category ID's

[
  1,
  2
]
transactionCategoryDescriptionstring
Example:Internal

Transaction category description

If program transaction categories are defined for a program, you can view them in Control Center by navigating to the <b>Program information</b> page (Configurations > Programs > Program information) and selecting the <b>Transaction categories</b> tab. The transactionCategoryDescription field corresponds to the <b>Transaction category name</b> column on that page.

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.

program-idstring required

Program ID

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": [
    {
      "transaction_category_id": 1,
      "transaction_category_description": "purchase",
      "refinancing_rate_after_due_date": 15.99,
      "default_rate": 1,
      "fine_rate": 2,
      "overdue_rate_after_due_date": 17.99,
      "minimum_value": 1,
      "charge_order": 2,
      "secondary_charge_order": 7,
      "program_id": 1052,
      "programs": [
        1,
        2
      ]
    }
  ],
  "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.