API Reference — Increase

Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.

The Declined Transaction object

{
  "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"
}

Attributes

account_id

string

The identifier for the Account the Declined Transaction belongs to.

amount

integer

The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

created_at

string

The ISO 8601 date on which the Transaction occurred.

currency

enum

The ISO 4217 code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.

description

string

This is the description the vendor provides.

string

The Declined Transaction identifier.

route_id

string

Nullable

The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.

route_type

enum

Nullable

The type of the route this Declined Transaction came through.

source

dictionary

This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.

type

string

A constant representing the object's type. For this resource it will always be declined_transaction.

List Declined Transactions

curl \
  --url "${INCREASE_URL}/declined_transactions" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

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

account_id

string

Filter Declined Transactions to ones belonging to the specified Account.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

route_id

string

Filter Declined Transactions to those belonging to the specified route.

category.in

array of strings

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.

Retrieve a Declined Transaction

curl \
  --url "${INCREASE_URL}/declined_transactions/declined_transaction_17jbn0yyhvkt4v4ooym8" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

declined_transaction_id

string

Required

The identifier of the Declined Transaction.