List Declined Transactions

Changed on
get/declined_transactions

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/declined_transactions
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Declined Transactions to ones belonging to the specified Account.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

route_idstring

Filter Declined Transactions to those belonging to the specified route.

category.instring[]

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

Response

Declined Transaction List

next_cursorstring nullable required

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.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "amount": 1750,
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "description": "INVOICE 2468",
      "id": "declined_transaction_17jbn0yyhvkt4v4ooym8",
      "route_id": "account_number_v18nkfqm6afpsrvy82b2",
      "route_type": "account_number",
      "source": {
        "ach_decline": {
          "amount": 1750,
          "id": "ach_decline_72v1mcwxudctq56efipa",
          "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev",
          "originator_company_descriptive_date": null,
          "originator_company_discretionary_data": null,
          "originator_company_id": "0987654321",
          "originator_company_name": "BIG BANK",
          "reason": "insufficient_funds",
          "receiver_id_number": "12345678900",
          "receiver_name": "IAN CREASE",
          "trace_number": "021000038461022",
          "type": "ach_decline"
        },
        "category": "ach_decline"
      },
      "type": "declined_transaction"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 65a762d76560Revision changes
    • warning

      added the new pulse_tokenization_fee enum value to the /////// response property for the response status

  • c3efb1c0fccaRevision changes
    • warning

      added the new additional_customer_authentication_required enum value to the ////// response property for the response status