increase-test
GET/declined_transactions

List declined transactions

Lists declined transactions, which represent refused additions or removals of money from an account. Filter results by account, route, category, or creation time, and use cursor to retrieve subsequent pages.

9 parameters
cursorstringoptional
Return the page of entries after this cursor.
limitintegeroptional
Maximum number of declined transactions to return. Must be at least 1; defaults to 100 when omitted, and the maximum is 100.
Default:100
account_idstringoptional
Filter declined transactions to those belonging to this Account.
created_at.afterstringoptional
Return results after this ISO 8601 date-time timestamp.
created_at.beforestringoptional
Return results before this ISO 8601 date-time timestamp.
created_at.on_or_afterstringoptional
Return results on or after this ISO 8601 date-time timestamp.
created_at.on_or_beforestringoptional
Return results on or before this ISO 8601 date-time timestamp.
route_idstringoptional
Filter declined transactions to those belonging to this route.
category.inarray<string>optional
Filter by one or more categories, encoded as a comma-delimited list: `ach_decline`, `card_decline`, `check_decline`, `inbound_real_time_payments_transfer_decline`, `inbound_fednow_transfer_decline`, `wire_decline`, `check_deposit_rejection`, or `other`.

3 status codes
200Returns a page containing declined transaction objects and a `next_cursor` value for retrieving the next page, or null when there are no more results.
dataarray<DeclinedTransaction>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request results in a client error.
5XXReturned when the server encounters an error processing the request.

Error handling

limit must be at least 1 and no greater than 100. Each value in category.in must be one of: ach_decline, card_decline, check_decline, inbound_real_time_payments_transfer_decline, inbound_fednow_transfer_decline, wire_decline, check_deposit_rejection, or other; date filters must use ISO 8601 date-time values.