Create a SOL withdraw request

POST

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/sol/withdraw

POST

/api/rest/v1/requests/outgoing/sol/withdraw

curl -X POST https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/sol/withdraw \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "fromAddressId": "string",
  "amount": "string"
}'

{
  "result": {
    "id": "442",
    "tenantId": "1",
    "currency": "BTC",
    "envelope": "CgM0NDIQmfGjk6Ops/oVGAEqmgUSrAEKPwoPbS80NCcvMCcvMCcvMC8wGiAeyruP7CoNYcGISzRo8iZmuVnV6M9gLiZuShy7aDtKKiABKNHEFDD/////DxIoCiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2EJ/nBRoVCg9tLzQ0Jy8wJy8wJy8wLzAYsbcOMig0NDI6NDY5ZTMxOGUtYjcxZC00MGUwLTg0ZjctNzVlOGQwOWE3Yzg2IhMKCnJlcXVlc3RfaWQQARoDNDQyIhIKCXJ1bGVzX2tleRABGgNCVEMiEQoIY3VycmVuY3kQARoDQlRDIlsKBnNvdXJjZRAEGkcIARJDCAESIjFKTUJZTU1pOWlqSlJlVFlxdEZUU2RlVkJ6azhOSGRzVHUaCm5vc3RybyBCVEMiD20vNDQnLzAnLzAnLzAvMCIGc291cmNlImIKC2Rlc3RpbmF0aW9uEAUaRBJCCMwBEiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2GghteSBsYWJlbCIPbS80NCcvMCcvMCcvMC84IgtkZXN0aW5hdGlvbiKeAQoGYW1vdW50EAoaiQEKAwGGoBIHMTAuMDQzMBoKMTAwNDIuOTcwMCAIKgNCVEMyA0NIRjphCh12YWxpZGF0b3ItY29yZUB0YXVydXNncm91cC5jaBJAffe4nBGVSajYYQxxzEZbQuj0snr8WOC1P506eXRn2EUsDrAnkWvNW9wfU+pwUoBVUaXl/veYW/6m/DJsEKijLCIGYW1vdW50Ih4KEXRvdGFsX2ZpYXRfYW1vdW50EAEaBzEwLjA0MzAiCwoDZmVlEAIaAhMBIh4KFGZlZV9wYWlkX2J5X3JlY2VpdmVyEAEaBHRydWU=",
    "status": "CREATED",
    "trails": [
      {
        "userId": "11",
        "externalUserId": "team1@bank.com",
        "action": "created",
        "comment": "Ich bin eine flying Roasted Butternut Squash Boodles",
        "requestStatus": "CREATED"
      },
      {
        "userId": "1",
        "externalUserId": "validator-core@taurusgroup.ch",
        "action": "approvers_assigned",
        "comment": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]",
        "requestStatus": "CREATED"
      }
    ],
    "rule": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]",
    "approvers": {
      "parallel": [
        {
          "sequential": [
            {
              "externalGroupID": "team1",
              "minimumSignatures": 1
            },
            {
              "externalGroupID": "team2",
              "minimumSignatures": 1
            }
          ]
        }
      ]
    }
  }
}

This endpoint creates a withdrawal request for SOL. This will send the inactive amount from the stake account to the address. Required role: RequestCreator.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

fromAddressIdstringRequiredformat: "uint64"

The ID of the SOL address to withdraw funds from.

amountstringRequired

Amount to withdraw.

feeLimitstringOptional

Fee limit.

commentstringOptional

Comment to be added to request trail.

useUnconfirmedFundsbooleanOptional

Whether to use (unreserved) unconfirmed funds for withdrawal.

externalRequestIdstringOptional

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request.

fromStakeAccountDerivationIndexstringOptionalformat: "uint64"

Determines which derived stake account will be withdrawn from.

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error