Skip to content

Lists process transactions

Request

GET {{baseURL}}/pay-api/v1/transactions

This endpoint returns a list of transactions details.

See Also:
To create a transaction, see POST /pay-api/v1/transactions/sale.
To retrieve a transaction by ID, see GET /pay-api/v1/transactions/{transactionId}.
To capture a transaction, see POST /pay-api/v1/transactions/capture.
To void a transaction, see POST /pay-api/v1/transactions/void.

Security
Bearer
Query
pageinteger, (int32)

Specifies the page number of the returned search results.

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

Default:0
pageSizeinteger, (int32)

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize value.

The maximum page value is the pageSize divided by the total count rounded up. The count is zero-based. For example, if pageSize is 50 and the total is 130, there are three pages. The maximum page value is 2.

Example: 50

Default:15
orderBystring

Specifies the field the results get ordered by.

The sort order is specified by the asc value.

Example: contactName

ascboolean

Specifies the sort order.

The sort field is specified by the orderBy value.

If true, the sort order is ascending.
If false, the sort order is descending.

Example: false

Default:false
createMethodIdinteger, (int32)

Valid values are:

idnameexplanation
1PortalCreated from the Flute merchant portal (web dashboard).
2ApiTokenCreated from a direct API call authenticated with an API token.
3TerminalCreated at a physical POS terminal.
4InvoiceCreated from an invoice payment.
5QuickPaymentCreated from a Quick Payment / payment link.
6WebComponentCreated from an embedded web payment component, such as Flute Elements.
7SubscriptionCreated by a recurring subscription billing cycle.
8MobileAppCreated from a mobile app integration.
9TapToPayCreated from tap-to-pay (contactless) on a mobile device.

Example: 3

Example:createMethodId=3
createdByIdstring, (uuid)

Specifies the transaction creator's identifier.

Example: 109fb6fb-91bf-442a-a9cb-051255ff72b0

Example:createdById=109fb6fb-91bf-442a-a9cb-051255ff72b0
batchIdstring, (uuid)

Specifies the identifier assigned to the batch that contains one or more ACH (automated clearing house) transactions.

Example: 44a56eab-82c8-46de-bc07-021371be4721

Example:batchId=44a56eab-82c8-46de-bc07-021371be4721
noBatchboolean

Specifies the transaction should bypass normal ACH (automated clearing house) batching.

The transaction will be processed individually instead of being grouped with other ACH transactions.

If true, the transaction will be processed individually instead of being grouped with other ACH transactions.
If false, the transaction will be not processed individually but will be grouped with other ACH transactions.

Example: false

Default:true
Example:noBatch=false
curl -i -X GET \
  'https://developer.flute.com/_mock/api-reference/pay-api/v1/transactions?page=0&pageSize=15&orderBy=string&asc=false&createMethodId=3&createdById=109fb6fb-91bf-442a-a9cb-051255ff72b0&batchId=44a56eab-82c8-46de-bc07-021371be4721&noBatch=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects or null

Transactions for the current page.

totalinteger, (int32)

Indicates the total number of ISV transactions found.

Example: 5

Example:5
Response

Total = amount of items, Items = transactions list value

{ "total": 16, "items": [ { "id": "29de5986-c7f6-4100-a06b-3f686912d1f7", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.333986Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "afbf5d22-2415-4092-8329-b06073c71b24", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "552cb98d-0290-44e6-8c7c-a72120254b6d", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340022Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "5d6e7f8a-9b0c-4d1e-a2b3-4c5d6e7f8a3", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "2f844bdd-9909-4032-84a8-86f7ef552104", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "58a51103-66a0-45e2-90b7-73be91099acf", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340065Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "7a8b9c0d-1e2f-4a3b-b4c5-6d7e8f9a0b47", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "65244302-eb98-4b6e-988f-683cf982eef2", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "1278544f-1de7-450a-9e01-7813109ed384", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340106Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "0f1e2d3c-4b5a-4c6d-a7b8-9c0d1e2f3a58", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "c68f7446-e98e-402f-a51b-7b13a7fadd4f", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "77a1802c-9142-4e9f-882e-bbb30775f450", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340153Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "4c5d6e7f-8a9b-4c0d-b1e2-3f4a5b6c7d69", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "john@example.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "b1060c57-cffa-45ff-8cc0-881b7faea27d", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "a3ee8fde-3760-4083-967c-6422197873bf", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340195Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f03", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "b0ae7792-7c10-43e2-9390-04bd7c546289", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "e8558f26-9242-438f-86cc-54e9a36deff5", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340239Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "a7b8c9d0-e1f2-4a3b-4c5d-6e7f8a9b0c36", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "cd97928e-7f02-47fa-88df-6d652b57f416", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "8c526ade-3fc4-40d0-a168-458ef1d513cc", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340281Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "f5cef7ba-76b5-47af-8732-9eeefd0c5515", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "0d8abb05-1684-46ec-a8ef-a86f1f868630", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340322Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "8eb5f348-caf6-4f73-bb31-c7b2962595bd", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "242f3908-6588-4351-bb92-5e91df319e06", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340358Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "03d9f39b-3fa4-4adb-a5d5-d079079c33b3", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "635e5351-09a9-4cb0-8a77-172456ebe823", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340397Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "552d6292-af5d-44fa-a173-563e08814e37", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "ed36b508-b702-4425-8b0f-dc71c6e840a2", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340437Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "3c5294d1-ef42-4b1b-bfcc-25e22b5d11ef", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "8e159fea-aff2-4124-9da8-d4941f0b1824", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340506Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "ceb7d3ba-c74e-460c-a279-5884df767316", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "51fbfefb-3ace-493f-93c3-1bef1cf65692", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3340663Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 1, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "0094b6c4-4224-4427-b43e-94e6bb18033b", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "809d0d5a-199a-4dcf-bb08-a90cbaee7bd1", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.334097Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b25", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "75e63e0a-6171-44f1-b553-280dadc575de", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null }, { "id": "a4a491e8-8091-458e-be19-f1239e21405f", "paymentProcessorId": "b40e4e57-33b2-45c9-ba78-2e54837f8f48", "date": "2025-12-16T10:35:52.3341016Z", "baseAmount": 1.1, "totalAmount": 1.1, "surchargeAmount": 0, "surchargePercentage": 0, "currencyCode": "USD", "currencyId": 1, "merchant": "Merchant", "merchantId": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a14", "operationMode": null, "paymentMethodType": "Card", "paymentMethodTypeId": 1, "paymentMethodName": "Cafe Peppared", "customerName": "John", "customerCompany": "Company", "customerPan": "************4512", "cardTokenType": 2, "customerEmail": "e@mail.com", "customerPhone": "+12105554618", "status": "Captured", "statusId": 2, "typeId": 3, "type": "Capture", "batchId": null, "source": { "typeId": 1, "type": "Portal", "id": "d2e1e4af-a8fe-4bf2-8ec3-6d3c24e30add", "name": "SourceName" }, "availableOperations": [ { "typeId": 4, "type": "Void", "availableAmount": 1.1, "suggestedTips": null } ], "amount": null } ] }