Ctrl+K

Initiate a trustline transaction

post/api/v2/{coin}/wallet/{walletId}/trustline/initiate

Initiate an unsigned trustline transaction to create a pending approval. Trustline transactions manage trusted tokens on the account. Available for Stellar. Use only with custodial wallets.

Path Parameters

  • coinstringRequired
    A cryptocurrency or token ticker symbol.
    Example: "btc"
  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

memo object
The memo contains optional extra information that can also be used to identify payments in Stellar.
type string
value string
comment string
Optional metadata (only persisted in BitGo) to be applied to the transaction. Use this to add transaction-specific information such as the transaction's purpose or another identifier that you want to reference later. The value is shown in the UI in the transfer listing page.
Max length: <= 256 characters
trustlines array[object] required
List of trustlines to manage on the account.
token string
One of the supported coin types for Stellar tokens listed in [Coin-specific-implementation](#tag/Coin-specific-implementation)
Example: txlm:BST-GBQTIOS3XGHB7LVYGBKQVJGCZ3R4JL5E4CBSWJ5ALIJUHBKS6263644L
action
Allowed values: add remove
limit string
String representation of the amount to limit in base units (stroops)
Example: 2000000
Match pattern: ^-?\d+$

202 Response

id string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coin string
A cryptocurrency or token ticker symbol.
Example: btc
wallet string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
creator string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
createDate string <date-time>
infoAny of
transactionRequest object
type string
Allowed value: transactionRequest
stateAny of
scope string
What kind of entity the Pending Approval is tied to
Allowed values: enterprise wallet
userIds array[string]
All the Users who should see this Pending Approval
approvalsRequired integer
Minimum: >= 1
Example: 1
walletLabel string
resolvers array[object]
user string required
date string required
resolutionType string required
Allowed values: approved awaitingSignature pending pendingBitGoAdminApproval pendingCryptographicApproval pendingCustodianApproval pendingFinalApproval pendingIdVerification pendingVideoApproval processing rejected
signatures array[string] required
videoApprover string
videoLink string
videoException string
addressLabels array[object]
address string required
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
label
string or null
required
A human-readable label for the address.
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
walletLabel string
Example: My Wallet

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code