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

# elinx/settings

`GET /elinx/settings`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/elinx/settings`
- Auth: none declared

This endpoint is used to retrieve a list of all eLinx settings.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required

## Response `200`

- object
  - `Success` boolean, required: True if the sending was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `ELinxSettings` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. List of current eLinx settings
    - `0` object
      - `DefaultNotificationMethod` string, required: Default notification method.
      - `EnableELinxDecline` boolean, required: Can customer's decline an eLinx request
      - `ELinxUpcomingPaymentNoticeEnabled` boolean, required: Whether a reminder notice is sent before an upcoming recurring eLinx payment is processed.
      - `ELinxUpcomingPaymentNoticeLeadDays` integer, required: How many days before the withdrawal the upcoming-payment notice is sent.
      - `ELinxExpirationTime` integer, required: Expiration time (in days) of an eLinx request.
      - `ELinxSenderEmailAddress` string, required: Default sender email address for eLinx requests.
      - `ELinxReminderEnabled` boolean, required: Are eLinx reminders enabled.
      - `SenderNotificationsEnabled` boolean, required: Are sender notifications enabled
      - `ReceiverNotificationsEnabled` boolean, required: Are receiver notifications enabled
      - `ELinxReminderFrequency` integer, required: Reminder Frequency (in days) of an eLinx request.
      - `OTPRequired` string, required: OTP setting
      - `Trigger3DS` string, required: Whether 3DS authentication is triggered by default when an eLinx request is paid by credit card ('1' / '0'). Overridable per request on POST /elinx.
      - `RejectDuplicateRequests` string, required: Whether POST /elinx rejects a request matching a still-active request unless an IdempotencyKey is supplied ('1' / '0'). Off by default.

---

[API](https://skmtc.dev/vopay/apis/elinx.md) - [All operations](https://skmtc.dev/vopay/apis/elinx/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/elinx/revisions/e26fbd04a1d7?raw)