Anchorage Digital Wallet Operations API

openapi: 3.2.0
info:
  version: 2.0.0
  title: Anchorage Digital API Reference Wallet Operations API
  contact:
    email: api@anchorage.com
  description: '# Introduction

    *CONFIDENTIAL: Please do not distribute this documentation externally without prior Anchorage Digital approval.*


    The Anchorage Digital REST API v2.0 provides a set of operations and resources that allow Anchorage Digital clients and partners to:

    - Programmatically transfer funds from an Anchorage Digital vault or wallet without human intervention

    - Create and list deposit addresses in a vault

    - Read and monitor vault balances

    - Query transaction history including deposits

    …'
servers:
- url: https://api.anchorage-staging.com/v3
security:
- Api-Access-Key: []
tags:
- description: Operations for creating and signing transactions that your organization broadcasts on-chain
  name: Wallet Operations
paths:
  /wallet-operations/{walletOperationId}:
    get:
      operationId: getWalletOperation
      summary: Get Wallet Operation
      description: 'Permissions required: **Read vault activity**


        Get details of a specific wallet operation by ID.


        Wallet operations represent transactions that your organization signed and broadcast on-chain,

        such as transfers and staking operations. To see the on-chain confirmation of a wallet operation or get information related to the specific action,

        query the blockchain-events endpoint using the walletOperationId filter.'
      parameters:
      - name: walletOperationId
        in: path
        description: The unique identifier of the wallet operation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletOperationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      tags:
      - Wallet Operations
  /wallet-operations:
    get:
      operationId: listWalletOperations
      summary: List Wallet Operations
      description: 'Permissions required: **Read vault activity**


        List wallet operations with optional filtering.


        Wallet operations represent transactions that your organization signed and broadcast on-chain.

        This includes transfers, staking operations, and other specialized transactions.


        To see the on-chain confirmation status and related events (such as fees) or get information related to the specific action, query the

        blockchain-events endpoint using the walletOperationId filter.'
      parameters:
      - name: after
        in: query
        description: When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)
        schema:
          type: string
      - name: first
        in: query
        description: Maximum number of results to return per query
        schema:
          type: integer
          format: int64
          default: 25
          maximum: 100
          minimum: 1
      - name: vaultId
        in: query
        description: Filter by vault ID
        required: false
        schema:
          type: string
      - name: walletId
        in: query
        description: Filter by wallet ID
        required: false
        schema:
          type: string
      - name: networkId
        in: query
        description: A unique string identifying a combination of blockchain and environment (testnet, mainnet).
        required: false
        schema:
          type: string
      - name: status
        in: query
        description: Filter by wallet operation status (PENDING, COMPLETED, FAILED)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWalletOperationsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      tags:
      - Wallet Operations
components:
  schemas:
    WalletOperationResponse:
      type: object
      properties:
        walletOperation:
          $ref: '#/components/schemas/WalletOperation'
      required:
      - walletOperation
    Page:
      description: Pagination info
      type: object
      properties:
        endCursor:
          description: Submit this parameter in the "after" field to fetch the next page.
          type:
          - string
          - 'null'
      title: Page
    ListWalletOperationsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WalletOperation'
        page:
          $ref: '#/components/schemas/Page'
      required:
      - data
      - page
    WalletOperation:
      description: 'A wallet operation represents a transaction that your organization signed and broadcast on-chain.


        The operation progresses through multiple states from construction to signing to broadcast.

        Use the status field to determine the current state. To see the on-chain confirmation status,

        query the blockchain-events endpoint using the walletOperationId filter.'
      type: object
      properties:
        createdAt:
          description: The timestamp when the wallet operation was created
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        expectedTransactionHash:
          description: The predicted blockchain transaction hash before broadcast. This field is optional as some blockchains don't allow predicting the hash until after broadcast. May differ from the actual on-chain transaction hash.
          type:
          - string
          - 'null'
          example: '0xabcd1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab'
        failureReason:
          description: The reason for failure when status is FAILED. Null for non-failed operations.
          type:
          - string
          - 'null'
        networkId:
          description: A unique string identifying a combination of blockchain and environment (testnet, mainnet).
          type: string
          example: ETH
        signedTransaction:
          description: The signed transaction data, encoded as a hex string. This field is null until the transaction has been signed.
          type:
          - string
          - 'null'
        status:
          description: 'The current status of the wallet operation. PENDING: operation is being processed (signing, awaiting approvals). COMPLETED: operation has been signed and broadcast to the blockchain. FAILED: operation failed during signing or broadcast. Note: COMPLETED indicates the transaction was broadcast, not that it was confirmed on-chain. Query blockchain-events to see on-chain confirmation status.'
          type: string
          enum:
          - PENDING
          - COMPLETED
          - FAILED
        walletOperationId:
          description: The unique identifier for the wallet operation
          type: string
          example: op_550e8400-e29b-41d4-a716-446655440000
      required:
      - walletOperationId
      - networkId
      - status
      - createdAt
    ErrorDetails:
      type: object
      properties:
        message:
          description: A human-readable message providing more details about the error.
          type: string
          example: Missing required field 'amount'.
      required:
      - message
      title: ErrorDetails
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role
x-tagGroups:
- name: Under Development
  tags:
  - Atlas Settlement Network
- name: API Endpoints
  tags:
  - Addresses
  - Wallets
  - Stablecoins
  - Wallet Operations
  - Blockchain Events
  - Balances
  - Asset Types & Networks
  - Transaction Creation
  - Transaction Construction
  - Fiat Banking Operations
  - AML