VOvopay
Scheduled Payments

Get Scheduled Payments

Retrieve details of a single scheduled payment or all scheduled payments for the account.

get/scheduled-payment

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/scheduled-payment
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ScheduledPaymentsIDinteger

The ID of a specific scheduled payment to retrieve. If omitted, returns all scheduled payments.

Limitinteger

Maximum number of results to return

Offsetinteger

Pagination offset

Repeatsstring

Filter by repeat frequency

ScheduleType'single' | 'recurring'

Filter by schedule type: recurring (Repeats is set) or single (one-time payment)

Status'in progress' | 'cancelled' | 'completed'

Filter by the status of the scheduled payment

SearchTextstring

Free-text search across ClientReferenceNumber, Description, Notes, GLCode, Token and FullName (partial match)

PaymentTypestring

Filter by payment type

Currencystring

Filter by currency code

PaymentRailstring

Filter by payment rail

Tokenstring

Filter by payment token

GLCodestring

Filter by general ledger code

ClientAccountIDstring

Filter by client account ID

StartDatestring date

Filter by start date (inclusive)

EndDatestring date

Filter by end date (inclusive)

Response

Scheduled payments retrieved successfully

Successboolean required

Indicates whether the request was successful

ErrorMessagestring required

Error message if the request failed

Example response

{
  "Success": true,
  "ScheduledPayment": {
    "0": {
      "TransactionTypeLabel": "Interac e-Transfer® Request Money",
      "ByDay": "MO,FR"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.