GET STARTED

RECIPIENT

FINANCIAL ACCOUNT

PAYMENT REASON

TRANSACTION

NOTE

Retrieve Transaction Status

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

Use the page and size query parameters to limit the number of results returned.

Endpoint

GET /api/external/v1/transactions/{transactionId}/status

Authorization Header

Basic Auth  REQUIRED

username is your API key ID and password is your API key secret.

Path Parameters

transactionId  REQUIRED

string (UUID)

Transaction ID in the provider system.

Query Parameters

page

integer (int32)

Page number to return.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of transaction status objects. The following fields are returned for each transaction status.

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:

  • NEW  Transaction created in RocketKOR.
  • APPROVED  Disbursement approved by the provider.
  • DECLINED  Disbursement declined by the provider.
  • CANCELLED  Transaction cancelled by the user.
  • REVERSED  Transaction reversed by the user.
  • REJECTED  Transaction rejected by RocketKOR.
  • SENT  Transaction sent to the provider.
  • SETTLED  Transaction settled by the provider.

message

string, max length: 1000, min length: 0

Success or error messages related to the transaction.

SAMPLE RESPONSE

				
					{
  "totalElements": 1,
  "totalPages": 1,
  "number": 1,
  "numberOfElements": 1,
  "hasNext": false,
  "content": [
    {
      "id": "9qw98h31-3978-2498-g2ko-8w965t32kwe6",
      "createdAt": "2021-07-01T17:40:22.601Z",
      "transactionId": "8hb21a87-3985-9217-a6zq-5y643x47hsa7",
      "status": "NEW",
      "message": "Transaction creation successful"
    }
  ]
}