v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

eLinx Endpoints

elinx

This endpoint is used to retrieve a listing of all eLinx requests.

get/elinx

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ELinxRequestTypestring

Filters results by eLinx request type: scheduled, transaction or beneficiary. Default is '' (i.e., all eLinx requests are returned).

ELinxRequestIDstring

Filters results by eLinx request ID

StartDateTimestring date-time

Filters results that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format. Default is 30 days ago.

EndDateTimestring date-time

Filters results that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format. Default is the current date/time.

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

Timezone string

Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.

Response

Successboolean

True if the sending was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "ELinxRequests": {
    "0": {
      "AcceptedCardBrands": "amex,discover,mastercard,unionpay",
      "ReceiverName": "John Smith",
      "ReceiverEmailAddress": "john.doe@vopay.com",
      "SenderName": "Jane Doe",
      "SenderEmailAddress": "jane.doe@vopay.com",
      "Status": "pending",
      "RequestDate": "2020-05-25",
      "Link": "https://request.vopay.com/{Token}",
      "Note": "eLinx requested to the client 123",
      "ClientReferenceNumber": "123ABC-XYZ",
      "Currency": "CAD",
      "TransactionTypes": "1234",
      "ELinxRequestType": "1234",
      "Institution": "CIBC",
      "FinancialInstitutionNumber": "010",
      "BranchTransitNumber": "03900",
      "AccountNumber": "1234567",
      "CreditCardNumber": "**** **** **** 1234",
      "CreditCardExpiryYear": "2023",
      "CreditCardExpiryMonth": "12",
      "CreditCardBrand": "visa",
      "TransactionIDs": "12345,12346,12347",
      "RecipientMessage": "A message for the recipient.",
      "ClientAccountID": "client_account_1",
      "GLCode": "GL-1234",
      "TransactionTypeCode": "203"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}