Retrieve a Transaction’s Status History

Retrieve a list of statuses for a transaction. These are the statuses that have been assigned to the transaction during the transaction processing lifecycle.

Endpoint

GET /v1/transactions/{transactionId}/status

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

transactionId REQUIRED

string (UUID)

ID of the transaction in the RocketKOR system.

Request Body

None

Returns

Returns an array of Transaction Status objects. The following fields are returned for each transaction status.

createdAt

string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the status was assigned to the transaction.

status

string enum, values: NEW, PENDING, PROCESSING, APPROVED, SETTLED, CLEARED, CANCELLED, DECLINED, REVERSED, ERROR

Transaction status. The following values are supported:

NEW The transaction has been created in RocketKOR.
PENDING The 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 The 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 The transaction has been cancelled.
DECLINED Disbursement has been declined by the Provider.
REVERSED A transaction was submitted by RocketKOR to move funds in the opposite direction of the initial transaction. This “reverses” the transaction by moving the funds back to the original account.
ERROR The transaction could not be processed due to one or more errors (for example, the Provider system is unavailable after a number of retries). The Error status is only activated after RocketKOR determines that it cannot continue processing the transaction.

message

string

Success or error message related to the transaction.

SAMPLE RESPONSE

				
					[
  {
    "status": "APPROVED",
    "message": "Send from ACH Provider",
    "createdBy": {
      "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
      "type": "service-account"
    },
    "createdAt": "2023-02-03T05:00:05.634158Z"
  },
  {
    "status": "PROCESSING",
    "message": "Send from ACH Provider",
    "createdBy": {
      "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
      "type": "service-account"
    },
    "createdAt": "2023-02-03T04:00:05.634158Z"
  },
  {
    "status": "PENDING",
    "message": "Send to processing domain",
    "createdBy": {
      "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
      "type": "service-account"
    },
    "createdAt": "2023-02-03T03:00:05.634158Z"
  },
  {
    "status": "NEW",
    "message": "Transaction just created",
    "createdBy": {
      "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
      "type": "service-account"
    },
    "createdAt": "2023-02-03T02:00:05.634158Z"
  }
]