Cancel Order

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

POST /cancelOrder

cancelOrder

cURL

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

import requests

url = "https://api.jup.ag/recurring/v1/cancelOrder"

payload = {
    "order": "<string>",
    "user": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({order: '<string>', user: '<string>'})
};

fetch('https://api.jup.ag/recurring/v1/cancelOrder', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jup.ag/recurring/v1/cancelOrder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'order' => '<string>',
    'user' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/recurring/v1/cancelOrder"

	payload := strings.NewReader("{\n  \"order\": \"<string>\",\n  \"user\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jup.ag/recurring/v1/cancelOrder")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"order\": \"<string>\",\n  \"user\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/recurring/v1/cancelOrder")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"order\": \"<string>\",\n  \"user\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "requestId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "transaction": "AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAAEN..."
}

NOTE

• recurringType is used to denote the type of recurring order, only time
• DEPRECATED: recurringType: price based orders are deprecated
• Refer to Recurring API doc for more information.

Authorizations

x-api-key · string · header · required

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

Body

application/json

order · string · required

Base-58 account which is the Recurring Order account

recurringType · enum<string> · required

• Type of recurring order to close.
• DEPRECATED: The 'price' value is deprecated.

Available options: time, price

user · string · required

Response

200

application/json

Recurring order closed successfully

requestId · string · required

Required to make a request to /execute

transaction · string · required

Unsigned base-64 encoded transaction