v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Partner Endpoints

partner/account/transactions

This endpoint is used to fetch all the transactions belonging to your accounts

get/partner/account/transactions

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VopayAccountIDstring

Your VoPay account ID

TransactionTypestring

The transaction type for the account

FromDatestring

Transaction start date

ToDatestring

Transaction end date

SettlementDatestring

Transaction settlement date

Statusstring

The transaction status.

Currencystring

The transaction currency.

TransactionIDstring

The transaction ID

Limitinteger

Limit the number of records that are returned. Use the off-set parameter to set the starting point in the data-set.

Offsetinteger

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

IncludeSubaccountTransactionsboolean

Fetch transactions for subaccounts as well.

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

TransactionsCountnumber

Total number of all the transactions

Transactionsstring

JSON object containing all the transactions

Example response

{
  "Success": true,
  "Transactions": "{'TransactionID': 'TransactionID', 'TransactionType': 'TransactionType'}",
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}