Search for transactions based on filters such as the Provider, status, requestor, and receiver. 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 requested the transaction creation.
createdByType
string enum, values: EMPLOYEE, CUSTOMER, SERVICE_ACCOUNT, RECIPIENT
Type of entity that requested the transaction creation.createdDateFrom
string (date), required 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), required 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: 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. Possible values are: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 card 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 enum, values: push-to-card, ach
Name of the RocketKOR solution used for the transaction. Possible values are:
transactionType
string enum, values: SEND, REQUEST, REVERSAL
Type of transaction. Possible values are:
batchId
string (UUID)
ID of the batch that the transaction originated from.
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 [string]
Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.
None
Returns a paginated response with an array of Transaction objects.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 100,
"number": 1,
"numberOfElements": 1,
"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",
"createdAt": "2021-07-01T17:40:22.601Z"
},
"createdAt": "2021-07-01T17:40:22.601Z",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"reversalReason": ""
},
{...},
{...}
]
}
© 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.