Sign in
Balance-Holds

Get balance hold

Returns details for a specific hold on an account.

get/balance-holds/{id}

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/balance-holds/{id}
  • Auth: none declared

Path parameters

idstring required

Hold ID

Headers

tokenstring

JWT Client token

Response

A specific hold on the provided account

idstring required

The full balance hold id.

statusstring required

The status of the balance hold.

createdAtstring date-time required

The date and time in UTC at which the balance hold was created.

expirationDateTimestring date-time required

The date and time in UTC at which the balance hold will expire.

updatedAtstring date-time required

The date and time in UTC at which any update was made to the balance hold.

requestedAmountnumber required

The amount that was initially requested.

authorizedAmountnumber required

The amount that was initially authorized. This could be different than the requested amount if partial authorizations take place.

pendingAmountnumber required

The amount that is currently being held.

currencystring required

The currency code used for the balance hold.

debtorAccountIdstring

The VAID of the account the balance hold is placed on.

debtorAccountNumberstring required

The PRN of the account the balance hold is placed on.

Example response

{
  "id": "eeeceb81-5e25-4949-a5bb-a5f7aa8dcf0f",
  "status": "PENDING",
  "createdAt": "2024-02-02T15:49:07.573Z",
  "expirationDateTime": "2024-02-12T15:49:07.573Z",
  "updatedAt": "2024-02-02T15:49:07.573Z",
  "requestedAmount": 12.41,
  "authorizedAmount": 12.42,
  "pendingAmount": 12.42,
  "currency": "USD",
  "debtorAccountId": "dc2eda9084bf40b7a1d8baa8c5e0ea0ax",
  "debtorAccountNumber": "91950342739438",
  "typeSpecificAttributes": {
    "id": "100000158367",
    "cardLast4": "4619",
    "merchantName": "CASH & CARRY",
    "authCode": "8dcf0f"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.