--- updatedAt: 2026-06-29T20:36:51.000Z --- Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further. # 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. # OpenAPI definition ```json { "openapi": "3.1.0", "tags": [ { "name": "Transactions", "description": "Endpoints to retrieve transaction data." } ], "info": { "title": "Core platform - Transactions", "version": "1.0.0", "description": "API used to configure transactions domain and get transactions information.", "contact": { "name": "API Support", "url": "https://developers.pismo.io/support/" }, "license": { "name": "Copyright Pismo" } }, "servers": [ { "url": "https://sandbox.pismolabs.io/transactions-core", "description": "Sandbox API server for testing" } ], "components": { "parameters": { "authorizationType": { "in": "query", "name": "authorizationType", "description": "The authorization type", "schema": { "type": "string", "enum": [ "NETWORK", "PLATFORM" ] } }, "authorizationID": { "in": "query", "name": "authorizationId", "description": "The authorization ID", "schema": { "type": "integer", "format": "int64", "example": 1 } }, "customerID": { "in": "query", "name": "customerId", "description": "Customer ID", "schema": { "type": "integer", "format": "int64" } }, "statementID": { "in": "query", "name": "statementId", "description": "Statement ID", "schema": { "type": "integer", "format": "int64" } }, "eventDateStart": { "in": "query", "name": "eventDateStart", "description": "Event date period start", "schema": { "type": "string", "format": "date or date-time", "example": "2021-06-26T12:03:04Z" } }, "eventDateEnd": { "in": "query", "name": "eventDateEnd", "description": "Event date period end", "schema": { "type": "string", "format": "date or date-time", "example": "2021-06-26T12:03:04Z" } }, "numberOfLatestTransactions": { "in": "query", "name": "numberOfLatestTransactions", "description": "Number of latest transactions. Get the X latest transactions from the date specified in the `event_date` field. This filter overwrites page filters and doesn't allow any other filters with it.", "schema": { "type": "integer", "format": "int64", "maximum": 500, "minimum": 1 } }, "transactionTypeIdQuery": { "in": "query", "name": "transactionTypeId", "description": "Transaction type ID filter.", "schema": { "type": "integer", "format": "int64" }, "example": 101010 } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.", "bearerFormat": "JWT" } }, "schemas": { "TransactionType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Transaction type ID" }, "description": { "type": "string", "description": "Transaction type description", "maxLength": 30 }, "credit": { "type": "boolean", "description": "Indicates if the transaction type is a credit or debit operation." }, "posted_transaction": { "type": "boolean", "description": "Indicates whether transactions are posted on statements (`true`) or not (`false`)." }, "balance_impact_id": { "type": "integer", "format": "int64", "description": "Balance impact ID" }, "category": { "type": "string", "description": "Transaction type category" } }, "example": { "id": 203, "description": "Credit voucher", "credit": true, "posted_transaction": true, "balance_impact_id": 4, "category": "PAYMENTS/CREDITS" } }, "Card": { "type": "object", "description": "Contains details about the card used in a transaction.\n* For transactions from card network operations, this object includes card information.\n* For platform operations, this object is empty.\nWhether card information appears depends on what was provided during authorization, not on the transaction type.\n", "properties": { "id": { "type": "integer", "description": "Card ID" }, "name": { "type": "string", "description": "Card name" } } }, "Transaction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Transaction ID", "example": 1111 }, "program_id": { "type": "integer", "format": "int64", "description": "Program ID", "example": 2222 }, "account_id": { "type": "integer", "format": "int64", "description": "Account ID", "example": 1234 }, "statement_id": { "type": "integer", "format": "int64", "description": "Statement ID", "example": 2345 }, "installment": { "type": "integer", "description": "Transaction installment number", "example": 2 }, "number_of_installments": { "type": "integer", "description": "Total number of installments", "example": 20 }, "soft_descriptor": { "type": "string", "description": "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_code": { "type": "string", "description": "Processing code used to create the transaction.", "example": "00" }, "processing_description": { "type": "string", "description": "Processing code description", "example": "Purchase" }, "customer_id": { "type": "integer", "format": "int64", "description": "Customer ID", "example": 8675309 }, "user_category": { "type": "string", "description": "User category", "example": "SERVICES" }, "transaction_group": { "type": "string", "description": "Transaction group", "example": "EXPENSES", "deprecated": true }, "entry_mode": { "type": "string", "description": "Transaction Entry Mode", "example": "POS" }, "amount": { "type": "array", "items": { "$ref": "#/components/schemas/Amount" } }, "tax": { "type": "array", "description": "Transaction taxes", "items": { "$ref": "#/components/schemas/Tax" } }, "event_date": { "type": "string", "format": "date-time", "description": "Event timestamp in the UTC (zero-hour offset) ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).", "example": "2022-08-24T19:15:24.000Z" }, "event_datetime": { "type": "string", "format": "date-time", "description": "Event timestamp in the UTC (zero-hour offset) RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).", "example": "2022-08-24T19:15:24.000Z" }, "payment_date": { "type": "string", "format": "date-time", "description": "Payment timestamp provided by the user in the ISO 8601 format (yyyy-MM-ddThh:mm:ssZ).", "example": "2022-08-24T20:13:24.000Z" }, "payment_datetime": { "type": "string", "format": "date-time", "description": "Payment timestamp provided by the user in the RFC 3339 format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).", "example": "2022-08-24T20:13:24.000Z" }, "created_at": { "type": "string", "format": "date-time", "description": "Transaction creation date (ISO 8601)", "example": "2022-08-24T19:05:24.000Z" }, "transaction_type": { "$ref": "#/components/schemas/TransactionType" }, "card": { "$ref": "#/components/schemas/Card" }, "authorization": { "$ref": "#/components/schemas/Authorization" }, "merchant": { "$ref": "#/components/schemas/Merchant" } } }, "Amount": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PRINCIPAL", "LOCAL", "SETTLEMENT" ], "description": "Amount type \n - `PRINCIPAL`: Transaction amount in the customer’s account currency (already converted).\n - `LOCAL`: Transaction amount in the merchant’s local currency, where the purchase was made.\n - `SETTLEMENT`: Settlement amount that is typically defined by the issuer and usually matches the `PRINCIPAL` currency.\n" }, "currency": { "type": "string", "description": "ISO-4217 alphabetic code (3 characters) for transaction currency.", "example": "USD" }, "value": { "type": "number", "multipleOf": 0.01, "description": "Amount value" } } }, "Tax": { "type": "object", "properties": { "currency": { "description": "ISO-4217 alphabetic code (3 characters) for transaction currency.", "type": "string", "minLength": 0, "maxLength": 3, "example": "BRL" }, "type": { "type": "string", "enum": [ "IOF", "IOF_DAILY", "INTEREST" ], "description": "Tax type" }, "value": { "type": "number", "multipleOf": 0.01, "description": "Tax value" } } }, "Merchant": { "type": "object", "properties": { "id": { "type": "string", "description": "Merchant ID" }, "type": { "type": "string", "description": "Merchant type" }, "name": { "type": "string", "description": "Merchant name" }, "city": { "type": "string", "description": "Merchant city" }, "state": { "type": "string", "description": "Merchant's state. In some cases, for countries other than the U.S., it can indicate the country code of the merchant instead." }, "category": { "$ref": "#/components/schemas/MerchantCategory" } } }, "MerchantCategory": { "type": "object", "properties": { "code": { "type": "string", "description": "Merchant category code (MCC). Provided by the network (Visa or Mastercard)." }, "description": { "type": "string", "description": "Merchant category description" }, "group_name": { "type": "string", "description": "Merchant category group name" }, "network_group": { "type": "string", "description": "Merchant category group name sent by network" } } }, "Page": { "type": "object", "properties": { "has_next": { "type": "boolean", "description": "Indicates whether there are more pages after the current page." }, "items": { "type": "array", "description": "Items returned by the request", "items": { "type": "object" } } } }, "Authorization": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Authorization ID" }, "type": { "type": "string", "enum": [ "PLATFORM", "NETWORK" ], "description": "Authorization's type" }, "code": { "type": "string", "description": "Authorization code or Network Approval Code" }, "payment_method_id": { "type": "string", "description": "Payment method" }, "network": { "type": "string", "enum": [ "VISA", "MASTERCARD" ], "description": "Visa or Mastercard network" }, "tracking_id": { "type": "string", "description": "Idempotency tracking ID" }, "correlated_authorization_id": { "type": "integer", "format": "int64", "description": "Authorization ID generated by force or installment operations when the `original_authorization` field is provided. See the [Force operation](https://developers.pismo.io/pismo-docs/docs/force-operation) and [Installments payment](https://developers.pismo.io/pismo-docs/docs/installments-payment) guides for more information." }, "original_account_id": { "type": "integer", "format": "int64", "description": "Original account ID. This field is used when the transaction is linked to a authorizaiton that was made on a different account than the one being queried." } } }, "ErrorResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Error description." }, "error": { "type": "string", "description": "Error description." }, "code": { "type": "string", "description": "Code description." } } } } }, "security": [ { "BearerAuth": [] } ], "paths": { "/v2/transactions": { "get": { "tags": [ "Transactions" ], "summary": "List transactions", "operationId": "ListTransactions", "description": "List transactions without their metadata. If you provide at least one of the following parameters, the `eventDateStart` parameter is optional. \n- `id`\n- `authorizationId`\n- `authorizationIds`\n- `statementId`\n- `authorizationTrackingId`\n- `numberOfLatestTransactions`\n\nIf you don't provide any of the above parameters, you must include the `eventDateStart` parameter, and the maximum allowed query range is 90 days. \n", "parameters": [ { "$ref": "#/components/parameters/statementID" }, { "$ref": "#/components/parameters/customerID" }, { "$ref": "#/components/parameters/transactionTypeIdQuery" }, { "in": "query", "name": "processingCode", "description": "Processing code", "schema": { "type": "string" } }, { "in": "query", "name": "credit", "description": "Show only credit (`true`) or debit (`false`) transactions.", "schema": { "type": "boolean" } }, { "in": "query", "name": "statementPost", "description": "Filter on `StatementPost` field. This field indicates whether a transaction should be posted to the statement.", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/authorizationID" }, { "$ref": "#/components/parameters/authorizationType" }, { "$ref": "#/components/parameters/eventDateStart" }, { "in": "query", "name": "order", "description": "The order of the result set. The results are always ordered by transaction date. This param indicates whether the order is ascending or descending.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "$ref": "#/components/parameters/eventDateEnd" }, { "$ref": "#/components/parameters/numberOfLatestTransactions" }, { "in": "query", "name": "authorizationTrackingId", "description": "Authorization tracking ID", "schema": { "type": "string" } }, { "in": "query", "name": "pageSize", "description": "Maximum number of transactions per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "pageOffset", "description": "Page offset of transactions. Indicates which page to start with when returning the results. Defaults to 0.", "schema": { "type": "integer" } }, { "in": "query", "name": "ids", "description": "Array of transaction IDs", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" }, "minItems": 1, "maxItems": 100 }, "example": [ 10, 20, 30, 40, 50, 60 ] }, { "in": "query", "name": "userCategory", "description": "User category", "schema": { "type": "string" } }, { "in": "query", "name": "paymentMethodId", "description": "Payment method ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Page" }, { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } } } } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" } ] }, "examples": { "invalidRequestHeaders": { "summary": "Invalid request headers", "value": { "message": "Invalid request headers", "error": "Invalid request headers", "code": "WTRC00002" } }, "invalidRequestParameter": { "summary": "Invalid request parameters", "value": { "message": "Invalid request parameters", "error": "Invalid request parameters", "code": "WTRC00003" } }, "invalidFilterValue": { "summary": "Invalid filter value", "value": { "message": "Invalid filter value", "error": "Invalid filter value", "code": "WTRC00001" } }, "invalidNumberOfLatestTransactions": { "summary": "Number of latest transactions should not have another filter", "value": { "message": "numberOfLatestTransactions should not have another filters associate", "error": "numberOfLatestTransactions should not have another filters associate", "code": "WTRC00001" } }, "invalidNumberOfLatestTransactionsFilter": { "summary": "Number of latest transactions should be an integer", "value": { "message": "numberOfLatestTransactions should be an integer value", "error": "numberOfLatestTransactions should be an integer value", "code": "WTRC00001" } }, "invalidNumberOfLatestTransactionsRange": { "summary": "Invalid range for number of latest transactions", "value": { "message": "numberOfLatestTransactions should be between 1 and 500", "error": "numberOfLatestTransactions should be between 1 and 500", "code": "WTRC00001" } }, "invalidAuthorizationType": { "summary": "Invalid authorization type", "value": { "message": "authorization type should be PLATFORM or NETWORK", "error": "authorization type should be PLATFORM or NETWORK", "code": "WTRC00001" } }, "accountRequired": { "summary": "Account is required when querying by card ID", "value": { "message": "account is required when querying by cardId ", "error": "account is required when querying by cardId ", "code": "WTRC00001" } }, "eventDateStartRequired": { "summary": "Event date start not provided", "value": { "message": "eventDateStart not provided", "error": "eventDateStart not provided", "code": "WTRC00001" } }, "invalidEventDateStartFormat": { "summary": "Invalid event date start format", "value": { "message": "invalid eventDateStart format", "error": "invalid eventDateStart format", "code": "WTRC00001" } }, "invalidEventDateEndFormat": { "summary": "Invalid event date end format", "value": { "message": "invalid eventDateEnd format", "error": "invalid eventDateEnd format", "code": "WTRC00001" } }, "invalidTimeRange": { "summary": "Invalid time range", "value": { "message": "invalid time range: difference between eventDateStart and eventDateEnd cannot be greater than 90 days", "error": "invalid time range: difference between eventDateStart and eventDateEnd cannot be greater than 90 days", "code": "WTRC00001" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" } ] }, "examples": { "internalProcessingError": { "summary": "Internal processing error", "value": { "message": "Internal processing error", "error": "Internal processing error", "code": "ETRC00001" } } } } } } }, "deprecated": false } } } } ```