Browse the docs

Reference · Transactions

List transactions

GEThttps://api.paygoro.com/v1/transactions

Lists transactions across the workspace, newest booking date first. Paginated; filter by account, date range, status, direction or category. For incremental sync, store the newest `updatedAt` you have seen and pass it as `updatedAfter`.

Authorization

Requires a bearer API key with transactions:read. See Authentication.

Query parameters

NameTypeDescription
companyIdstringRestrict to one legal entity. Omit to include every entity in the workspace.
accountIdstringRestrict to one account.
dateFromstring (date)Inclusive lower bound on the booking date.
dateTostring (date)Inclusive upper bound on the booking date.
status"pending" | "booked" | "rejected" | "released" | "canceled"
side"debit" | "credit"
categoryIdstringRestrict to one category.
updatedAfterstring (date-time)Only transactions created or changed after this instant. The building block for incremental sync.
limitintegerPage size, 1–100. Defaults to 50.
cursorstringOpaque pagination cursor from a previous response's `nextCursor`.

Response

200 · application/json

FieldTypeDescription
dataarray of object
nextCursorstring | nullPass as `cursor` to fetch the next page. `null` when this is the last page.
idstringOpaque resource id.
companyIdstringOpaque resource id.
accountIdstringOpaque resource id.
amountstringUnsigned amount in the transaction currency. Use `side` for direction.
currencystringISO 4217 currency code, e.g. EUR.max 3 chars
side"debit" | "credit" | null`credit` = money in, `debit` = money out.
status"pending" | "booked" | "rejected" | "released" | "canceled"
type"SepaCredit" | "SepaDirect" | "Card" | "InternalCredit" | "InternalDirectDebit" | "FeeCredit" | "FeeDebit" | "Check" | "Other" | null
descriptionstring | nullBank-provided label or description.
referencestring | nullPayment reference / remittance information.
counterpartyNamestring | null
counterpartyIbanstring | null
merchantNamestring | nullCleaned merchant name from Paygoro's enrichment, when known.
bookingDatestring (date) | null
valueDatestring (date) | null
categoryobject | null
createdAtstring (date-time)Timestamp in RFC 3339 format (UTC).
updatedAtstring (date-time)Changes when the bank updates the row or a category is assigned. Poll with `updatedAfter` to sync incrementally.
idstringOpaque resource id.
namestring
slugstring

Errors

400BAD_REQUESTThe request was malformed or failed validation.
401UNAUTHORIZEDMissing, malformed, expired or revoked API key.
403FORBIDDENThe API key does not have the scope this operation requires.
404NOT_FOUNDNo resource with this id exists in your workspace, or a `companyId` filter does not match one of your companies.
429TOO_MANY_REQUESTSRate limit exceeded. Retry after the `Retry-After` header.

All errors share one envelope — see Errors.