Withdrawal

Get withdrawals handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/withdrawal

Query parameters

statusstring · enumRequired

The status of the in-flight sBTC withdrawal.

Possible values:

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Withdrawals retrieved successfully

application/json

Response to get withdrawals request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/withdrawal

HTTPcURLJavaScriptPython

GET /withdrawal?status=pending HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "nextToken": "text",
  "withdrawals": [
    {
      "amount": 1,
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "requestId": 1,
      "sender": "text",
      "stacksBlockHash": "text",
      "stacksBlockHeight": 1,
      "status": "pending",
      "txid": "text"
    }
  ]
}

Update withdrawals handler.

put

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/withdrawal

Authorizations

ApiGatewayKey

x-api-keystringRequired

AWS Apigateway key

Body

application/json

Request structure for the create withdrawal request.

Responses

200

Withdrawals updated successfully

application/json

Response to update withdrawals request.

400

Invalid request body

application/json

403

Forbidden

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

put

/withdrawal

HTTPcURLJavaScriptPython

PUT /withdrawal HTTP/1.1
Host: localhost:3031
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "withdrawals": [
    {
      "expectedFulfillmentInfo": {
        "bitcoinBlockHeight": 1,
        "bitcoinTxid": "text"
      },
      "fulfillment": {
        "BitcoinBlockHash": "text",
        "BitcoinBlockHeight": 1,
        "BitcoinTxIndex": 1,
        "BitcoinTxid": "text",
        "BtcFee": 1,
        "StacksTxid": "text"
      },
      "requestId": 1,
      "status": "pending",
      "statusMessage": "text"
    }
  ]
}

{
  "withdrawals": [
    {
      "error": "text",
      "status": 1,
      "withdrawal": {
        "amount": 1,
        "expectedFulfillmentInfo": {
          "bitcoinBlockHeight": 1,
          "bitcoinTxid": "text"
        },
        "fulfillment": {
          "BitcoinBlockHash": "text",
          "BitcoinBlockHeight": 1,
          "BitcoinTxIndex": 1,
          "BitcoinTxid": "text",
          "BtcFee": 1,
          "StacksTxid": "text"
        },
        "lastUpdateBlockHash": "text",
        "lastUpdateHeight": 1,
        "parameters": {
          "maxFee": 1
        },
        "recipient": "text",
        "requestId": 1,
        "sender": "text",
        "stacksBlockHash": "text",
        "stacksBlockHeight": 1,
        "status": "pending",
        "statusMessage": "text",
        "txid": "text"
      }
    }
  ]
}

Get withdrawals by recipient handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/withdrawal/recipient/{recipient}

Path parameters

recipientstringRequired

The recipient's hex-encoded scriptPubKey, used to filter withdrawals.

Query parameters

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Withdrawals retrieved successfully

application/json

Response to get withdrawals request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/withdrawal/recipient/{recipient}

HTTPcURLJavaScriptPython

GET /withdrawal/recipient/{recipient} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "nextToken": "text",
  "withdrawals": [
    {
      "amount": 1,
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "requestId": 1,
      "sender": "text",
      "stacksBlockHash": "text",
      "stacksBlockHeight": 1,
      "status": "pending",
      "txid": "text"
    }
  ]
}

Get withdrawals by sender handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/withdrawal/sender/{sender}

Path parameters

senderstringRequired

The sender's Stacks principal, used to filter withdrawals.

Query parameters

nextTokenstring · nullableOptional

the next token value from the previous return of this api call.

pageSizeinteger · int32 · nullableOptional

the maximum number of items in the response list.

Responses

200

Withdrawals retrieved successfully

application/json

Response to get withdrawals request.

nextTokenstring · nullableOptional

Next token for the search.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/withdrawal/sender/{sender}

HTTPcURLJavaScriptPython

GET /withdrawal/sender/{sender} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "nextToken": "text",
  "withdrawals": [
    {
      "amount": 1,
      "lastUpdateBlockHash": "text",
      "lastUpdateHeight": 1,
      "recipient": "text",
      "requestId": 1,
      "sender": "text",
      "stacksBlockHash": "text",
      "stacksBlockHeight": 1,
      "status": "pending",
      "txid": "text"
    }
  ]
}

Get withdrawal handler.

get

http://localhost:3031https://sbtc-emily.comhttps://temp.sbtc-emily-dev.com

/withdrawal/{id}

Path parameters

idinteger · int64Required

id associated with the Withdrawal

Responses

200

Withdrawal retrieved successfully

application/json

Withdrawal.

amountinteger · int64Required

Amount of BTC being withdrawn in satoshis.

lastUpdateBlockHashstringRequired

The most recent Stacks block hash the API was aware of when the withdrawal was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this hash is the Stacks block hash that contains that artifact.

lastUpdateHeightinteger · int64Required

The most recent Stacks block height the API was aware of when the withdrawal was last updated. If the most recent update is tied to an artifact on the Stacks blockchain then this height is the Stacks block height that contains that artifact.

recipientstringRequired

The recipient's hex-encoded Bitcoin scriptPubKey.

requestIdinteger · int64Required

The id of the Stacks withdrawal request that initiated the sBTC operation.

senderstringRequired

The sender's hex-encoded Stacks principal.

stacksBlockHashstringRequired

The stacks block hash in which this request id was initiated.

stacksBlockHeightinteger · int64Required

The height of the Stacks block in which this request id was initiated.

statusstring · enumRequired

The status of the in-flight sBTC withdrawal.

Possible values:

statusMessagestringRequired

The status message of the withdrawal.

txidstringRequired

The hex encoded txid of the stacks transaction that generated this event.

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get

/withdrawal/{id}

HTTPcURLJavaScriptPython

GET /withdrawal/{id} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "amount": 1,
  "expectedFulfillmentInfo": {
    "bitcoinBlockHeight": 1,
    "bitcoinTxid": "text"
  },
  "fulfillment": {
    "BitcoinBlockHash": "text",
    "BitcoinBlockHeight": 1,
    "BitcoinTxIndex": 1,
    "BitcoinTxid": "text",
    "BtcFee": 1,
    "StacksTxid": "text"
  },
  "lastUpdateBlockHash": "text",
  "lastUpdateHeight": 1,
  "parameters": {
    "maxFee": 1
  },
  "recipient": "text",
  "requestId": 1,
  "sender": "text",
  "stacksBlockHash": "text",
  "stacksBlockHeight": 1,
  "status": "pending",
  "statusMessage": "text",
  "txid": "text"
}