The Transaction object represents the movement of funds between two RocketKOR Financial Accounts using a SEND, REQUEST, or REVERSAL transaction. These transaction types are originated on the RocketKOR system.
id
string (UUID)
Unique ID for the transaction in the RocketKOR system.
businessAccountId
string (UUID)
ID of the Business Account that contains the debit and credit accounts for the transaction.
metadata
string, max items: 6, value max length: 1024
Use a maximum of 6 key/value pairs to store additional information with a transaction.
debitFinancialAccountId
string (UUID)
ID for the Financial Account used as the debit account (source of the funds) for the transaction.
creditFinancialAccountId
string (UUID)
ID for the Financial Account used as the credit account (receiver of the funds) for the transaction.
transactionType
string enum, values: SEND, REQUEST, REVERSAL
Type of transaction. Possible values are:
SEND, REQUEST, and REVERSAL transactions are originated on RocketKOR.
solution
string enum, values: push-to-card, ach
Name of the RocketKOR solution used for the transaction. Possible values are:
paymentReasonId
string
Unique ID representing the payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
paymentReason
string
Payment reason for the transaction. Use the Payment Reasons API to retrieve a list of available payment reasons.
amount
string
Amount to be transferred from the debit account to the credit account. Must be a positive number.
Note This amount must conform to any transaction limits.
currency
string
Currency used for the transaction. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.
settlementPriority
string enum, values: IMMEDIATE, SAME_DAY, NEXT_DAY, SCHEDULED
default: IMMEDIATE
Expected priority for settling the transaction. Possible values are:
This parameter is configurable for some RocketKOR solutions, such as ACH. Note that Push to Card transactions always use the IMMEDIATE settlement priority.
latestStatus
object
Current status of the transaction.
status
string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR
Transaction status. Possible values are:
message
string
Success or error message related to the transaction.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the status was assigned to the transaction.
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.
createdBy
object
Entity that requested the transaction creation.
id
string (UUID)
ID of the entity that requested the transaction creation.
type
string enum, values: EMPLOYEE, SERVICE_ACCOUNT
Type of entity that requested the transaction creation. Possible values are:
reversalReason
string enum, values: DUPLICATE_PAYMENT, INCORRECT_RECIPIENT, INCORRECT_AMOUNT
Applies to REVERSAL transactions only. Reason the transaction was reversed. Possible values are:
Transaction Object
{
"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.