PIpismo
Transactions

List transactions

List transactions without their metadata. If you provide at least one of the following parameters, the eventDateStart parameter is optional.

  • id
  • authorizationId
  • authorizationIds
  • statementId
  • authorizationTrackingId
  • numberOfLatestTransactions

If you don't provide any of the above parameters, you must include the eventDateStart parameter, and the maximum allowed query range is 90 days.

get/v2/transactions

Request

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

Query parameters

statementIdinteger

Statement ID

customerIdinteger

Customer ID

transactionTypeIdinteger

Transaction type ID filter.

processingCodestring

Processing code

creditboolean

Show only credit (true) or debit (false) transactions.

statementPostboolean

Filter on StatementPost field. This field indicates whether a transaction should be posted to the statement.

authorizationIdinteger
Example:1

The authorization ID

authorizationType'NETWORK' | 'PLATFORM'

The authorization type

eventDateStartstring
Example:2021-06-26T12:03:04Z

Event date period start in date (YYYY-MM-DD) or date-time (YYYY-MM-DDThh:mm:ssZ) format

order'asc' | 'desc'

The order of the result set. The results are always ordered by transaction date. This param indicates whether the order is ascending or descending.

eventDateEndstring
Example:2021-06-26T12:03:04Z

Event date period end in date (YYYY-MM-DD) or date-time (YYYY-MM-DDThh:mm:ssZ) format

numberOfLatestTransactionsinteger

Number of latest transactions. This filter gets the specified number of latest transactions, overwrites page filters, and doesn't allow any other filters with it.

authorizationTrackingIdstring

Authorization tracking ID

pageSizeinteger

Maximum number of transactions per page. If not provided, defaults to 100. Must be between 1 and 1000.

pageOffsetinteger

Page offset of transactions. Indicates which page to start with when returning the results. Defaults to 0. Must be between 0 and 5000.

idsinteger[]

Array of transaction IDs

userCategorystring

User category

paymentMethodIdstring

Payment method ID

Response

OK

has_nextboolean

Indicates whether there are more pages after the current page.

Example response

{
  "items": [
    {
      "id": 1111,
      "program_id": 2222,
      "account_id": 1234,
      "statement_id": 2345,
      "installment": 2,
      "number_of_installments": 20,
      "processing_code": "00",
      "processing_description": "Purchase",
      "customer_id": 8675309,
      "user_category": "SERVICES",
      "transaction_group": "EXPENSES",
      "entry_mode": "POS",
      "amount": [
        {
          "currency": "USD"
        }
      ],
      "tax": [
        {
          "currency": "BRL"
        }
      ],
      "event_date": "2022-08-24T19:15:24.000Z",
      "event_datetime": "2022-08-24T19:15:24.000Z",
      "payment_date": "2022-08-24T20:13:24.000Z",
      "payment_datetime": "2022-08-24T20:13:24.000Z",
      "created_at": "2022-08-24T19:05:24.000Z",
      "transaction_type": {
        "id": 203,
        "description": "Credit voucher",
        "credit": true,
        "posted_transaction": true,
        "balance_impact_id": 4,
        "category": "PAYMENTS/CREDITS"
      }
    }
  ]
}

Changes

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