Skip to content
String Theory

Exchange knots for a different asset class

POST
/v1/exchange

Request Body required

Section titled “Request Body required ”

Money to exchange, asset class to exchange to, and exchange rate to use

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>
filters
object
availability
string
Allowed values: available withdrawn cancelled pending_deposit pending_withdrawal pending_transfer pending_return any
holdStatus
string
Allowed values: any held free
owner
required
object
type
required
string
id
required
string
from
required
object
unitType
required
string
Allowed values: currency_micros loyalty_points
unitToken
required
string
unitCount
One of:
string
/^-?[1-9]\d*$/
to
required
object
unitType
required
string
Allowed values: currency_micros loyalty_points
unitToken
required
string
unitCount
One of:
string
/^-?[1-9]\d*$/
exchangeRateKey
required
object
type
required
string
token
required
string
actor
required
object
type
required
string
id
required
string
strategy
string
Allowed values: smallest-largest newest-oldest random
actionData
object
key
additional properties
string
tags
object
key
additional properties
string
groupsToAdd
Array
Any of:
object
id
required
string
/group_[a-zA-Z0-9]{26}/
idempotencyKey
required
object
type
required
string
token
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Knots with the requested amount exchanged to the target asset class and any exchange rates used. Also returns the remaining knot if a split was required.

object
exchangedKnots
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
remainingKnot
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
exchangeRates
required
Array<object>
object
key
required
object
type
required
string
token
required
string
rate
required
string
idempotentResponse
required
boolean

400

Section titled “400 ”

Thrown when the requested amount is greater than the available balance

object
status
required
string
Allowed values: 400
message
required
string
type
required
string
Allowed values: InsufficientFundsError
data
required
object
sourceBalances
required
Array<object>
object
amount
required
object
unitType
required
string
Allowed values: currency_micros loyalty_points
unitToken
required
string
unitCount
required
integer
knotIds
required
Array<string>
requestedAmount
required
object
unitType
required
string
Allowed values: currency_micros loyalty_points
unitToken
required
string
unitCount
required
integer
overageAmount
required
object
unitType
required
string
Allowed values: currency_micros loyalty_points
unitToken
required
string
unitCount
required
integer