contacts/transactions

get

https://earthnode-dev.vopay.com/api/v2/contacts/transactions

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

StartDateTime

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.

EndDateTime

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.

ContactID

string

Filter transactions by Contact ID

Currency

string

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).

TransactionType

string

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

TransactionID

int32

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

ClientReferenceNumber

string

Searches for transactions with the specified client reference number.

ScheduledTransactionID

string

Id of the schedule transaction to search

IsFlagged

boolean

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

IsRefunded

boolean

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

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200