List Transactions

GET {{baseUrl}}/transactions

Request Params

KeyDatatypeRequiredDescription
customer_uidstringFilter by Customer. Multiple values are allowed, e.g. customer_uid[]=uKxmLxUEiSj5h4M3&customer_uid[]=y9reyPMNEWuuYSC1.
pool_uidstringFilter by pool. Multiple values are allowed, e.g. pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c.
source_synthetic_account_uidstringFilter by source Synthetic Account. Multiple values are allowed, e.g. source_synthetic_account_uid[]=4XkJnsfHsuqrxmeX&source_synthetic_account_uid[]=aeD4RMVyTKaspEzj.
destination_synthetic_account_uidstringFilter by destination Synthetic Account. Multiple values are allowed, e.g. destination_synthetic_synthetic_uid[]=exMDShw6yM3NHLYV&destination_synthetic_account_uid[]=1WVbRrp1s1MvTaAe.
synthetic_account_uidstringFilter by Synthetic Account, source or destination. Multiple values are allowed, e.g. synthetic_account_uid[]=4XkJnsfHsuqrxmeX&synthetic_account_uid[]=exMDShw6yM3NHLYV.
typestringFilter by type. Multiple values are allowed, e.g. type[]=dispute&type[]=fee.
has_returnbooleanFilter by return. Only transactions that have returns (present or absend) to be included in the results.
show_denied_authsbooleanCauses transactions with a status of denied (suppressed by default) to be included in the results.
show_expiredbooleanCauses transactions with a status of expired (suppressed by default) to be included in the results.
statusstringFilter by status. Multiple values are allowed, e.g. status[]=queued&status[]=pending.
search_descriptionstringAttempts to search for the provided string in the description field. '*' can be used as a wildcard at the beginning or end of the string. Any record with a match will be returned.
include_zerobooleanCauses transactions with a us_dollar_amount = 0 (suppressed by default) to be included in the results.
limitnumberMaximum number of items to retrieve. This filter is automatically applied with the default value if not given.
offsetnumberIndex of the items to start retrieving from
sortstring
created_at_afterstringReturn only transactions with created_at after the provided ISO 8601 timestamp
created_at_beforestringReturn only transactions with created_at before the provided ISO 8601 timestamp
settled_at_afterstringReturn only transactions with settled_at after the provided ISO 8601 timestamp
settled_at_beforestringReturn only transactions with settled_at before the provided ISO 8601 timestamp
initial_action_at_afterstringReturn only transactions with initial_action_at after the provided ISO 8601 timestamp
initial_action_at_beforestringReturn only transactions with initial_action_at before the provided ISO 8601 timestamp
settled_index_afternumberReturn only transactions with settled_index after the provided value
settled_index_beforenumberReturn only transactions with settled_index before the provided value
id_afternumberReturn only transactions with id after the provided value
id_beforenumberReturn only transactions with id before the provided value

HEADERS

KeyDatatypeRequiredDescription
Acceptstring