Skip to main content
GET
/
v1
/
transactions
/
sync
Incrementally sync transactions
curl --request GET \
  --url https://api.waycore.com/v1/transactions/sync \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "type": "added",
      "transaction": {
        "id": "<string>",
        "connectionId": "<string>",
        "accountId": "<string>",
        "status": "pending",
        "postedDate": "2023-12-25",
        "updatedAt": "2023-11-07T05:31:56Z",
        "amount": "<string>",
        "currency": "<string>",
        "entryType": "credit",
        "description": "<string>",
        "rail": "internalTransfer",
        "rawDescription": "<string>",
        "paymentReference": "<string>",
        "bankReference": "<string>",
        "baiCode": "<string>",
        "category": "<string>",
        "subcategory": "<string>",
        "mcc": "<string>",
        "merchantName": "<string>",
        "counterpartyName": "<string>",
        "counterpartyAccountMasked": "<string>"
      }
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true,
  "meta": {
    "requestId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0 Client Credentials issuing JWT Bearer access tokens.

Query Parameters

cursor
string | null

Opaque cursor returned by a previous /transactions/sync response. Omit on the first call to initialise the stream.

limit
integer
default:100

Maximum number of change events to return.

Required range: 1 <= x <= 500
fields
string | null

Comma-separated sparse fieldset applied to embedded transaction objects. The server always includes required identifiers.

accountId
string | null

Limit the stream to a single account. If used, keep it consistent for the lifetime of the cursor stream.

connectionId
string | null

Limit the stream to a single connection. If used, keep it consistent for the lifetime of the cursor stream.

Response

Successful Response

events
(TransactionUpsertEvent · object | TransactionRemovedEvent · object)[]
required

Change events ordered by (updatedAt, id) ascending. Clients should process events in order and persist nextCursor.

nextCursor
string
required

Opaque cursor to use on the next sync call.

hasMore
boolean
required

Whether more change events are immediately available.

meta
Meta · object
required