elinx

post

https://earthnode-dev.vopay.com/api/v2/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Client Account ID

SenderName

string

required

Sender's full name. This is the name of the person who is sending the eLinx request to the recipient.

ReceiverName

string

required

Receiver's full name. This is the name of the person receiving the eLinx request.

PaymentType

string

Only required if you are requesting banking info for the purposes of a payment. Valid options are fund or withdraw. Choose fund if you are sending an eLinx request to collect money, and withdraw if you sending an eLinx request to send money.

BankingPaymentRail

string

Determines the payment rail to use for transactions involving banking rails. Possible values: eft, vopayinstant, ach, rtp, fednow, fedwire

Amount

number

The amount of the payment you are requesting in the eLinx. If an amount is specified, a transaction will be created once the eLinx request is fulfilled by the recipient.

Frequency

string

Only required if you are requesting banking info for a scheduled/recurring payment. Valid options are single or recurring.

NameOfFrequency

string

Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: weekly, biweekly, semi-monthly, monthly, bimonthly, 3 months, 6 months, yearly. Required if you are sending an eLinx request for a recurring payment.

ScheduleStartDate

string

Date from which the schedule will be started in YYYY-MM-DD format. Required if you are sending an eLinx for a recurring/scheduled payment.

ScheduleEndDate

string

Date when the transaction processing will end (Only for recurring option). Either provide ScheduleEndDate or EndingAfterPayments. One is required if you are sending an eLinx for a recurring payment.

EndingAfterPayments

integer

Number of payments after which the transaction processing will end (Only for recurring option). Either provide ScheduleEndDate or EndingAfterPayments. One is required if you are sending an eLinx for a recurring payment.

SemiMonthlyFrequencyType

integer

Type of semi-monthly frequency. This field is only required when NameOfFrequency is set to semi-monthly. The possible values are: SemiMonthFirstAndFifteenth, SemiMonthFifteenthAndLast.

InvoiceNumber

string

Invoice number of the payment

DocumentID

integer

ID of the document you want to include in the eLinx email. You must first upload a document using the POST /document endpoint, and then pass in the resulting DocumentID into this endpoint.

ClientReferenceNumber

string

An optional reference number which was associated with the eLinx request.

Note

string

An optional note to associate with the transaction.

SendNotification

boolean

This option is used to send an eLinx through email, sms, or whatsapp which later on can be used by a recipient to make the payment. A valid ReceiverPhoneNumber or ReceiverEmailAddress must be provided

NotificationMethod

string

Use this optional parameter to override the account-level setting for the eLinx delivery method. If not provided, the account-level setting will be used. Possible values: email, sms, whatsapp.

ReceiverEmailAddress

string

Customer's email address - Must be a valid email. Only required if SendNotification is true and NotificationMethod = email.

ReceiverPhoneNumber

string

Customer's phone number - Must be a valid number. Only required if SendNotification is true and NotificationMethod = sms or whatsapp.

IframeKey

string

An iFrame key generated from /iq11/generate-embed-url. If provided, the settings applied to this iFrame will be used when the customer provides their bank account information. If not provided, the default iFrame settings will be used.

FlexiblePaymentOptions

string

This will inform the end user of the flexible payment options that they can choose from. Input can be a comma-delimited list. The possible values are: multiple, partial, installments.

MinimumPaymentAccepted

number

This is the minimum amount that can be accepted for a 'partial' payment option. Example, if total eLinx amount is 100.00, and MinimumPaymentAccepted is 25.00, the user will be able to choose a partial payment of 25.00 (or more). This is required if 'partial' is included in FlexiblePaymentOptions.

RemainderPaymentDate

string

This will specify the date the remainder of the total amount should be paid if 'partial' payment is selected. This is optional if 'partial' is included in FlexiblePaymentOptions.

NumberOfInstallments

number

This will specify the number of installments that the payments will be split into. This is required if 'installments' is included in FlexiblePaymentOptions.

InstallmentFrequency

string

This will specify the frequency of installments. This is required if 'installments' is included in FlexiblePaymentOptions. The possible values are: weekly, biweekly, monthly.

SendReminder

boolean

Use this optional parameter to override the account-level setting for sending reminders to recipient. If not provided, the account-level setting will be used.

ReminderFrequency

integer

Use this optional parameter to override the account-level setting for the eLinx reminder frequency (in days). If not provided, the account-level setting will be used.

RecipientMessage

string

Use this optional parameter to provide a message to the recipient.

PaymentMethodDisplayOptions

string

This optional parameter can be added to ensure that the recipient is using an existing payment method, adding a new payment method or whether the client has access to both. Valid options include - New, Existing or Both. Defaults to New.

Response

200