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

    id uuid
    targetCents integer

    Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.

    type string
    expiresAt RFC3339

    (Optional) DateTime before which the User wants to complete this Dream.

    achievedAt RFC3339

    Represents when the dream was completed

    name string
    balanceCents integer

    Current balance cents for dream

    deletedAt RFC3339

    Represents when the dream was deleted

    imageUrl string
    activeSavehacksCount integer

    Current count of active savehacks

    user

    object

    type stringrequired
    id stringrequired
    externalId string

    groupDream

    object

    (Optional) GroupDream this Dream is a part of.

    type stringrequired
    id stringrequired

    account

    object

    Identifies the account where all money towards this dream is stored

    type stringrequired
    id stringrequired
    externalId string

    dreamInspiration

    object

    nullable

    (Optional) The Dream Inspiration this Dream was created from.

    id uuidrequired

    translatedName

    object

    [locale] string
    targetCents integer

    Possible values: >= 1 and <= 9223372036854776000

    Default value: 0

    durationSeconds integer
    imageUrl string
    type stringrequired

    Possible values: [DreamInspiration]

  • ]

    • meta

    object

    next_url url

    URL for the next page.

    items integer

    The number of returned items on this page.

Loading...