Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Bank Accounts

Get a protected bank account balance

Retrieves a specified protected account balance record.

get/bankaccounts/{id}/protected-balances/{protectionId}

Path parameters

idstring required
protectionIdstring required

Response

When request is successful. Returns a 'ProtectedAccountBalance' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the protection record.

amountnumber double

The amount protected in dollars. Limited to 2 decimal places (cents).

reasonstring nullable

Reason for protecting the funds.

effectiveDatestring date-time

Date the protection took effect.

timestampstring date-time

Timestamp when the protection was created.

isProtectedboolean

True if the funds are currently protected.

userIdstring nullable

Unique identifier of the user who protected the funds.

unprotectingUserIdstring nullable

Unique identifier of the user who unprotected the funds (if applicable).

lastUpdatedstring date-time

Timestamp when the protection was last updated (e.g. protected or unprotected).

Example response

{
  "id": "p1",
  "amount": 100.5,
  "reason": "Court order requiring protection of funds",
  "effectiveDate": "2024-01-15T00:00:00Z",
  "timestamp": "2024-01-15T10:30:00Z",
  "isProtected": true,
  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "unprotectingUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "lastUpdated": "2024-01-15T10:30:00Z"
}