Get transactions for a specific account.

get

https://Contact sales to enable your sandbox/accounts/{account_id}/transactions

Transactions for an account include charges, loans, payments, reversals, interest, and fees. Results are paginated and sorted by transaction issued date.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

ID of the Account

Query Params

limit

integer

The maximum number of transactions to be returned. Defaults to 100.

starting_after

string

Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

ending_before

string

adjustment_for_transaction_id

string

Returns transactions that are adjustments for the transaction with the provided ID.

adjustment_by_transaction_id

string

Returns transactions that are adjustments created by the transaction with the provided ID.

effective_at_after

date-time

Returns transactions with an 'effective_at' date more recent (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter.

effective_at_before

date-time

Returns transactions with an 'effective_at' date older (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter.

include_adjustment_summary

boolean

For payment reversal transactions, include a summary of adjustments issued by the reversal.

is_adjustment

boolean

Returns transactions that are or are not adjustments (generally created by a reversal), based on the parameter value.

is_reversed

boolean

Returns transactions that have or have not been reversed, based on the parameter value.

issued_at_after

date-time

Returns transactions with an 'issued_at' date more recent (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter.

issued_at_before

date-time

Returns transactions with an 'issued_at' date older (or equal) than the timestamp passed as a value. Due to format constraints, it is highly recommended to encodeURIComponent() the value before passing it as a query parameter.

transaction_status

string

Comma-separated list of transaction statuses to filter by (no whitespaces).

transaction_type

string

Comma-separated list of transaction types to filter by (no whitespaces).

transaction_super_type

string

Comma-separated list of transaction super types to filter by (no whitespaces).

max_balance_cents

number

Returns transactions with a balance in cents less than or equal to the value passed as a parameter.

min_balance_cents

number

Returns transactions with a balance in cents greater than or equal to the value passed as a parameter.

max_original_amount_cents

number

Returns transactions with an original amount in cents less than or equal to the value passed as a parameter.

min_original_amount_cents

number

Returns transactions with an original amount in cents greater than or equal to the value passed as a parameter.

sort_by

string

enum

Return records ordered by the provided column name: defaults to issued_at.

Allowed:

text_search

string

Search for transactions that match the provided text value in either the description or line_item_id fields.

Responses

401

Unauthorized.

403

Forbidden.

404

Account not found

429

Too many requests.

default

Unexpected Error.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Array of Transactions, their related entity ids, status, types, summary, and other metadata.