priceWithdraw

Request for a base64-encoded unsigned price-based recurring order withdrawal transaction to be used in POST /recurring/v1/execute. Price-based recurring orders are deprecated, please use time-based recurring orders instead.

POST /priceWithdraw

priceWithdraw

cURL

curl --request POST \
  --url https://api.jup.ag/recurring/v1/priceWithdraw \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "inputOrOutput": "In",
  "order": "<string>",
  "user": "<string>",
  "amount": "<string>"
}
'

200

{
  "requestId": "<string>",
  "transaction": "<string>"
}

Authorizations

x-api-key · string · header · required

Get API key via https://portal.jup.ag

Body

application/json

DEPRECATED: Price-based recurring orders are deprecated

inputOrOutput · enum<string> · required

Available options: In, Out

order · string · required

Base-58 account which is the Recurring Order account

user · string · required

amount · string<int64> | null

If no amount is provided, it will withdraw the entire amount

Response

200

application/json

Withdraw transaction created successfully

requestId · string · required

Required to make a request to /execute

transaction · string · required

Unsigned base-64 encoded transaction