PIpismo
Transactions

Get transaction

Get a specific transaction by its ID. You can use the List transactions endpoint to search for a transaction and get its ID.

get/v2/transactions/{transactionId}

Request

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

Path parameters

transactionIdinteger required

Transaction ID

Query parameters

includeMetadataboolean

Return transaction metadata flag.

Response

OK

idinteger

Transaction ID

program_idinteger

Program ID

account_idinteger

Account ID

statement_idinteger

Statement ID

installmentinteger

Transaction installment number

number_of_installmentsinteger

Total number of installments

soft_descriptorstring

Soft descriptor of transaction. This is the description that shows on the customer's statement after it is authorized, but before it is settled.

processing_codestring

Processing code used to create the transaction.

processing_descriptionstring

Processing code description

customer_idinteger

Customer ID

user_categorystring

User category

transaction_groupstring

Transaction group

entry_modestring

Transaction Entry Mode

event_datestring date-time

Event timestamp in the UTC (zero-hour offset) ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).

event_datetimestring date-time

Event timestamp in the UTC (zero-hour offset) RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).

payment_datestring date-time

Payment timestamp provided by the user in the ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).

payment_datetimestring date-time

Payment timestamp provided by the user in the RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).

created_atstring date-time

Transaction creation date (ISO 8601)

metadataobject

This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "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.