priceWithdraw

POST 
https://lite-api.jup.ag/recurring/v1/priceWithdraw

Request for a base64-encoded unsigned price-based recurring order withdrawal transaction to be used in POST /recurring/v1/execute

note

• Recurring orders auto withdraws the output mint amount after each time the order is executed
• Withdrawal does not close the order, you will need to close the order manually
• Refer to Recurring API doc for more information

Request

application/json

Bodyrequired

amountint64nullable
If no amount is provided, it will withdraw the entire amount
Possible values: >= 0
inputOrOutputWithdrawal (string)required
Possible values: [In, Out]
orderstringrequired
Base-58 account which is the Recurring Order account
userstringrequired

Responses

200

Withdraw transaction created successfully

application/json

Schema

Schema

requestIdstringrequired

Required to make a request to /execute

transactionstringrequired

Unsigned base-64 encoded transaction

Example (auto)

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

400

Bad request

500

Internal server error

• curl
• nodejs
• python
• rust

• CURL

curl -L 'https://lite-api.jup.ag/recurring/v1/priceWithdraw' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "inputOrOutput": "In",
  "order": "string",
  "user": "string"
}'

Request Collapse all

Base URL

https://lite-api.jup.ag/recurring/v1

Body required

{
  "inputOrOutput": "In",
  "order": "string",
  "user": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!