increase-test
POST/pending_transactions/{pending_transaction_id}/release

Release a user-initiated pending transaction

Releases a user-initiated pending transaction, unlocking the funds held by that transaction and marking it complete. The transaction must have the user_initiated_hold category and a pending status. Use pending_transaction_id to identify the transaction to release.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
pending_transaction_idstringrequired
The identifier of the pending transaction to release.

3 status codes
200Returns the updated pending transaction object, including its completed status and transaction details.
account_idstringrequired
The identifier for the account this Pending Transaction belongs to.
amountintegerrequired
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 part of the authorization. The amount that settled is available on the resulting Transaction and on the Card Payment's `state.settled_amount`.
completed_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction occurred.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
Allowed:USD
descriptionstringrequired
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_amountintegerrequired
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.
idstringrequired
The Pending Transaction identifier.
route_idstringrequired
The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
route_typestringrequired
The type of the route this Pending Transaction came through.
Allowed:account_numbercardlockbox
sourceobjectrequired
This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
statusstringrequired
Whether the Pending Transaction has been confirmed and has an associated Transaction.
Allowed:pendingcomplete
typestringrequired
A constant representing the object's type. For this resource it will always be `pending_transaction`.
Allowed:pending_transaction
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the request cannot be processed because of a server-side error.

Error handling

The pending transaction identified by the pending_transaction_id path parameter must have the user_initiated_hold category and pending status.