Skip to content
String Theory

Confirms a pending withdrawal, making it withdrawn

POST
/v2/withdraw/confirm

Request Body required

Section titled “Request Body required ”

Confirm a pending withdrawal

object
sources
required
object
knotIds
Array<string>
threadIds
Array<string>
groupUnions
Array
Any of:
object
id
required
string
/group_[a-zA-Z0-9]{26}/
groupIntersections
Array<Array>
owner
required
object
type
required
string
id
required
string
actor
required
object
type
required
string
id
required
string
tags
object
key
additional properties
string
idempotencyKey
required
object
type
required
string
token
required
string
actionData
object
key
additional properties
string
groupsToAdd
Array
Any of:
object
id
required
string
/group_[a-zA-Z0-9]{26}/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Withdrawn knots that were previously pending

object
knots
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
parentKnotId
string
/knot_[a-zA-Z0-9]{26}/
createdAt
required
string format: date-time
unitCount
required
integer
unitType
required
string
Allowed values: currency_micros loyalty_points
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_groups 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 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
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 loyalty_points
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
idempotentResponse
required
boolean

500

Section titled “500 ”

Thrown when the requested knots are in a state incompatible with the operation

object
status
required
string
Allowed values: 500
message
required
string
type
required
string
Allowed values: InvalidStateError
data
required
object
invalidKnotIds
required
Array<string>