Create an outgoing request with selected UTXOs

post

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

This endpoint creates an outgoing request with manually selected UTXOs
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Body Params

amount

string

required

Amount in the smallest currency unit, based on the currency decimals. Example: 100000000 satoshi (smallest BTC unit) corresponds to 1 BTC (BTC has 8 decimals places)

feeLimit

string

fromAddressId

string

required

toAddressId

string

toWhitelistedAddressId

string

utxoIds

array of strings

required

utxoIds*

comment

string

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

feePaidByReceiver

boolean

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

transactionReference

string

Deprecated: use externalRequestId instead

externalRequestId

string

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

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.