Skip to main content

Get all Transactions

GET 
/transactions

Get all Transactions in a paginated listing, sorted by ascending requestedAt.

Request​

Query Parameters

    page integer

    Possible values: >= 1

    Default value: 1

    The page number in a paginated listing.

    items integer

    Possible values: >= 1 and <= 100

    Default value: 20

    The number of items to return on each page.

    externalId string

    Filter records by externalId

    externalUserId string

    Filter records by externalUserId

    state string

    Possible values: [requested, settled, failed]

    after_id string

    Omits the page query parameter and gets items after specified id or the first available one if left empty. The next_url meta key in the response will use the last item in the response. This is especially useful when fetching state=requested transactions while simultaneously PATCHing to avoid page order problems and getting more predictable chunks.

Responses​

All the transactions in a paginated listing.

Schema

    transactions

    object[]

  • Array [

    • oneOf

    type stringrequired

    Possible values: [Deposit]

    id stringrequired
    externalId string
    transferConsentId uuid

    user

    object

    required

    type stringrequired
    id stringrequired
    externalId string
    amountCents integerrequired
    state stringrequired

    Possible values: [requested, settled, failed]

    requestedAt RFC3339required
    settledAt RFC3339
    failedAt RFC3339

    toAccount

    object

    required

    type stringrequired
    id stringrequired
    externalId string

    toDream

    object

    type stringrequired
    id stringrequired
    name stringrequired

  • ]

    • meta

    object

    next_url url

    URL for the next page.

    items integer

    The number of returned items on this page.

Loading...