Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
ACH Endpoints

ach/scheduled-transactions

This endpoint is used to look up the list of all scheduled transactions, or you can list the details of a single scheduled transaction.

If the value ScheduledTransactionID is present, we only list the details of that scheduled transaction.

  • Either the response will be Company name or First name and Last name
get/ach/scheduled-transactions

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ScheduledTransactionIDinteger required

ID of the schedule Transaction (If this value is present, we list the details of the scheduled transactions)

ClientAccountIDstring

Client Account ID

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

NumberOfRecordsnumber required

Total number of the scheduled transaction records returned

Example response

{
  "Success": true,
  "ScheduledTransactions": {
    "0": {
      "Type": "funding",
      "Frequency": "recurring",
      "Description": "Scheduled transaction 1234",
      "Notes": "Loan repayment 1234",
      "NameOfFrequency": "weekly",
      "Status": "in progress",
      "StartDate": "2020-01-01",
      "EndDate": "2021-01-01",
      "ScheduledDetails": {
        "0": {
          "Token": "ACBDF-GAFSHD-AHBS-123456",
          "AccountNumber": "*****387",
          "ABARoutingNumber": "1123****",
          "CompanyName*": "VoPay",
          "FirstName*": "John",
          "LastName*": "Doe",
          "Address1": "112 Bentall Street",
          "City": "Vancouver",
          "ZipCode": "V2W 4V6",
          "State": "CA",
          "Country": "Canada",
          "IPAddress": "127.0.0.1"
        }
      },
      "UpcomingTransactions": {
        "0": {
          "ScheduledDate": "2020-01-01"
        }
      },
      "CompletedTransactions": {
        "0": {
          "ScheduledDate": "2020-01-01",
          "ProcessingDate": "2020-01-02",
          "LastModified": "2020-01-02",
          "Status": "pending"
        }
      }
    }
  }
}