GET STARTED
RECIPIENT
FINANCIAL ACCOUNT
PAYMENT REASON
TRANSACTION
NOTE
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 API key included in the request.
GET/api/external/v1/transactions
Basic Auth REQUIRED
username is your API key ID and password is your API key secret.
filter
object
Limit the results based on the following fields.
provider
string enum, values: ACH, MC_SEND
Provider facilitating the transaction.
requestorId
string (UUID)
ID of the entity requesting the transaction. This could be a RocketKOR Business Account, Recipient Account, Team Member, or customer.
receiverId
string (UUID)
ID of the receiver of the disbursed funds. This could be a RocketKOR Business Account, Recipient Account, Team Member, or customer.
createdDateFrom
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the transaction was created in the RocketKOR system. This filter will return transactions created on or after this date and time.
createdDateTo
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the transaction was created in the RocketKOR system. This filter will return transactions created on or before this date and time.
timeZone
string
Time zone for the transaction.
amountFrom
number, minimum value: 0
Amount of the transaction. This filter will return transactions with an amount equal to or greater than this amount.
amountTo
number, minimum value: 0
Amount of the transaction. This filter will return transactions with an amount equal to or less than this amount.
latestStatus
object, values: NEW, SENT, PENDING, APPROVED, DECLINED, CANCELLED, REVERSED, ERROR, SETTLED, RECEIVED, CLEARED
Current status of the transaction.
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).
sort
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.
page
integer (int32)
Page number to return.
size
integer (int32)
Maximum number of results to return per page.
Returns a paginated response with an array of transaction objects. The following fields are returned for each transaction.
id
string (UUID)
Unique ID for the transaction in the RocketKOR system.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the transaction was created in the RocketKOR system.
debitFinancialAccountId
string (UUID)
ID for the Financial Account used as the funding account (source of the disbursed funds).
debitFinancialAccountSnapshotId
string (UUID)
ID for the snapshot of the Financial Account used as the funding account. This information is captured in order to have a record of the account at the time of the transaction.
maskedDebitAccountNumber
string
Masked number for the bank account or card account linked to the Financial Account.
creditFinancialAccountId
string (UUID)
ID for the Financial Account used as the deposit account (receiver of the disbursed funds).
creditFinancialAccountSnapshotId
string (UUID)
ID for the snapshot of the Financial Account used as the deposit account. This information is captured in order to have a record of the account at the time of the transaction.
maskedCreditAccountNumber
string
Masked number for the bank account or card account linked to the Financial Account.
paymentReasonId
string (UUID)
Payment reason ID for the transaction. Use the Payment Reasons API to retrieve a list of available payment reason IDs and their corresponding descriptions.
paymentReason
string
Description of the payment reason. Use the Payment Reasons API to retrieve a list of available payment reason IDs and their corresponding descriptions.
amount
number, minimum value: 0
Amount to be disbursed from the debit account to the credit account. Must be a positive number.
provider
string enum, values: ACH, MC_SEND
Provider facilitating the transaction.
currency
string
Type of currency used for the transaction. RocketKOR currently supports USD and CAD currency.
countryCode
string, max length: 3, min length: 2
3-digit country code for the transaction country of origin.
requestorId
string (UUID)
ID of the entity that requested the transaction creation. This could be a RocketKOR Business Account (if the transaction is created via an API) or a Team Member (if the transaction is created in the RocketKOR Portal).
requestorType
string enum, values: BUSINESS_ACCOUNT, EMPLOYEE
Type of requestor specified in requestorId.
requestedSendDate
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Reserved for future use.
businessAccountId
string (UUID)
ID of the Business Account that contains the debit and credit accounts for the transaction.
receiverId
string (UUID)
ID of the receiver of the disbursed funds. This could be a Business Account or Recipient Account.
receiverType
string enum, values: BUSINESS_ACCOUNT, RECIPIENT
Type of receiver for the ID specified in receiverId.
recipientDto
object
Recipient Account details.
id
string (UUID)
Unique ID assigned to the Recipient Account.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was created.
updatedAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was last updated.
requestorId
string, max length: 40, min length: 0
ID of the entity that requested the Recipient Account creation. This could be a RocketKOR Business Account (if the account is created via an API) or a Team Member (if the account is created in the RocketKOR Portal).
businessAccountId
string (UUID)
ID of the Business Account that the Recipient Account belongs to.
clientId
string, max length: 40, min length: 0
ID of the client application interacting with the RocketKOR system.
businessRefId
string, max length: 40, min length: 0
Your organization’s internal reference number assigned to the Recipient Account. This reference number is not used by RocketKOR.
createdSource
string, max length: 40, min length: 0
Application used to create the Recipient Account, such as a RocketKOR API, the RocketKOR Portal, or an iframe.
firstName
string, max length: 40, min length: 0
Recipient’s first name.
middleName
string, max length: 40, min length: 0
Recipient’s middle name.
lastName
string, max length: 40, min length: 0
Recipient’s last name.
secondLastName
string, max length: 40, min length: 0
Recipient’s second last name.
string, max length: 100, min length: 0
Recipient’s email address.
phoneNumber
string, max length: 40, min length: 0
Recipient’s phone number.
nationality
string, max length: 40, min length: 0
Recipient’s nationality.
dateOfBirth
string (date), required format: YYYY-MM-DD
Recipient’s date of birth.
additionalInformation
string, max length: 500, min length: 0
Additional information or notes about the recipient.
recipientType
string, values: BUSINESS, INDIVIDUAL
Type of recipient.
businessName
string, max length: 40, min length: 0
Business name. Required if recipientType is BUSINESS.
state
string, values: ACTIVE, SUSPENDED
Current status of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.
latestStatus
object
Current status of the transaction.
id
string (UUID)
Unique ID for the transaction status in the RocketKOR system.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the status was assigned to the transaction.
transactionId
string (UUID)
Unique ID for the transaction in the provider system.
status
string, values: NEW, APPROVED, DECLINED, CANCELLED, REVERSED, REJECTED, SENT, SETTLED
Transaction status. Possible values include:
message
string, max length: 1000, min length: 0
Success or error messages related to the transaction.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 100,
"number": 1,
"numberOfElements": 1,
"hasNext": true,
"content": [
{
"id": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"createdAt": "2021-07-01T17:40:22.601Z",
"debitFinancialAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"debitFinancialAccountSnapshotId": "1wl83a98-1243-6856-g3sg-2s680s13pkm3",
"maskedDebitAccountNumber": "**** 5784",
"creditFinancialAccountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"creditFinancialAccountSnapshotId": "5ws94h37-1792-6523-r3jn-9z754i34kin5",
"maskedCreditAccountNumber": "**** 6999",
"paymentReasonId": "bf982522-d9f4-461e-8e33-4e3fbd44176d",
"paymentReason": "Reimbursement of customer expenses",
"amount": 1000.00,
"provider": "MC_SEND",
"currency": "USD",
"countryCode": "CAN",
"requestorId": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
"requestorType": "BUSINESS_ACCOUNT",
"requestedSendDate": "",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"receiverId": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
"receiverType": "RECIPIENT",
"recipientDto": {
"id": "9kj43t32-2956-2886-x7dy-6r821w39kra3",
"requestorId": "8hb21a87-3985-9217-a6zq-5y643x47hsa7",
"businessAccountId": "4hy47a98-2453-9867-u3qa-5p347q98kim4",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2021-07-01T17:40:22.601Z",
"businessRefId": "6ja43q62-0978-2536-b5ap-4i872q65kjt3",
"createdSource": "SDK iOS",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"secondLastName": "",
"email": "jsmith@xyz.com",
"phoneNumber": "4161234567",
"nationality": "Canadian",
"dateOfBirth": "1970-07-08",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": ""
"state": "ACTIVE"
},
"latestStatus": {
"id": "7wd40g39-2150-2435-c3hy-3c216e28bzj0",
"createdAt": "2021-07-01T17:40:22.601Z",
"transactionId": "2av81w47-9367-1295-h4ng-1q520p28wfn1",
"status": "NEW",
"message": "Transaction creation successful"
}
}
]
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2022 by Rocket Financial Inc. All rights reserved.