Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
eLinx Endpoints

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.

post/elinx

Response

Successboolean

True if the sending was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

ELinxRequestIDinteger

The unique ID of the eLinx request

Linkstring

Contains a link where customer needs to go to provide the bank information

Statusstring

Message indicating the current request status. Statuses are: pending, cancelled, completed

Amountnumber

Amount of the eLinx, if provided

ReceiverNamestring

Recipient's full name

ReceiverEmailAddressstring

Recipient's email address.

SenderNamestring

Sender's full name

SenderEmailAddressstring

Semder's email address.

InvoiceNumberstring

Invoice number

Notestring

If applicable, notes giving context to the transaction.

ClientReferenceNumberstring

The client reference number attached to the eLinx request, if applicable

ELinxRequestTypestring

The type of eLinx request. eLinx request types are: beneficiary, scheduled, transaction.

Frequencystring

The frequency of the schedule (if applicable): single or recurring

NameOfFrequencystring

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.

SemiMonthlyFrequencyTypeinteger

Type of semi-monthly frequency (if applicable): SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast.

ScheduleStartDatestring date

Date from which the transaction will be started (if applicable)

ScheduleEndDatestring date

Date which the transaction will end (if applicable)

EndingAfterPaymentsinteger

Number of payments after which the transaction processing will end

PaymentTypestring

Transaction type (if applicable): fund or withdraw

Example response

{
  "Link": "https://request.vopay.com/{Token}",
  "Status": "pending",
  "ReceiverName": "John",
  "ReceiverEmailAddress": "john.doe@vopay.com",
  "SenderName": "John",
  "SenderEmailAddress": "jane.doe@vopay.com",
  "InvoiceNumber": "ABC1234",
  "Note": "eLinx requested to the client 123",
  "ClientReferenceNumber": "123ABC-XYZ",
  "ELinxRequestType": "transaction",
  "Frequency": "recurring",
  "NameOfFrequency": "weekly",
  "ScheduleStartDate": "2020-01-01",
  "ScheduleEndDate": "2021-01-01",
  "PaymentType": "fund"
}