---
title: "elinx"
method: GET
path: "/elinx"
tags: ["eLinx Endpoints"]
---

# elinx

`GET /elinx`

This endpoint is used to retrieve a listing of all eLinx requests.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ELinxRequestType` string
- `ELinxRequestID` string
- `StartDateTime` string, date-time
- `EndDateTime` string, date-time
- `Limit ` integer
- `Offset ` integer
- `Timezone ` string

## Response `200`

- object
  - `Success` boolean — True if the sending was successful, false if it failed
  - `ErrorMessage` string — Contains a description of the error if the request failed
  - `ELinxRequests` object — Collection of the eLinx requests created by the account
    - `0` object
      - `AcceptedCardBrands` string — Accepted Card Brands of the eLinx request
      - `CardTypeValidation` integer — Whether card type validation is enabled for the eLinx request
      - `ELinxRequestID` integer — The unique ID of the eLinx request
      - `ReceiverName` string — Full name of the client who's bank account has been linked via an eLinx request.
      - `ReceiverEmailAddress` string — Recipient's email address.
      - `SenderName` string — Sender's full name.
      - `SenderEmailAddress` string — Sender's email address.
      - `Status` string — Current request status. Statuses are: pending, cancelled, completed, declined
      - `RequestDate` string — Date the request was sent
      - `Link` string — Contains a link where customer needs to go to provide the bank information
      - `Note` string — The note attached to the eLinx request, if applicable
      - `ClientReferenceNumber` string — The client reference number attached to the eLinx request, if applicable
      - `Amount` number — The dollar amount of the transaction attached to the eLinx request, if applicable
      - `Currency` string — Currency of the linked bank account
      - `TransactionID` integer — Transaction ID attached to the eLinx request, if applicable
      - `ScheduledPaymentsID` integer — Scheduled Transaction ID attached to the eLinx request, if applicable
      - `TransactionTypes` string — Transaction type of the transactions attached to the eLinx request, if applicable
      - `ELinxRequestType` string — eLinx request type (scheduled, transaction, or beneficiary)
      - `IQ11Token` string — Unique Iq11 token generated for the client's bank account
      - `Institution` string — Institution name of the linked bank account
      - `FinancialInstitutionNumber` string — Institution number of the linked bank account
      - `BranchTransitNumber` string — Branch transit number of the linked bank account
      - `AccountNumber` string — Account number of the linked bank account
      - `CreditCardToken` string — Unique credit card token generated for the client's credit card
      - `CreditCardNumber` string — Masked credit card number of the linked credit card
      - `CreditCardExpiryYear` string — Expiry year of the linked credit card
      - `CreditCardExpiryMonth` string — Expiry month of the linked credit card
      - `CreditCardBrand` string — Brand of the linked credit card
      - `FlexiblePaymentOptions` object — Collection of flexible payment plan options
      - `PaymentType` object — Type of elinx request. Possible values: fund, withdraw, or empty if no transaction is associated.
      - `TransactionIDs` string — Transaction ID(s)
      - `RecipientMessage` string — Recipient Message
      - `ClientAccountID` string — Client account ID associated with the eLinx request
      - `GLCode` string — The GL code associated with the eLinx request, if applicable
      - `TransactionTypeCode` string — The transaction type code associated with the eLinx request, if applicable
  - `Pagination` object — Pagination metadata
    - `TotalRecords` string — Total number of eLinx records in that search range.
    - `Offset` string — Use this parameter to set the starting point in the dataset.
    - `Limit` string — Limit the number of records that are returned.

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)