Search STP Transactions

Search for an STP (straight-through processing) transaction. You can search based on filters such as the Recipient’s name, phone number, and email address; the date the transaction was created; and the transaction status.

Note The search is limited to STP transactions for the Business Account associated with the request access token.

Endpoint

GET /v1/stp-transactions

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

name

string

Recipient’s firstName or lastName.

phoneNumber

string

Recipient’s phone number.

string

Recipient’s email address.

createdAt

string, format: yyyy-MM-dd

Date the STP transaction was created.

status

string enum, values: COMPLETED, ERROR

Transaction status. The following values are supported:

COMPLETED The transaction has been completed.
FAILED The transaction could not be processed due to one or more errors (for example, the network is unavailable after a number of retries).

timeZone

string (timeZone), default value: UTC

Timezone for the createdAt filter. The following values are supported:

Z, UTC or GMT UTC
{+,-}N(N)(:MM) Zone offset in hours and minutes
UTC+<offset>, UTC-<offset>, GMT+<offset>, GMT-<offset>
IANA Time Zone Database region ID (example: the value for America/New_York is -04)

Note This filter does not affect dates in the response, which always use UTC.

page

integer (int32), default value: 1

Page number to return. Uses one-based indexing.

size

integer (int32), default value: 30

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of STP transactions matching the request filters. The following fields are returned.

requestId

string

Reference ID for the STP transaction request.

name

string

Recipient’s first and last name.

string

Recipient’s email address.

phoneNumber

string

Recipient’s phone number.

status

string enum, values: COMPLETED, ERROR

Transaction status. The following values are supported:

COMPLETED The transaction has been completed.
FAILED The transaction could not be processed due to one or more errors (for example, the network is unavailable after a number of retries).

createdAt

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

Date the STP transaction was created in the RocketKOR system.

createdBy

string

Entity that created the STP transaction.

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:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

SAMPLE RESPONSE

				
					{
  "result": [
    {
      "requestId": "91a950b0-cd9f-41c5-b413-788f8c0d3390",
      "name": "ABC Corporation",
      "email": "jsmith@abc.com",
      "phoneNumber": "55512345678",
      "status": "COMPLETED",
      "createdAt": "2023-07-25T16:07:38.349480Z",
      "createdBy": {
        "id": "b6333b53-3222-4227-a71e-718b25ca3ea4",
        "type": "service-account"
      }
    },
    {...},
    {...}
  ],
  "totalElements": 3
}