RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Transaction Object

The Transaction object represents the movement of funds between two RocketKOR Financial Accounts. This includes SEND and REQUEST transactions, which are both originated on the RocketKOR system.

Attributes

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: 5, value max length: 1024

Use a maximum of 5 key/value pairs to store additional information with a transaction.

debitFinancialAccountId

string (UUID)

ID for the Financial Account used as the funding account (source of the disbursed funds).

creditFinancialAccountId

string (UUID)

ID for the Financial Account used as the deposit account (receiver of the disbursed funds).

transactionType

string enum, values: SEND, REQUEST

Type of transaction. Possible values are:

  • SEND  Instruction to push funds from a Financial Account to another account.
  • REQUEST  Instruction to pull funds to a Financial Account from another account.
SEND and REQUEST transactions are originated on RocketKOR.

solution

string enum, values: push-to-card

Name of the RocketKOR solution used for the transaction.

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

number, minimum value: 0

Amount to be disbursed 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.

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:
  • NEW  Transaction has been created in RocketKOR.
  • PENDING  Transaction has been moved from the Transaction Domain to one of the Processing Domains. The transaction is still in the RocketKOR system (meaning it has not been transmitted to the Provider for processing) and is in a state where it can be cancelled.
  • PROCESSING  One of the following is true: (a) the transaction is in a Processing Domain in the RocketKOR system but can no longer be cancelled, or (b) the transaction has been transmitted to the Provider for processing.
  • APPROVED  Disbursement has been approved by the Provider.
  • SETTLED  Transaction has been settled by the Provider.
  • CLEARED  The Sponsor has indicated that funds movement for the transaction is complete. The funds are now available in the Master Settlement Account (MSA). This status is only applicable to “received” transactions.
  • CANCELLED  Transaction has been cancelled by the user.
  • DECLINED  Disbursement has been declined by the Provider.
  • REVERSED  Transaction has been reversed by the user.
  • ERROR  The transaction could not be processed due to one or more errors that the user cannot recover from (for example, the Provider system is unavailable after a number of retries). The Error status is only activated after the system determines that it cannot continue processing the transaction.

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, RECIPIENT

Type of entity that requested the transaction creation. Possible values are:
  • EMPLOYEE  Team Member using the RocketKOR Portal.
  • SERVICE_ACCOUNT  Service Account using APIs.
  • RECIPIENT  Recipient Account.

The 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",
  "solution": "push-to-card",
  "paymentReasonId": "loan-payouts",
  "paymentReason": "Loan Payouts",
  "amount": 1000.00,
  "currency": "USD",
  "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"
  }
}