List transactions

GET/v1/payouts/{sourceId}/transactions

Path parameters

sourceId string required

An opaque payout resource identifier.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1T

Query parameters

filter[id] string

Filter payouts by id. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A

filter[amount] string

Filter payouts by amount. Use operator.value syntax.

eq, neq, gt, gte, lt, lte operators

Exampleeq.100.00

filter[direction] string

Filter payouts by direction. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.inbound

filter[createdAt] string

Filter payouts by createdAt. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, is operators

Exampleeq.2026-01-15T12:00:00Z

filter[bankAccountId] string

Filter payouts by bankAccountId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A

filter[originalId] string

Filter payouts by originalId. Use operator.value syntax.

eq, neq, gt, gte, lt, lte, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A

filter[sourceId] string

Filter payouts by sourceId. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.01JQ2T5Y5Q3R8W9N6M4K2H7P1A

filter[sourceType] string

Filter payouts by sourceType. Use operator.value syntax.

eq, neq, in operators

Exampleeq.invoice

filter[currencyCode] string

Filter payouts by currencyCode. Use operator.value syntax.

eq, neq, in, is operators

Exampleeq.SAR

select string

Comma-separated fields. Select a declared relation with relation(field,field).

declared fields and relations only

Exampleid,source

order string

Order by field.asc or field.desc. Repeat fields with commas.

repeat fields separated by commas

Exampleid.asc,amount.asc

limit integer

Maximum records returned. Defaults to 25.

1 to 1000

Example25

cursor string

Opaque continuation cursor returned by the previous page.

Exampleopaque-cursor

count string

Request an exact count. This may cost more than a normal page.

exact

Exampleexact

search string

Search matching resource fields.

Exampleconsulting

Query options

Use filter, select, order, limit, cursor, count, search. The default limit is 25; the maximum is 1000.

Filterable: id, amount, direction, createdAt, bankAccountId, originalId, sourceId, sourceType, currencyCode.

Selectable: id, source, amount, direction, currency, createdAt, bankAccountId, accountLabel, originalId, context.

Sortable: id, amount, direction, createdAt, bankAccountId, originalId, sourceId, sourceType, currencyCode.

Errors: invalid_input, query_invalid, unauthenticated, not_found, forbidden, plan_limit, conflict, rate_limited, request_quota, unavailable, internal_error.

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY

workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Financial sources describe what the money or wealth represents: Invoice, Income, Expense, Payout, and Asset.

Transactions describe cash events against a source. A source can be unpaid or partially paid; a Transaction records an actual cash movement.

Payment status and settlement dates come from Transactions; source headers do not accept a separate paidAt value.

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

data object[]

Returned records. Collections and batches use an array; single records use an object.

ShowHide 10 properties

data[].id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1T

data[].source object

source for this payout.

ShowHide 2 properties

data[].source.id string

Opaque identifier for this resource or reference.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1T

data[].source.type string

Type of the record or operation.

Allowed values: "invoice", "expense", "income", "payout", "asset"

Exampleinvoice

data[].amount string

Exact decimal string used for financial calculations. Do not round or convert it to a display number.

Example100.00

data[].direction string

direction for this payout.

Allowed values: "inbound", "outbound"

Exampleoutbound

data[].currency object

Referenced currency with its opaque ID and ISO 4217 currency code.

ShowHide 3 properties

data[].currency.id string

Opaque identifier for this resource or reference.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1F

data[].currency.code string

ISO 4217 currency code, such as SAR or USD.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR

data[].currency.conversion object

Currency conversion quote used for reporting, including source, target, and rate.

ShowHide 3 properties

data[].currency.conversion.from string

ISO 4217 code of the source currency in this persisted quote.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR

data[].currency.conversion.to string

ISO 4217 code of the target reporting currency in this persisted quote.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleSAR

data[].currency.conversion.rate string

Exact decimal conversion rate from the quote source currency to its target currency.

Maximum length: 128 characters.

Example1.00

data[].bankAccountId string

ID of the related bank account.

Examplenull

data[].accountLabel string nullable

account label for this payout.

ExampleConsulting services

data[].originalId string

ID of the related original.

ExampleConsulting services

data[].context object

context for this payout.

ShowHide 3 properties

data[].context.heading string

heading within context.

ExampleOperating account

data[].context.subheading string

subheading within context.

ExampleOperating account

data[].context.websites string[]

websites within context.

Example1 item

data[].createdAt string

ISO 8601 timestamp for the authored or payment event. Recurring records preserve their scheduled occurrence.

Example2026-01-15T12:00:00.000Z

page object

Pagination metadata for the returned records, or the current page number when this endpoint uses numbered pages.

ShowHide 4 properties

page.limit number

Maximum number of records to return for this page.

Example1

page.hasMore boolean

Whether another page is available.

Examplefalse

page.nextCursor string

Opaque cursor for the next page, or null when there is no next page.

Examplenull

page.total number nullable

Total number of records that match the request.

Example1

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error object

Error details returned for a failed request.

ShowHide 4 properties

error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input

error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.

error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request

error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}

View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗

curl --include --fail-with-body --request GET "${NQD_API_URL:-http://api.nqd.localhost:1335}/v1/payouts/01JQ2T5Y5Q3R8W9N6M4K2H7P1T/transactions" \ -H "Authorization: Bearer $NQD_API_KEY" \ -H "Workspace-Id: $NQD_WORKSPACE_ID"

{ "data": [ { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1T", "source": { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1T", "type": "invoice" }, "amount": "100.00", "direction": "outbound", "currency": { "id": "01JQ2T5Y5Q3R8W9N6M4K2H7P1F", "code": "SAR", "conversion": { "from": "SAR", "to": "SAR", "rate": "1.00" } }, "bankAccountId": null, "originalId": "Consulting services", "context": { "heading": "Operating account", "subheading": "Operating account", "websites": [ "https://example.com/hooks/nqd" ] }, "createdAt": "2026-01-15T12:00:00.000Z" } ], "page": { "limit": 1, "hasMore": false, "nextCursor": null } }