Release a user-initiated Pending Transaction

Changed on

Release a Pending Transaction you had previously created. The Pending Transaction must have a category of user_initiated_hold and a status of pending. This will unlock the held funds and mark the Pending Transaction as complete.

post/pending_transactions/{pending_transaction_id}/release

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/pending_transactions/{pending_transaction_id}/release
  • Auth
    HTTP bearer

Path parameters

pending_transaction_idstring required

The identifier of the Pending Transaction to release.

Response

Pending Transaction

account_idstring required

The identifier for the account this Pending Transaction belongs to.

amountinteger required

The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents. For a card authorization this is the amount still held: it decreases when the merchant reverses or partially settles the authorization. The amount that settled is available on the resulting Transaction and on the Card Payment's state.settled_amount.

completed_atstring date-time nullable required

The ISO 8601 date on which the Pending Transaction was completed.

created_atstring date-time required

The ISO 8601 date on which the Pending Transaction occurred.

currency'USD' required

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

descriptionstring required

For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.

held_amountinteger required

The amount that this Pending Transaction decrements the available balance of its Account. This is usually the same as amount, but will differ if the amount is positive.

idstring required

The Pending Transaction identifier.

route_idstring nullable required

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

route_type'account_number' | 'card' | 'lockbox' nullable required

The type of the route this Pending Transaction came through.

status'pending' | 'complete' required

Whether the Pending Transaction has been confirmed and has an associated Transaction.

type'pending_transaction' required

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

Example response

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

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 optional property / to the response with the status

    • info

      added the optional property / to the response with the status