Get all Transactions
Get all Transactions in a paginated listing, sorted by ascending requestedAt
.
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
- 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. Thenext_url
meta key in the response will use the last item in the response. This is especially useful when fetchingstate=requested
transactions while simultaneously PATCHing to avoid page order problems and getting more predictable chunks.
- 200
All the transactions in a paginated listing.
- application/json
- Schema
- Example (from schema)
Schema
transactions object[]
Array [- oneOf
- transaction.Deposit
- transaction.Withdrawal
- transaction.Internal
type string requiredPossible values: [
Deposit
]id string requiredexternalId stringtransferConsentId uuiduser object required
type string requiredid string requiredexternalId stringamountCents integer requiredstate string requiredPossible values: [
requested
,settled
,failed
]requestedAt RFC3339 requiredsettledAt RFC3339failedAt RFC3339toAccount object required
type string requiredid string requiredexternalId stringtoDream object
type string requiredid string requiredname string requiredtype string requiredPossible values: [
Withdrawal
]id string requiredexternalId stringtransferConsentId uuiduser object required
type string requiredid string requiredexternalId stringamountCents integer requiredstate string requiredPossible values: [
requested
,settled
,failed
]requestedAt RFC3339 requiredsettledAt RFC3339failedAt RFC3339fromAccount object required
type string requiredid string requiredexternalId stringfromDream object
type string requiredid string requiredname string requiredtype string requiredPossible values: [
Internal
]id string requiredexternalId stringtransferConsentId uuiduser object required
type string requiredid string requiredexternalId stringamountCents integer requiredstate string requiredPossible values: [
requested
,settled
,failed
]requestedAt RFC3339 requiredsettledAt RFC3339failedAt RFC3339fromAccount object required
type string requiredid string requiredexternalId stringfromDream object
type string requiredid string requiredname string requiredtoAccount object required
type string requiredid string requiredexternalId stringtoDream object
type string requiredid string requiredname string required]meta object
next_url urlURL for the next page.
count integerThe total count of items.
items integerThe number of returned items on this page.
pages integerThe number of pages.
from integerIndex of the first item on this page (starting from 1).
to integerIndex of the last item on this page.
{
"transactions": [
{
"type": "Deposit",
"id": "c0079a71-55f1-483f-b848-19efc4ff654a",
"externalId": "txn_12345",
"transferConsentId": "7c5aabe3-d1f1-4e57-9874-04cac40f8a2d",
"user": {
"type": "User",
"id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
"externalId": "usr_12345"
},
"amountCents": 12350,
"state": "settled",
"requestedAt": "2023-03-22T10:09:15Z",
"settledAt": "2023-03-22T10:11:56Z",
"toAccount": {
"type": "SharedSavings",
"id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
"externalId": "acc_12345"
}
},
{
"type": "Withdrawal",
"id": "c0079a71-55f1-483f-b848-19efc4ff654a",
"externalId": "txn_12345",
"user": {
"type": "User",
"id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
"externalId": "usr_12345"
},
"amountCents": 12350,
"state": "settled",
"requestedAt": "2023-03-22T10:09:15Z",
"settledAt": "2023-03-22T10:11:56Z",
"fromAccount": {
"type": "SharedSavings",
"id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
"externalId": "acc_12345"
}
},
{
"type": "Internal",
"id": "c0079a71-55f1-483f-b848-19efc4ff654a",
"externalId": "txn_12345",
"user": {
"type": "User",
"id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
"externalId": "usr_12345"
},
"amountCents": 12350,
"state": "settled",
"requestedAt": "2023-03-22T10:09:15Z",
"settledAt": "2023-03-22T10:11:56Z",
"toAccount": {
"type": "SharedSavings",
"id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
"externalId": "acc_12345"
},
"fromAccount": {
"type": "Performance",
"id": "d98da36d-b963-4866-bde2-87845b7d0714",
"externalId": "acc_12346"
}
}
],
"meta": true
}