v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Sub-Account Endpoints

account/subaccount/transactions

This endpoint will return a list of all of the transactions for sub-accounts, and its sub-accounts transaction.

get/account/subaccount/transactions

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

StartDateTimestring date-time required

Return transactions that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

EndDateTimestring date-time required

Return transactions that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

ClientAccountIDstring

Filter transactions by Client account ID

ContactIDstring

Filter transactions by Contact ID

Currencystring

3 character currency code for the currency to fetch transactions for. If this is not specified it will be defaulted to the account's local currency (generally CAD).

TransactionTypestring

Specifies the type of transaction to return. Accepted values are: 'EFT Funding', 'EFT Withdrawal', 'Interac Money Request', 'Interac Bulk Payout', 'Credit Card', 'Fee', 'Reversal'.

TransactionIDinteger

Searches for a transaction with the specified transaction ID, including any related child transactions which may exist.

ClientReferenceNumberstring

Searches for transactions with the specified client reference number.

ScheduledTransactionIDstring

Id of the schedule transaction to search

WalletIDstring

Id of the wallet that the transactions should belong to

IsFlaggedboolean

Filter the list of transactions to only include transactions that have a flag status and have not been confirmed by the client.

IsRefundedboolean

Filter the list of transactions to only include transactions that have been refunded.

Limitinteger

Limit the number of records that are returned. Use the off-set parameter to set the starting point in the data-set. Default limit is 1,000 and maximum limit is 10,000.

Offsetinteger

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

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

NumberOfRecordsinteger required

Total number of transaction records returned.

Example response

{
  "Success": true,
  "Transactions": {
    "0": {
      "TransactionDateTime": "2019-12-04 18:13:39",
      "TransactionType": "Reversal",
      "TransactionStatus": "in progress",
      "Notes": "Transaction cancelled",
      "Currency": "CAD",
      "LastModified": "2019-12-04 18:13:39",
      "ParentTransactionID": "5909",
      "ClientReferenceNumber": "null",
      "WalletID": "primary_000001",
      "ClientAccountID": "client_account_1",
      "TransactionErrorCode": "901",
      "TransactionFailureReason": "NSF",
      "TransactionFlag": "duplicate - 45563,45561",
      "IsRefunded": true,
      "FullName": "Jane Doe"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}