Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Account Endpoints

account/transactions/recent

This endpoint returns a list of recent transactions for a specific contact or client account.

get/account/transactions/recent

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

StartDateTimestring date-time

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

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 required

Filter transactions by Client account ID. This is required if client account is enabled. Use ContactID instead if client account is not enabled.

ContactIDstring required

Filter transactions by Contact ID. This is required if client account is not enabled. Use ClientAccountID instead if client account is enabled.

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",
      "Currency": "CAD"
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}