--- title: "Get Scheduled Payments" method: GET path: "/scheduled-payment" tags: ["Scheduled Payments"] --- # Get Scheduled Payments `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 Retrieve details of a single scheduled payment or all scheduled payments for the account. ## Query parameters - `AccountID` string, required - `Key` string, required - `Signature` string, required - `ScheduledPaymentsID` integer - `Limit` integer - `Offset` integer - `Repeats` string - `ScheduleType` 'single' | 'recurring' - `Status` 'in progress' | 'cancelled' | 'completed' - `SearchText` string - `PaymentType` string - `Currency` string - `PaymentRail` string - `Token` string - `GLCode` string - `ClientAccountID` string - `StartDate` string, date - `EndDate` string, date ## Response `200` Scheduled payments retrieved successfully - object - `Success` boolean, required: Indicates whether the request was successful - `ErrorMessage` string, required: Error message if the request failed - `PaginationMetaData` object: Pagination metadata for the results - `TotalRecords` integer, required: Total number of records - `Offset` integer, required: Current offset in pagination - `Limit` integer, required: Number of records returned - `ScheduledPayment` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no scheduled payments match. - `0` object - `ID` string, required: Scheduled payment ID - `ClientAccountID` string, required: Client account ID - `FullName` string, required: Full name of the account holder from tokenized payment data. Empty string if unavailable. - `Amount` string, required: Payment amount - `Currency` string, required: Currency code - `PaymentType` string, required: Payment type (debit/credit) - `TransactionType` string, required: Transaction type. This is the stable machine key and is not affected by label changes. - `TransactionTypeLabel` string, required: Customer-facing label for the transaction type / payment rail. For example TransactionType 'Interac Money Request' is labelled 'Interac e-Transfer® Request Money'. Always present; equals TransactionType for types that have no distinct label. Use this for display; use TransactionType for logic. - `Token` string, required: Payment token - `ClientReferenceNumber` string, required: Client reference number - `Notes` string, required: Notes for the payment - `Description` string, required: Description for the scheduled payment - `Status` 'in progress' | 'cancelled' | 'completed', required: Status of the scheduled payment. 'in progress' while occurrences remain upcoming. - `StartDateTime` string, required: Start date and time - `EndDate` string, date, required: Date of the final payment in YYYY-MM-DD format. Read from the stored schedule; computed from the recurrence settings for schedules created before the value was stored. Empty string if it cannot be determined. - `ScheduleEndDate` string, date, nullable, required: Same as EndDate, kept for backward compatibility. Null (rather than empty string) if the value cannot be determined. Prefer EndDate. - `NumberOfPayments` string, required: Number of payments - `ScheduleType` 'single' | 'recurring', required: Whether the payment is a one-time or recurring payment. Derived from whether Repeats is set. - `Repeats` string, required: Repeat frequency - `Interval` integer, required: How many units to advance per period (1 = every period, 2 = every other, etc.) - `ByDay` string, required: Weekday pin for weekly (e.g. FR or MO,WE,FR) or monthly (e.g. 3FR, -1MO) schedules, in canonical form — uppercased and, for weekly, re-ordered into calendar order starting Monday. Empty string when not set. - `GLCode` string, required: General ledger code - `TokenData` object, required: Tokenized payment method information for the payment token. Shape varies by token Type: 'bank', 'credit', 'debit', 'email', or 'billpay'. Each type populates a different subset of the fields below, so all fields are marked absent-when the token is a different type. - `Type` 'bank' | 'credit' | 'debit' | 'email' | 'billpay': Discriminator for the token type. Determines which other fields are present. - `FullName` string: Account/card holder full name. Present for bank, credit, debit, and email types. - `MaskedAccount` string: [bank] Masked bank account number (e.g. *****4567). - `Bank` string: [bank] Financial institution number. - `TransitNumber` string: [bank] Branch transit number. - `ABARoutingNumber` string: [bank] ABA routing number (USD accounts). - `BankName` string: [bank] Institution name. - `TokenType` 'manual' | 'iq11': [bank] Whether the token was created manually or via an aggregator. - `CreditCardNumber` string: [credit] Masked credit card number (e.g. ************1234). - `CreditCardExpiryYear` string: [credit] Card expiry year (YYYY). - `CreditCardExpiryMonth` string: [credit] Card expiry month (MM). - `CreditCardBrand` string: [credit] Card brand (e.g. Visa, Mastercard). - `CredtCardType` string: [credit] Card token type (e.g. creditcard). - `DebitCardNumber` string: [debit] Masked debit card number. - `DebitCardExpiryYear` string: [debit] Card expiry year (YYYY). - `DebitCardExpiryMonth` string: [debit] Card expiry month (MM). - `DebitCardBrand` string: [debit] Card brand. - `EmailAddress` string: [credit, debit, email] Email address associated with the token. - `PhoneNumber` string: [email] Phone number (populated when token was created with a phone number instead of email). - `Question` string: [email] Interac security question. - `Answer` string: [email] Interac security answer. - `Language` string: [email] Preferred language (e.g. en, fr). - `Message` string: [email] Optional message attached to the Interac transfer. - `AutoDepositEnabled` boolean: [email] Whether auto-deposit is enabled for this Interac email. - `Nickname` string: [billpay] Bill pay merchant nickname. - `PaymentAccount` string: [billpay] Bill pay account number. - `ClientReferenceNumber` string: Client reference number on the token record. Present for bank, credit, debit, and email types. - `UpcomingTransactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when there are no upcoming occurrences. - `0` object - `ID` string, required: Payment detail ID - `TransactionID` string, required: Transaction ID (empty for upcoming payments) - `ScheduledDate` string, date, required: Scheduled date in YYYY-MM-DD format - `ScheduledDateTime` string, date-time, required: Scheduled date and time in YYYY-MM-DD HH:MM:SS format - `LastModified` string, required: Last modified date (empty for upcoming payments) - `Status` string, required: Payment status - `Amount` string, required: Payment amount - `CompletedTransactions` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when there are no completed occurrences. - `0` object - `ID` string, required: Payment detail ID - `TransactionID` string, required: Transaction ID (empty if not linked to a processed transaction) - `ScheduledDate` string, required: Date the payment was processed or originally scheduled - `LastModified` string, required: Last modified date - `Status` string, required: Payment status - `Amount` string, required: Payment amount - `FailureReason` string, required: Reason the occurrence failed processing. Empty string when the occurrence did not fail. --- [API](https://skmtc.dev/vopay/apis/scheduled-payments.md) - [All operations](https://skmtc.dev/vopay/apis/scheduled-payments/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/scheduled-payments/revisions/93370d431cb0?raw)