List Pending Transactions

Changed on
get/pending_transactions

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/pending_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 pending transactions to those belonging to the specified Account.

route_idstring

Filter pending 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.

status.instring[]

Filter Pending Transactions for those with the specified status. By default only Pending Transactions with status pending will be returned. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

Response

Pending 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": -100,
      "completed_at": null,
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "description": "INVOICE 2468",
      "held_amount": -100,
      "id": "pending_transaction_k1sfetcau2qbvjbzgju4",
      "route_id": null,
      "route_type": null,
      "source": {
        "ach_transfer_instruction": {
          "amount": 100,
          "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
        },
        "category": "ach_transfer_instruction"
      },
      "status": "pending",
      "type": "pending_transaction"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 65a762d76560Revision changes
    • warning

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

  • e1ee909f1683Revision changes
    • warning

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

    • warning

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

    • info

      added the enum value sepa_instant_transfer_instruction to the property items/ of the query request parameter category.in

    • info

      added the enum value uk_faster_payment_system_transfer_instruction to the property items/ of the query request parameter category.in

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status