v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Transaction

Retrieves a Collection of transaction resources

get/transactions

Query parameters

startstring date-time

YYYY-MM-DD

endstring date-time

YYYY-MM-DD

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Transaction collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration

transactionTypestring nullable

Transaction type e.g. Payment

successstring nullable

True of false on if transaction went through

amountinteger nullable

Amount of the transaction in cents e.g: 870

descriptionstring nullable

Transaction description

transactionIdstring nullable

Transaction Id

paymentIdstring nullable

Payment Id

productIdstring nullable

Product Id

taxIdstring nullable

Tax Id

componentIdstring nullable

Component Id

statementIdstring nullable

Statement Id

customerIdstring nullable

Id of the customer made he transaction

createdstring date-time nullable

Date and time the transaction is first created

statusstring nullable

Status of the transaction e.g: success

feeinteger nullable

Transaction fees

netAmountinteger nullable

Net amount of transaction

txnDatestring date-time nullable

Transaction date

Example response

[
  {
    "integration": "quickbooks"
  }
]