Sign in

v1

latestOpenAPI 3.0.02026-07-2640301.0 MB
Contact Endpoints

contacts/transactions

This endpoint is used to get a list of transactions associated with a contact.

get/contacts/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.

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

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.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

NumberOfRecordsinteger

Total number of transaction records returned

Example response

{
  "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",
      "ContactID": "test_contact_id",
      "TransactionErrorCode": "901",
      "TransactionFailureReason": "NSF",
      "TransactionFlag": "duplicate - 45563,45561",
      "FullName": "Jane Doe"
    }
  }
}