Search for a LinX Session

Search for a previously created LinX session to send money to a Customer’s debit card. You can search based on filters such as the Customer name, phone number, and email address; the session status; and the date the session was created.

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

Endpoint

GET /v1/linx/send

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

name

string

Filter results based on the Customer’s name. Searches the customer.firstName and customer.lastName fields.

phoneNumber

string

Filter results based on the Customer’s full phone number. Partial phone numbers are not accepted.

string

Filter results based on the Customer’s email address.

createdAt

string, required format: YYYY-MM-DD

Filter the results by the date the LinX session was created in the RocketKOR system.

expiry

string, required format: YYYY-MM-DD

Filter the results by the date the LinX session will expire.

status

string enum, values: ACTIVE, CANCELLED, COMPLETED, DECLINED, EXPIRED

Filter the results by the status of the LinX session. The following values are supported:

ACTIVE The LinX request is active and the Customer has been notified. Waiting for Customer response.
CANCELLED The LinX request was cancelled by an employee.
COMPLETED The LinX request was completed by the Customer.
DECLINED The LinX request was declined by the Customer.
EXPIRED The LinX request expired because the Customer did not respond before the end of the expiry period. The default expiry period is 90 days.

timeZone

string (timeZone), default: UTC

Time zone for the createdAt and expiry filters. 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)

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 LinX sessions matching the request filters. The following fields are returned.

requestId

string

Reference ID for the LinX request.

name

string

Customer’s first and last name.

string

Customer’s email address.

phoneNumber

string

Customer’s phone number.

status

string enum, values: ACTIVE, CANCELLED, COMPLETED, DECLINED, EXPIRED

Status of the LinX session. The following values are supported:

ACTIVE The LinX request is active and the Customer has been notified. Waiting for Customer response.
CANCELLED The LinX request was cancelled by an employee.
COMPLETED The LinX request was completed by the Customer.
DECLINED The LinX request was declined by the Customer.
EXPIRED The LinX request expired because the Customer did not respond before the end of the expiry period. The default expiry period is 90 days.

createdAt

string, required format: YYYY-MM-DD

Date the LinX session was created in the RocketKOR system.

createdBy

string (UUID)

ID of the Customer that requested the LinX session.

SAMPLE RESPONSE

				
					{
  "result": [
    {
      "requestId": "93f1e6dd-5dc7-4660-91cc-5cb949b74c6d",
      "name": "John Smith",
      "email": "jsmith@abc.com",
      "phoneNumber": "55512345678",
      "status": "ACTIVE",
      "createdAt": "2023-02-01T17:40:22.601Z",
      "createdBy": "Jane Doe"
    },
    {...},
    {...}
  ],
  "totalElements": 3
}