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

# elinx

`POST /elinx`

This endpoint is used to create an eLinx request. Once the eLinx request is created successfully, the request link will be sent through an email to the recipient.

Notes:

* If you do not wish to send an eLinx request via an email, sms or whatsapp, then simply set SendNotification = false

* Before sending an eLinx request, you must set your default email address using the /elinx/setup-sender-email endpoint.

## 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
  - `ELinxRequestID` integer — The unique ID of the eLinx request
  - `Link` string — Contains a link where customer needs to go to provide the bank information
  - `Status` string — Message indicating the current request status. Statuses are: pending, cancelled, completed
  - `Amount` number — Amount of the eLinx, if provided
  - `ReceiverName` string — Recipient's full name
  - `ReceiverEmailAddress` string — Recipient's email address.
  - `SenderName` string — Sender's full name
  - `SenderEmailAddress` string — Semder's email address.
  - `InvoiceNumber` string — Invoice number
  - `Note` string — If applicable, notes giving context to the transaction.
  - `ClientReferenceNumber` string — The client reference number attached to the eLinx request, if applicable
  - `ELinxRequestType` string — The type of eLinx request. eLinx request types are: beneficiary, scheduled, transaction.
  - `Frequency` string — The frequency of the schedule (if applicable): single or recurring
  - `NameOfFrequency` string — Name of the frequency of the transaction (if applicable): weekly, biweekly, monthly, bimonthly, 3 months, 6 months, yearly. Only provided if Frequency provided is recurring.
  - `SemiMonthlyFrequencyType` integer — Type of semi-monthly frequency (if applicable): SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast.
  - `ScheduleStartDate` string, date — Date from which the transaction will be started (if applicable)
  - `ScheduleEndDate` string, date — Date which the transaction will end (if applicable)
  - `EndingAfterPayments` integer — Number of payments after which the transaction processing will end
  - `PaymentType` string — Transaction type (if applicable): fund or withdraw

---

[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)