API ReferenceTreasuryTransactions

List transactions

List your transactions. Supply at most one of `program_id`, `account_id`, `card_id`, `cardholder_id`, `business_entity_id` or `control_account_id`; more than one is rejected. `control_account_id` cannot be combined with `stage_time` filters. With no filter, every transaction for your business is listed. Required permissions: `transaction:list`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Query parameters

program_idstring or nullOptional
Only return transactions under this program.
account_idstring or nullOptional
Only return transactions on this account.
card_idstring or nullOptional
Only return transactions made with this card.
cardholder_idstring or nullOptional
Only return transactions made with this cardholder's cards.
business_entity_idstring or nullOptional
Only return transactions for this business entity.
control_account_idstring or nullOptional

Only return transactions made through this Control Account. Cannot be combined with stage_time filters.

page_sizeintegerOptional1-3000Defaults to 100
Maximum number of results to return per page. Defaults to 100.
next_page_tokenstring or nullOptional
Pagination key used to retrieve the next page of results.
stage_time_greater_than_equal_tostring or nullOptional
Lower time bound for Stage Time, inclusive.
stage_time_greater_thanstring or nullOptional
Lower time bound for Stage Time, exclusive.
stage_time_equal_tostring or nullOptional
Exact timestamp for Stage Time.
stage_time_less_than_equal_tostring or nullOptional
Upper time bound for Stage Time, inclusive.
stage_time_less_thanstring or nullOptional
Upper time bound for Stage Time, exclusive.

Response

A list of transactions.
itemslist of objects
The list of items returned by the API.
countinteger
The total number of items returned in this response.
next_page_tokenstring or nullOptional
A token for retrieving the next page of results, if applicable.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error