Design / Transaction Use Cases / Search Transactions

Search Transactions

Overview

In this use case, we’ll walk through searching for transactions based on filters such as the creation date, amount, and status. For example, you could retrieve all transactions created within a specific date range, or retrieve all transactions with a specific status.

Note The search is limited to transactions for the Business Account associated with the access token included in the request.

API Operation

Search Transactions

Steps

Send a request to the following endpoint:

GET /v1/transactions

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Filter the results based on fields such as the creation date, amount, status, debit or credit Financial Account, and transaction type. For a full list of possible filters, see the API Reference.
Use the sort query parameter to sort the results.
Use the page and size query parameters to limit the number of results returned.
Request body is not required.

Sample Response

Returns a paginated response with an array of Transaction objects. Details are returned for each transaction.

				
					{
  "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": ""
    },
    {...},
    {...}
  ]
}

Search Transactions

Overview

API Operation

Steps

Sample Response

ON THIS PAGE