--- updatedAt: 2026-08-17T19:31:34.000Z agentTools: projectIndex: https://docs.vopay.com/llms.txt --- # account/client-accounts/transactions This endpoint returns a list all of the transactions which affect the account balance. This endpoint only returns basic information on the transactions. More detailed information on individual transactions is available from other API endpoints. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "2.0", "title": "Client Accounts", "description": "The Client Accounts API allows you to create, manage and retrieve information about client accounts.", "contact": { "name": "API Support", "email": "help@vopay.com" } }, "paths": { "/account/client-accounts/transactions": { "get": { "description": "This endpoint returns a list all of the transactions which affect the account balance. This endpoint only returns basic information on the transactions. More detailed information on individual transactions is available from other API endpoints.", "summary": "account/client-accounts/transactions", "tags": [ "Client Account Transfer Endpoints" ], "operationId": "AccountClientAccountTransactionsGet", "deprecated": false, "parameters": [ { "name": "AccountID", "in": "query", "required": true, "description": "Your account ID", "schema": { "type": "string" } }, { "name": "Key", "in": "query", "required": true, "description": "API key for the account", "schema": { "type": "string" } }, { "name": "Signature", "in": "query", "required": true, "description": "Hashed signature for the request", "schema": { "type": "string" } }, { "name": "StartDateTime", "in": "query", "required": true, "description": "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.", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateTime", "in": "query", "required": true, "description": "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.", "schema": { "type": "string", "format": "date-time" } }, { "name": "ClientAccountID", "in": "query", "required": true, "description": "Filter transactions by Client account ID", "schema": { "type": "string" } }, { "name": "Currency", "in": "query", "required": false, "description": "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).", "schema": { "type": "string" } }, { "name": "TransactionType", "in": "query", "required": false, "description": "Specifies the type of transaction to return. Accepted values are: 'EFT Funding', 'EFT Withdrawal', 'Interac Money Request', 'Interac Bulk Payout', 'Credit Card', 'Fee', 'Reversal'.", "schema": { "type": "string" } }, { "name": "TransactionID", "in": "query", "required": false, "description": "Searches for a transaction with the specified transaction ID, including any related child transactions which may exist.", "schema": { "type": "integer", "format": "int32" } }, { "name": "ClientReferenceNumber", "in": "query", "required": false, "description": "Searches for transactions with the specified client reference number.", "schema": { "type": "string" } }, { "name": "ScheduledTransactionID", "in": "query", "required": false, "description": "Id of the schedule transaction to search", "schema": { "type": "string" } }, { "name": "WalletID", "in": "query", "required": false, "description": "Id of the wallet that the transactions should belong to", "schema": { "type": "string" } }, { "name": "IsFlagged", "in": "query", "required": false, "description": "Filter the list of transactions to only include transactions that have a flag status and have not been confirmed by the client.", "schema": { "type": "boolean" } }, { "name": "IsRefunded", "in": "query", "required": false, "description": "Filter the list of transactions to only include transactions that have been refunded.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "required": [ "Success", "ErrorMessage", "NumberOfRecords", "Transactions" ], "properties": { "Success": { "type": "boolean", "description": "True if the request was successful, false if it failed", "example": true }, "ErrorMessage": { "type": "string", "description": "Contains a description of the error if the request failed", "example": "" }, "NumberOfRecords": { "type": "integer", "description": "Total number of transaction records returned", "example": "0" }, "Transactions": { "type": "object", "description": "Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no transactions match.", "x-list-of": "inline", "x-empty-when": "no transactions match", "properties": { "0": { "type": "object", "required": [ "TransactionID", "AccountName", "TransactionDateTime", "TransactionType", "TransactionStatus", "Notes", "DebitAmount", "CreditAmount", "Currency", "HoldAmount", "LastModified", "ParentTransactionID", "ChildTransactionIDs", "ClientReferenceNumber", "ScheduledTransactionID", "WalletID", "ClientAccountID", "TransactionErrorCode", "TransactionFailureReason", "TransactionFlag", "ELinxRequestID", "IsRefunded", "FullName" ], "properties": { "TransactionID": { "type": "integer", "description": "Unique ID for the Transaction", "example": "5918" }, "AccountName": { "type": "string", "description": "Account Name", "example": "" }, "TransactionDateTime": { "type": "string", "format": "date-time", "description": "The timestamp on which the transaction occurred.", "example": "2019-12-04 18:13:39" }, "TransactionType": { "type": "string", "description": "Specifies the type of transaction, for example 'EFT Funding', 'EFT Withdrawal', 'Fee'.", "example": "Reversal" }, "TransactionStatus": { "type": "string", "description": "Current Status of the transaction", "example": "in progress" }, "Notes": { "type": "string", "description": "If applicable, notes giving context to the transaction.", "example": "Transaction cancelled" }, "DebitAmount": { "type": "number", "description": "The dollar amount by which this transaction debited funds from your account balance. If DebitAmountis set, CreditAmount will be null.", "example": "100.00" }, "CreditAmount": { "type": "number", "description": "The dollar amount by which this transaction credited funds to your account balance. If CreditAmount is set, DebitAmount will be null.", "example": "0.00" }, "Currency": { "type": "string", "description": "3 character currency code.", "example": "CAD" }, "HoldAmount": { "type": "number", "description": "The dollar amount of the funds from this transaction which are temporarily on hold. This is only applicable for transactions where CreditAmount is set.", "example": "0.00" }, "LastModified": { "type": "string", "format": "date-time", "description": "This timestamp indicates when the transaction record was last modified. In normal circumstances the transaction record will only be modified when the HoldAmount is changed.", "example": "2019-12-04 18:13:39" }, "ParentTransactionID": { "type": "string", "description": "If a transaction directly relates to another transaction, this value will be set to link the new transaction to its parent. For example if an EFT comes back with insufficient funds a new transaction will be created referencing the original transaction as its parent.", "example": "5909" }, "ChildTransactionIDs": { "type": "integer", "description": "If this transaction directly relates to any other transactions this will contain a collection of child transaction IDs. For example if an EFT is reversed due to insufficient funds the original transaction record will reference the new transaction as a child.", "example": "{}" }, "ClientReferenceNumber": { "type": "string", "description": "The optional reference number which was set when the transaction was created.", "example": "null" }, "ScheduledTransactionID": { "type": "integer", "description": "ID of the scheduled transaction", "example": "1" }, "WalletID": { "type": "string", "description": "ID of the wallet this transaction belongs to", "example": "primary_000001" }, "ClientAccountID": { "type": "string", "description": "Client account ID used on the transaction, if applicable", "example": "client_account_1" }, "TransactionErrorCode": { "type": "string", "description": "Error code of the transaction, if applicable", "example": "901" }, "TransactionFailureReason": { "type": "string", "description": "Failure reason of the transaction, if applicable", "example": "NSF" }, "TransactionFlag": { "type": "string", "description": "Flag status of the transaction, if applicable", "example": "duplicate - 45563,45561" }, "ELinxRequestID": { "type": "integer", "description": "The unique ID of the eLinx request attached to the transaction, if applicable", "example": "1234" }, "IsRefunded": { "type": "boolean", "description": "True if the transaction was refunded, false if it is not", "example": true }, "FullName": { "type": "string", "description": "Customer's full name ", "example": "Jane Doe" } } } } } } } } } } } } } }, "servers": [ { "url": "https://earthnode-dev.vopay.com/api/v2" } ] } ```