Skip to main content

List Transactions

GET 
/v1/accounts/:accountId/transactions

Lists the Transactions for an Organization Account. Transactions are returned in date descending order.

Request​

Path Parameters

    accountId stringrequired

    Filter to an Account identifier.

Query Parameters

    pageSize int32

    Page size. Must be between 1 and 100.

    pageToken string

    Page token to retrieve the next page of results.

    credit boolean

    Filter Transactions by credit (true), or debit (false).

    dateRange.from date-time

    From date, inclusive.

    dateRange.to date-time

    To date, inclusive.

Responses​

OK

Schema

    transactions

    object[]

    required

    The Transactions.

  • Array [

    • transactionId stringrequired

    The Transaction identifier.

    amount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    balance

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    date date-timerequired

    The date of the Transaction.

    description stringrequired

    The Transaction description.

    topup

    object

    A top-up Transaction

    reference stringrequired

    A reference for the Transaction.

    source PaymentType (string)required

    The Transaction Payment type.

    Possible values: [API, PAYPAL, BACS]

    dataInstance

    object

    A Transaction for a Data Instance.

    dataInstanceId stringrequired

    The Data Instance identifier to which this Transaction relates.

    adjustment

    object

    An adjustment Transaction.

    dataInstanceId stringrequired

    The Data Instance identifier to which this Transaction relates.

    administratorUserId stringrequired

    The system administrator User identifier that made this change.

  • ]

    • nextPageToken string

    (Optional) Page token to retrieve the next page of results.

Loading...