The Scheduled Transaction Summary object represents the transactions that have been created for a scheduled transaction. A scheduled transaction can be a one-time transaction or a series of recurring transactions.
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. ACH transactions must include one or more of the following metadata parameters.
|
Parameter |
Description |
|---|---|
|
rkorACHEntryType |
Required for all ACH transactions. ACH Standard Entry Class Code. The following codes are supported. For more information, see ACH File Details.
|
|
rkorACHIndividualId |
Required if rkorACHEntryType is CIE, PPD, or TEL. Individual Identification Number. |
|
rkorACHCheckSerialNumber |
Required if rkorACHEntryType is ARC, BOC, POP, or RCK. Check Serial Number. |
|
rkorACHTerminalCity |
Required if rkorACHEntryType is POP. Terminal City. |
|
rkorACHTerminalState |
Required if rkorACHEntryType is POP. Terminal State. |
The following metadata parameters are returned in the response.
|
Parameter |
Description |
|---|---|
|
rkorProvider |
ACH Provider. Possible values are PAYGEARS and SNB. |
|
rkorTransactionType |
Transaction Type. Possible values are SEND, REQUEST and RETURN. |
|
rkorReasonCode |
Return Reason Code. Present in RETURN transaction responses. |
|
rkorReasonDescription |
Return Reason Description. Present in RETURN transaction responses. |
|
rkorDiscretionaryData |
Return Transaction Identifier. Present in RETURN transaction responses. |
debitFinancialAccountId
string (UUID)
ID of the Financial Account used as the debit account (source of the funds) for the transaction.
creditFinancialAccountId
string (UUID)
ID of the Financial Account used as the credit account (receiver of the funds) for the transaction.
transactionType
string enum, values: SEND, REQUEST, REVERSAL, RETURN, ADJUSTMENT, DEPOSIT, WITHDRAWAL
Type of transaction. The following values are supported:
solution
string
Name of the RocketKOR solution used for the transaction.
paymentReasonId
string
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 (decimal)
Amount to be transferred from the debit account to the credit account. Must be a positive number. The 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 value: IMMEDIATE
Expected priority for settling the transaction. The following values are supported:
This parameter is configurable for some RocketKOR solutions, such as ACH and Wire.
Notes:
createdAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the transaction was created in the RocketKOR system.
requestor
object
Entity that created the transaction.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
description
string, max length: 100
Required for the Wire solution. Not available for other solutions.
Brief description of the transaction. If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.
memo
string, max length: 100
Only available for the Wire solution.
Brief additional note about the transaction. If the value exceeds the maximum length, the value will be truncated to 100 characters when the transaction is submitted for processing.
id
string (UUID)
ID of the transaction in the RocketKOR system.
latestStatus
object
Current status of the transaction.
status
string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR
Transaction status. The following values are supported:
message
string
Success or error message related to the transaction.
createdBy
object
Entity that created the transaction status.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, service-account, internal
Type of entity. The following values are supported:
createdAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the status was assigned to the transaction.
reversalReason
string enum, values: DUPLICATE_PAYMENT, INCORRECT_RECIPIENT, INCORRECT_AMOUNT
Applies to REVERSAL transactions only. Reason the transaction was reversed. The following values are supported:
Scheduled Transaction Summary Object
{
"businessAccountId": "bf8714ed-501e-4a48-a11d-d2613350b643",
"metadata": {
"rkorACHEntryType": "CCD",
"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",
"createdAt": "2023-10-30T21:12:32.366Z",
"requestor": {
"id": "fd1c6009-a35c-4ddf-a4c8-dd946af7b647",
"type": "service-account"
},
"description": "",
"memo": "",
"id": "7c195208-6801-4cf8-a7e2-74b790084331",
"latestStatus": {
"status": "NEW",
"message": "Transaction creation successful",
"createdBy": {
"id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
"type": "service-account"
},
"createdAt": "2021-07-01T17:40:22.601Z"
},
"reversalReason": ""
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2023 RocketKOR, Inc. All rights reserved.
