Update trading account statuses

curl --request PATCH \
  --url https://api.example.com/api/accounts/status/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_ids": [
    2
  ],
  "custom_status_reason": "<string>"
}
'

import requests

url = "https://api.example.com/api/accounts/status/"

payload = {
    "account_ids": [2],
    "custom_status_reason": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_ids: [2], custom_status_reason: '<string>'})
};

fetch('https://api.example.com/api/accounts/status/', 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.example.com/api/accounts/status/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_ids' => [
        2
    ],
    'custom_status_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/accounts/status/"

	payload := strings.NewReader("{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.example.com/api/accounts/status/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/accounts/status/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}"

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

{
  "success": true,
  "results": [
    {
      "account_id": 1,
      "previous_status": "LIVE_VERIFICATION",
      "new_status": "BLOCKED",
      "changed": true
    }
  ],
  "summary": {
    "updated": 1,
    "unchanged": 0
  },
  "duration_ms": 38.77,
  "message": "Updated 1 accounts."
}

PATCH

api

accounts

status

Update trading account statuses

curl --request PATCH \
  --url https://api.example.com/api/accounts/status/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_ids": [
    2
  ],
  "custom_status_reason": "<string>"
}
'

import requests

url = "https://api.example.com/api/accounts/status/"

payload = {
    "account_ids": [2],
    "custom_status_reason": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_ids: [2], custom_status_reason: '<string>'})
};

fetch('https://api.example.com/api/accounts/status/', 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.example.com/api/accounts/status/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'account_ids' => [
        2
    ],
    'custom_status_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/accounts/status/"

	payload := strings.NewReader("{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<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.patch("https://api.example.com/api/accounts/status/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/accounts/status/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_ids\": [\n    2\n  ],\n  \"custom_status_reason\": \"<string>\"\n}"

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

{
  "success": true,
  "results": [
    {
      "account_id": 1,
      "previous_status": "LIVE_VERIFICATION",
      "new_status": "BLOCKED",
      "changed": true
    }
  ],
  "summary": {
    "updated": 1,
    "unchanged": 0
  },
  "duration_ms": 38.77,
  "message": "Updated 1 accounts."
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

account_ids

integer[]

Required range: x >= 1

status

enum<string>

PENDING_ACTIVATION - Pending Activation
ACTIVE - Active
PASSED - Passed
FAILED - Failed
BLOCKED - Blocked
DELETED - Deleted
LIVE_VERIFICATION - Live Account Verification Required
KYC_VERIFICATION_REQD - KYC Verification Required
PHASE_VERIFICATION_REQD - Phase Verification Required
PAUSED - PAUSED
SUBSCRIPTION_EXPIRED - Subscription Expired
PAYMENT_REQUESTED - Payment Requested

Available options:

PENDING_ACTIVATION,

ACTIVE,

PASSED,

FAILED,

BLOCKED,

DELETED,

LIVE_VERIFICATION,

KYC_VERIFICATION_REQD,

PHASE_VERIFICATION_REQD,

PAUSED,

SUBSCRIPTION_EXPIRED,

PAYMENT_REQUESTED

custom_status_reason

string | null

Optional note stored with the account status.

Response

200 - application/json

Standard serializer for operation responses. A command or a task should return a response matching this format. Operation = a request to perform some action, e.g. sync, update, delete, create, etc.

success

boolean

required

Indicates whether the operation completed successfully.

results

any[]

required

List containing the result items produced by the operation. The structure of each item depends on the executed operation.

summary

object

required

Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).

Show child attributes

duration_ms

number<double>

required

Execution time of the operation in milliseconds.

message

string | null

Optional human-readable message describing the operation outcome.

Accounts

Challenge

Entitlements

Status

Trade

Users

withdrawals

Auth

Update trading account statuses

Authorizations

Body

Response