Balances

List Transactions

Changed on

Retrieve all Transactions for a specific Balance.

This endpoint returns a list of all Transactions associated with a specific Balance. You can paginate through the Transactions by using the pageSize and nextToken parameters.

get/organizations/{orgId}/balances/{balanceId}/transactions

Request

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

balanceIdstring required

The unique identifier (UUID) for the Balance whose Transactions you want to retrieve.

Query parameters

pageSizeinteger

The maximum number of transactions to return per page.

nextTokenstring

nextToken for multi page retrievals. A token for retrieving the next page of transactions. You'll get this from the response to your request.

transactionTypeIdstring nullable
entityType'BILL' | 'COMMITMENT' | 'USER' | 'SERVICE_USER' | 'SCHEDULER'
entityIdstring nullable

Response

Returns the list of Balance Transactions

nextTokenstring

Changes

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional query request parameter entityId

    • info

      added the new optional query request parameter entityType

    • info

      for the query request parameter pageSize, the max was increased from 100.00 to 200.00

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status