Create an outgoing request

POST

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

POST

/api/rest/v1/requests/outgoing

curl -X POST https://your-protect-instance.example.com/api/rest/v1/requests/outgoing \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": "100000",
  "fromAddressId": "1",
  "toAddressId": "204",
  "comment": "Ich bin eine flying Roasted Butternut Squash Boodles",
  "useUnconfirmedFunds": true,
  "feePaidByReceiver": true,
  "fee": "4865"
}'

{
  "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 an outgoing request. Required role: RequestCreator. This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

amountstringRequired

numeric; Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places)

feeLimitstringOptional

numeric; Maximum amount of fees to be paid for the transaction. For ETH it is the maximum amount of fees to be paid per unit of gas.

fromWalletIdstringOptionalformat: "uint64"

uint64; A source should be specified. Either fromAddressId or fromWalletId. fromWalletId should be used to specify an omnibus wallet only.

fromAddressIdstringOptionalformat: "uint64"

uint64; A source should be specified. Either fromAddressId or fromWalletId. fromAddressId should be used for using an address as source.

toAddressIdstringOptionalformat: "uint64"

uint64; A destination should be specified. Either toAddressId or toWhitelistedAddressId. To perform a batch transfer to multiple addresses, you can pass in multiple request objects in the body parameters. Each request object can specify its own toAddressId.

toWhitelistedAddressIdstringOptionalformat: "uint64"

uint64; A destination should be specified. Either toAddressId or toWhitelistedAddressId.

gasLimitstringOptional

numeric; Maximum gas committed to the transaction. For non-ETH chains, use feeLimit.

commentstringOptional

A reconciliation note can be given when initiating a request and this will be included in transaction history.

useUnconfirmedFundsbooleanOptional

Allow use of unconfirmed funds for this transaction

feePaidByReceiverbooleanOptional

If true, maximum amount of funds will be transferred, including fees. When false, fees are added on top of amount.

transactionCommentstringOptional

Max 256 characters external reference for the transaction.

useAllFundsbooleanOptional

If set to true, it will send all the funds from an address or from all the addresses of a wallet. If an address in a wallet can't pay the fees, it is skipped.

feePayerIdstringOptionalformat: "uint64"

uint64; The id of the fee payer to use for this transaction.

extendedAmountobjectOptional

transactionReferencestringOptional

Deprecated: Use externalRequestId instead

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

destinationAddressMemostringOptional

A memo can be specified if the destination is a whitelisted address on a blockchain supporting memos.

optsobjectOptional

travelRuleDataInputobjectOptional

feePayerAddressIdstringOptionalformat: "uint64"

Internal protect address designated to pay for the fees. Supported on SOL token transfers.

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