Create Automation

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "action": {
    "action_type": "Sweep",
    "data": {}
  },
  "schedule": {
    "frequency": "<string>",
    "offset": 123,
    "time": "<string>"
  }
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations"

payload = {
    "action": {
        "action_type": "Sweep",
        "data": {}
    },
    "schedule": {
        "frequency": "<string>",
        "offset": 123,
        "time": "<string>"
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-API-Nonce": "<api-key>",
    "X-API-Signature": "<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>',
    'X-API-Nonce': '<api-key>',
    'X-API-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: {action_type: 'Sweep', data: {}},
    schedule: {frequency: '<string>', offset: 123, time: '<string>'}
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations', 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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations",
  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([
    'action' => [
        'action_type' => 'Sweep',
        'data' => [
                
        ]
    ],
    'schedule' => [
        'frequency' => '<string>',
        'offset' => 123,
        'time' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-Nonce: <api-key>",
    "X-API-Signature: <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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations"

	payload := strings.NewReader("{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-API-Nonce", "<api-key>")
	req.Header.Add("X-API-Signature", "<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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations")
  .header("X-API-KEY", "<api-key>")
  .header("X-API-Nonce", "<api-key>")
  .header("X-API-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations")

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["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}"

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

{
  "data": {
    "account_id": 123,
    "action": "<unknown>",
    "action_type": "Sweep",
    "condition": {
      "amount": "<string>",
      "amount_currency": "<string>",
      "comparison": "<string>",
      "entity": "<string>",
      "asset_symbol": "<string>"
    },
    "created_at": "<string>",
    "enabled": true,
    "id": 123,
    "last_run_at": "<string>",
    "rule_id": 123,
    "schedule": {
      "frequency": "<string>",
      "offset": 123,
      "time": "<string>"
    },
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

POST

partners

accounts

{account_ref}

automations

Create Automation

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "action": {
    "action_type": "Sweep",
    "data": {}
  },
  "schedule": {
    "frequency": "<string>",
    "offset": 123,
    "time": "<string>"
  }
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations"

payload = {
    "action": {
        "action_type": "Sweep",
        "data": {}
    },
    "schedule": {
        "frequency": "<string>",
        "offset": 123,
        "time": "<string>"
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-API-Nonce": "<api-key>",
    "X-API-Signature": "<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>',
    'X-API-Nonce': '<api-key>',
    'X-API-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    action: {action_type: 'Sweep', data: {}},
    schedule: {frequency: '<string>', offset: 123, time: '<string>'}
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations', 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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations",
  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([
    'action' => [
        'action_type' => 'Sweep',
        'data' => [
                
        ]
    ],
    'schedule' => [
        'frequency' => '<string>',
        'offset' => 123,
        'time' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-Nonce: <api-key>",
    "X-API-Signature: <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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations"

	payload := strings.NewReader("{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-API-Nonce", "<api-key>")
	req.Header.Add("X-API-Signature", "<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://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations")
  .header("X-API-KEY", "<api-key>")
  .header("X-API-Nonce", "<api-key>")
  .header("X-API-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations")

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["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": {\n    \"action_type\": \"Sweep\",\n    \"data\": {}\n  },\n  \"schedule\": {\n    \"frequency\": \"<string>\",\n    \"offset\": 123,\n    \"time\": \"<string>\"\n  }\n}"

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

{
  "data": {
    "account_id": 123,
    "action": "<unknown>",
    "action_type": "Sweep",
    "condition": {
      "amount": "<string>",
      "amount_currency": "<string>",
      "comparison": "<string>",
      "entity": "<string>",
      "asset_symbol": "<string>"
    },
    "created_at": "<string>",
    "enabled": true,
    "id": 123,
    "last_run_at": "<string>",
    "rule_id": 123,
    "schedule": {
      "frequency": "<string>",
      "offset": 123,
      "time": "<string>"
    },
    "updated_at": "<string>"
  },
  "error": true,
  "message": "<string>"
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Authorizations

X-API-KEY

string

header

required

X-API-Nonce

string

header

required

X-API-Signature

string

header

required

Path Parameters

account_ref

string

required

Merchant-defined virtual account reference

Body

application/json

Automation request

action

object

required

Action to run when the schedule or condition triggers.

Show child attributes

schedule

object

required

Schedule that controls when the automation evaluates.

Show child attributes

Response

data

object

Response payload when the request succeeded.

Show child attributes

error

boolean

True when the request failed.

message

string

Human-readable status or error message.

Basics

Paylinks

Plans

Subscriptions

Customers

Invoices

Payments

Events

Organisation

Secrets

Accounts

Bank Address Book

Virtual Accounts

Partners

Partner Automations

Partner Balance Monitoring

Instruments

Quotes

Orders

Trades

Create Automation

Authorizations

Path Parameters

Body

Response