Skip to main content
GET
Retrieve money transactions

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

transactions.readonly

Read transactions

transactions

Read and write transactions

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

createDate[gte]
string

Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z

createDate[lte]
string

Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z

customerRef
string<uuid>

UUID of the company or user whose money transactions to list.

limit
integer

Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose money transactions to list.

nextPageToken
string

Token to retrieve the next page of results.

status
string

Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded.

type
string

Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription.

Response

OK

transactions
object[]
required

List of money transactions.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.