latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

Initiate a trustline transaction

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.

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

Path parameters

coinstring required

A cryptocurrency symbol or token ticker symbol

Example:btc

A cryptocurrency or token ticker symbol

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID

Request body

commentstring

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.

Example request

{
  "trustlines": [
    {
      "token": "txlm:BST-GBQTIOS3XGHB7LVYGBKQVJGCZ3R4JL5E4CBSWJ5ALIJUHBKS6263644L",
      "limit": "2000000"
    }
  ]
}

Response

Accepted

idstring required
coinstring

A cryptocurrency or token ticker symbol.

walletstring
walletTypestring
walletSubTypestring

The subtype of the wallet (e.g., custodialHot)

walletsstring[]
enterprisestring
organizationstring
safeIdstring

The safe the pending approval is scoped to

organizationNamestring

The organization name

bitgoOrgstring

The BitGo organization

creatorstring required
createDatestring date-time required

The creation date of the pending approval

approvedDatestring date-time

The date when the approval was granted

updatedAtstring date-time

The date when the approval was last updated (any update, not just processing)

keyCurve'secp256k1' | 'ed25519' | 'bls12_381'

The key curve of the coin attached to this pending approval

scope'enterprise' | 'wallet' | 'organization' | 'global' | 'safe' required

What kind of entity the Pending Approval is tied to

userIdsstring[]
approvalsRequirednumber
walletLabelstring

Label for the wallet

approversstring[]
txRequestIdstring uuid

Transaction request ID

versionnumber

Version of the pending approval

policyEvaluationIdstring

ID for the policy evaluation

useLegacyPolicyEngineboolean

Flag to use legacy policy engine

videoCallIdstring

ID for the video call

lastUpdatedstring date-time

The last date the approval was processing