Create an outgoing request

post

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

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

Body Params

amount

string

required

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)

feeLimit

string

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.

fromWalletId

string

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

fromAddressId

string

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

toAddressId

string

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.

toWhitelistedAddressId

string

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

gasLimit

string

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

comment

string

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

useUnconfirmedFunds

boolean

Allow use of unconfirmed funds for this transaction

feePaidByReceiver

boolean

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

transactionComment

string

Max 256 characters external reference for the transaction.

useAllFunds

boolean

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.

feePayerId

string

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

extendedAmount

object

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

destinationAddressMemo

string

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

opts

object

travelRuleDataInput

object

feePayerAddressId

string

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

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.