POST api/Transaction/GetTransactionsByTransactionDate

Get transactions within a given date range from a UserInstitutionAccount

Request Information

URI Parameters

None.

Body Parameters

GetTransactionByDateParams
NameDescriptionTypeAdditional information
AccountID

Guid-type AccountID of a UserInstitutionAccount

globally unique identifier

None.

StartDate

Transactions retrieved must not be earlier than this start date. Date format, e.g. "2018/10/01"

date

None.

EndDate

Transactions retrieved must not be later than this end date. Date format, e.g. "2018/10/31"

date

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountID": "5184707d-b569-4121-b342-ed4192e2ea8c",
  "StartDate": "2024-05-01T21:52:28.5994818+00:00",
  "EndDate": "2024-05-01T21:52:28.5994818+00:00"
}

application/xml, text/xml

Sample:
Coming soon.

Response Information

Resource Description

List of transactions within the given date ranger from the given account.

Collection of TransactionInformation
NameDescriptionTypeAdditional information
CheckImage

If Transaction's a check, CheckImage includes the link to download the check image (Optional).

string

None.

UserInstitutionAccountID

Guid-type ID of the UserInstitutionAccount from which the transaction was downloaded.

globally unique identifier

None.

TransactionID

Guid-type ID of the Transaction.

globally unique identifier

None.

Status

Transaction's Status such as "Pending", "Posted" (Optional).

string

None.

Type

Transaction's Type such as "DEBIT", "CREDIT" (Optional).

string

None.

Amount

Transaction's Amount.

decimal number

None.

Currency

Transaction's Currency symbol, such as "$" (Optional).

string

None.

Date

Transaction's Date.

date

None.

TransactionDate

Transaction's Transaction Date.

date

None.

PostDate

Transaction's Posted Date.

date

None.

Description

Transaction's Description.

string

None.

Balance

Transaction's Running Balance.

decimal number

None.

Merchant

Transaction's Merchant information (Optional).

string

None.

Category

Transaction's Category information (Optional).

string

None.

CheckNum

Transaction's Check Number information (Optional).

string

None.

Memo

Transaction's Memo information (Optional).

string

None.

LastModified

Transaction's last modified date

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UserInstitutionAccountID": "a5a15a65-0b39-47a1-bc3e-15121eeb2371",
    "TransactionID": "a6b0b453-5644-494a-ae9c-fda8a0743a77",
    "Status": "sample string 3",
    "Type": "sample string 4",
    "Amount": 1.0,
    "Currency": "sample string 5",
    "Date": "2024-05-01T21:52:28.6151202+00:00",
    "TransactionDate": "2024-05-01T21:52:28.6151202+00:00",
    "PostDate": "2024-05-01T21:52:28.6151202+00:00",
    "Description": "sample string 6",
    "Balance": 1.0,
    "Merchant": "sample string 7",
    "Category": "sample string 8",
    "CheckNum": "sample string 9",
    "Memo": "sample string 10",
    "LastModified": "2024-05-01T21:52:28.6151202+00:00",
    "CheckImage": "sample string 1"
  },
  {
    "UserInstitutionAccountID": "a5a15a65-0b39-47a1-bc3e-15121eeb2371",
    "TransactionID": "a6b0b453-5644-494a-ae9c-fda8a0743a77",
    "Status": "sample string 3",
    "Type": "sample string 4",
    "Amount": 1.0,
    "Currency": "sample string 5",
    "Date": "2024-05-01T21:52:28.6151202+00:00",
    "TransactionDate": "2024-05-01T21:52:28.6151202+00:00",
    "PostDate": "2024-05-01T21:52:28.6151202+00:00",
    "Description": "sample string 6",
    "Balance": 1.0,
    "Merchant": "sample string 7",
    "Category": "sample string 8",
    "CheckNum": "sample string 9",
    "Memo": "sample string 10",
    "LastModified": "2024-05-01T21:52:28.6151202+00:00",
    "CheckImage": "sample string 1"
  }
]

application/xml, text/xml

Sample:
Coming soon.