Search for transactions based on filters such as the date, amount, status, and account. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.
Note The search is limited to transactions for the Business Account associated with the request access token.
GET /v1/transactions
Authorization: Bearer <access_token>
createdById
string (UUID)
ID of the entity that created the transaction.
createdByType
string enum, values: EMPLOYEE, CUSTOMER, SERVICE_ACCOUNT, RECIPIENT
Type of entity that created the transaction. The following values are supported:
createdDateFrom
string (date), format: yyyy-MM-dd
Date the transaction was created in the RocketKOR system. This filter will return transactions created on or after this date.
Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.
createdDateTo
string (date), format: yyyy-MM-dd
Date the transaction was created in the RocketKOR system. This filter will return transactions created on or before this date.
Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.
timeZone
string (timeZone), default value: UTC
Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:
amountFrom
number
Amount of the transaction. This filter will return transactions with an amount equal to or greater than this amount.
amountTo
number
Amount of the transaction. This filter will return transactions with an amount equal to or less than this amount.
latestStatus
string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR
Transaction status. The following values are supported:
maskedDebitAccountNumber
string
Masked account number for the bank account or card account used as the debit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).
maskedCreditAccountNumber
string
Masked account number for the bank account or card account used as the credit account for the transaction. Enter the last 4 digits of the account number (for example: 4242). Optionally, you can enter asterisks for the rest of the account number (for example: ********4242).
solution
string
Name of the RocketKOR solution used for the transaction.
transactionType
string enum, values: SEND, REQUEST, REVERSAL
Type of transaction. The following values are supported:
SEND, REQUEST, and REVERSAL transactions are originated on RocketKOR.
origin
string enum, values: SINGLE, BATCH
Whether the transaction originated from a single transaction request or from a transaction batch.
batchId
string (UUID)
ID of the batch from which the transaction originated.
page
integer (int32)
Page number to return, based on zero-based page index.
size
integer (int32)
Maximum number of results to return per page.
sort
array of strings
Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.
None
Returns a paginated response with an array of Transaction objects.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 20,
"number": 0,
"numberOfElements": 5,
"hasNext": true,
"content": [
{
"id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"metadata": {
"myPaymentId": "100000333",
"invoiceNumber": "123232333",
"authorizedBy": "user@email.com"
},
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"transactionType": "SEND",
"solution": "ach",
"paymentReasonId": "loan-payouts",
"paymentReason": "Loan Payouts",
"amount": "1000.00",
"currency": "USD",
"settlementPriority": "SAME_DAY",
"latestStatus": {
"status": "NEW",
"message": "Transaction creation successful",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z"
},
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z",
"reversalReason": "",
"description": "",
"memo": ""
},
{...},
{...},
{...},
{...}
]
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.