Ctrl+K

Post Transaction Route Internal

post/api/route-composition/internal/v1/transaction-routes

Allows the creation of a Route for any supported type of routed transaction. For use only by Bitgo-Internal.

Request Body

rtType string required
route type for transaction routes
Allowed values: RT_AUTO_LIQUIDATION RT_FINANCING RT_OES_ONCHAIN_SETTLEMENT RT_TRADE_CLIENT_SETTLEMENT RT_CLEARING_QUEUE_AUTOMATION
dataOne ofrequired
route metadata for auto-liquidation routes
rtType string required
Allowed value: RT_AUTO_LIQUIDATION
addressValue string required
Min length: >= 1 characters
apiTradeProduct string required
Min length: >= 1 characters
exCoin string required
exCoin is the coin we are trading away, e.g. BTC in a BTC-USD sell trade
Min length: >= 1 characters
enterpriseId string
enterprise id for transaction routes
walletId string
wallet id for transaction routes
ownerUserId string
owner user id for transaction routes
nonce string
nonce for use with signable routes, to prevent replay attacks
payload string
payload for transaction routes
globalOne of
activeOne of

201 Response

transactionRoute object required
transaction route business object data model - used within the application/as a response codec
id string required
route id for transaction routes
rtType string required
route type for transaction routes
Allowed values: RT_AUTO_LIQUIDATION RT_FINANCING RT_OES_ONCHAIN_SETTLEMENT RT_TRADE_CLIENT_SETTLEMENT RT_CLEARING_QUEUE_AUTOMATION
dataOne ofrequired
route metadata for auto-liquidation routes
enterpriseId string
enterprise id for transaction routes
walletId string
wallet id for transaction routes
ownerUserId string
owner user id for transaction routes
nonce string
nonce for use with signable routes, to prevent replay attacks
payload string
payload for transaction routes
signature string
signature for transaction routes
proof string
proof of signature for transaction routes
global boolean required
global status for transaction routes
active boolean required
active status for transaction routes
createdAtOne ofrequired
creation timestamp for transaction routes, decodes from date or ISO Date string
updatedAtOne ofrequired
updated timestamp for transaction routes, decodes from date or ISO Date string