Your account ID

API key for the account

Hashed signature for the request

Client Account ID

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

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

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.

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

Currency of the eLinx request. Defaults to the account's currency: USD for US accounts, CAD for all others. The other currency requires a PaymentType and is limited to: USD on a non-US account - fund by credit card (USD credit card collection enabled) or bank account via USD EFT (USD EFT collect enabled), withdraw to a bank account via USD EFT (USD EFT send enabled); CAD on a US account - fund by credit card only (CAD credit card collection enabled). The recipient only sees, and can only pay with, those payment methods; BankingPaymentRail is limited to eft and IframeKey is not supported. Withdraw requests are balance-checked and pre-funded in this currency.

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

Name of frequency of the scheduled transaction (Only for recurring option), the posibles values are: daily, weekdays, weekly, bi-weekly (biweekly is also accepted as an alias, but is stored and echoed back exactly as submitted - it is only normalized to bi-weekly internally when the schedule is generated at acceptance), semi-monthly, monthly, quarterly, semi-annually, annually. Values are matched case-insensitively. Any other value is rejected with a 400 - custom is no longer accepted, as it was never schedulable and produced a schedule with zero occurrences. Required if you are sending an eLinx request for a recurring payment.

Pins payments to specific weekdays. Only applies to NameOfFrequency weekly or monthly. For weekly, provide one weekday abbreviation or a comma-separated list of them — MO, TU, WE, TH, FR, SA, SU (e.g. FR, or MO,WE,FR); each weekday may appear at most once. For monthly, provide exactly one value with a mandatory ordinal prefix, 1–4 or -1 for last (e.g. 1MO, 3FR, -1FR); comma-separated lists are not accepted for monthly. Input is case-insensitive; for weekly, whitespace around each entry is ignored, but a monthly value must have no surrounding whitespace. The stored value is canonicalized — uppercased and, for weekly, re-ordered into calendar order starting Monday — so ByDay=FR,MO is stored as MO,FR. A weekday repeated within one value is rejected rather than de-duplicated. Weeks run Monday to Sunday: the first payment is the earliest selected weekday on or after ScheduleStartDate, so a schedule starting on a Thursday with ByDay=MO,WE,FR fires only on the Friday of its first week. Can only be provided when Frequency is recurring.

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.

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.

Invoice number of the payment

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

An optional note to associate with the transaction.

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.

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

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

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.

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.

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.

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

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

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.

An optional GL code to associate with the transaction created from this eLinx request.

An optional transaction type code to associate with the transaction created from this eLinx request.

A unique key, up to 100 characters, marking this request as intentional. It bypasses the duplicate-request check (see RejectDuplicateRequests). Keys are unique per account across all eLinx requests and transactions: reusing one fails with a duplicate error. Only letters, numbers, underscores and hyphens are allowed.