Skip to content
String Theory

Returns all knots associated with the specified hold(s)

POST
/v3/holds/knots

Request Body required

Section titled “Request Body required ”

Get knots by holds

object
holds
required
Array
Any of:
object
id
required
string
/hold_[a-zA-Z0-9]{26}/
filters
object
availability
One of:
string
Allowed values: available withdrawn cancelled pending_deposit pending_withdrawal pending_transfer pending_return staged_transfer any
current
string
Allowed values: current old any
owner
object
type
required
string
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

All knots associated with the specified hold(s)

object
heldKnots
required
Array<object>
object
id
required
string
/knot_[a-zA-Z0-9]{26}/
availability
required
string
Allowed values: available withdrawn cancelled pending_deposit pending_withdrawal pending_transfer pending_return staged_transfer
parentKnotId
string
/knot_[a-zA-Z0-9]{26}/
createdAt
required
string format: date-time
unitCount
required
integer
unitType
required
string
Allowed values: currency_micros
unitToken
required
string
ownerType
required
string
ownerId
required
string
actorType
required
string
actorId
required
string
actionType
required
string
Allowed values: add_group add_hold allocate alter_destination alter_groups alter_source cancel_deposit cancel_return cancel_withdrawal confirm_deposit confirm_return confirm_withdrawal deposit exchange loan pending_deposit pending_return pending_withdrawal release_hold remove_group repay restore_pending_deposit return split stage_transfer tags transfer transfer_deposit transfer_withdrawal withdraw
actionData
required
object
key
additional properties
string
depositThreadId
required
string
/thread_[a-zA-Z0-9]{26}/
currentThreadId
required
string
/thread_[a-zA-Z0-9]{26}/
nextSplitThreadId
required
string
/thread_[a-zA-Z0-9]{26}/
nextSplitKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
nextRemainingKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
tags
required
object
key
additional properties
string
depositSource
Any of:
object
internalTransfer
required
string
transferId
required
string
/transfer_[a-zA-Z0-9]{26}/
stagedKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
withdrawnKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
sourceGroupId
required
string
/group_[a-zA-Z0-9]{26}/
transferGroupType
required
string
Allowed values: st-transfer
transferGroupToken
required
string
type
required
string
token
required
string
withdrawalDestination
Any of:
object
internalTransfer
required
string
transferId
required
string
/transfer_[a-zA-Z0-9]{26}/
destinationKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
destinationGroupId
required
string
/group_[a-zA-Z0-9]{26}/
transferGroupType
required
string
Allowed values: st-transfer
transferGroupToken
required
string
type
required
string
token
required
string
current
required
boolean
threads
required
Array<object>
object
id
required
string
/thread_[a-zA-Z0-9]{26}/
type
required
string
Allowed values: root split
createdAt
required
string format: date-time
initialKnotId
required
string
/knot_[a-zA-Z0-9]{26}/
actorType
required
string
actorId
required
string
unitCount
required
integer
unitType
required
string
Allowed values: currency_micros
unitToken
required
string
ownerType
required
string
ownerId
required
string
groups
required
Array<object>
object
type
required
string
token
required
string
id
required
string
/group_[a-zA-Z0-9]{26}/
ownerType
required
string
ownerId
required
string
holds
required
Array<object>
object
id
required
string
/hold_[a-zA-Z0-9]{26}/
type
required
string
token
required
string
owner
required
object
type
required
string
id
required
string
actor
required
object
type
required
string
id
required
string
createdAt
required
string format: date-time