List transactions for an Organization

get

https://api.benjipays.com/v2/transactions

Returns paginated payment transactions for the organization associated with the authenticated API key. Matches the data visible in the merchant-app transaction reporting table, including enriched settlement fields. Filter by date range, transaction type/status, accounting customer, gateway, and more.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startDate

string

length ≤ 10

Start of date range. Format: YYYY-MM-DD (e.g. 2024-01-15). Interpreted as UTC — transactions are matched from 00:00:00 UTC on this date (inclusive). Must be provided together with endDate. Ignored when status=inprocess.

endDate

string

length ≤ 10

End of date range. Format: YYYY-MM-DD (e.g. 2024-01-31). Interpreted as UTC — transactions are matched up to 00:00:00 UTC on this date, so this end day is not itself included; to include a full day, pass the following date. Must be provided together with startDate. Ignored when status=inprocess.

type

string

length ≤ 50

Filter by transaction type. Accepted values: payment, void, refund, deposit.

status

string

length ≤ 50

Filter by transaction status. Accepted values: approved, declined, inprocess. When inprocess, startDate/endDate are ignored.

customerId

string

length ≤ 200

Filter to a single customer by their accounting system ID (QuickBooks Id, Xero ContactID, Business Central id, QBD ListID).

string

length ≤ 200

Free-text search across transaction fields (customer name, invoice number, reference, etc.).

gatewayId

string

length ≤ 200

Filter to a specific gateway store/terminal identifier.

gatewayProcessor

string

length ≤ 50

Filter by payment processor. Accepted values: benjipayments, bambora, moneris, helcim, globalpayments, epg (same public keys returned in the response).

currency

string

length ≤ 10

Filter by currency code (e.g. USD, CAD).

cardType

string

length ≤ 50

Filter by card brand (e.g. Visa, Mastercard, Amex).

amountMin

string

length ≤ 20

Minimum transaction amount filter (inclusive). Use a decimal string, e.g. 10.00.

amountMax

string

length ≤ 20

Maximum transaction amount filter (inclusive). Use a decimal string, e.g. 500.00.

invoiceId

string

length ≤ 200

Filter to transactions associated with a specific invoice. Use the invoice ID from your accounting system (QuickBooks Id, Xero InvoiceID, Business Central id, etc.).

hasSurcharge

string

enum

Filter to transactions that have (true) or do not have (false) a surcharge.

Allowed:

sort

string

length ≤ 50

Field to sort by. Accepted values: transactionDate (default), invoiceNumber, customerName, result, status.

order

string

enum

Sort direction. Accepted values: asc (default), desc.

Allowed:

limit

integer

1 to 100

Defaults to 20

offset

integer

0 to 9007199254740991

Defaults to 0

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Paginated transaction list

401Unauthorized

403Forbidden — missing required OAuth scope (organizations:transactions:read) and/or insufficient live mapping permission on the API key owner (e.g. companyAdmin). Scope and mapping are independent gates; see response detail.

404Organization not found

429Too Many Requests