Get Automation
curl --request GET \
--url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId} \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-Nonce: <api-key>' \
--header 'X-API-Signature: <api-key>'import requests
url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}"
headers = {
"X-API-KEY": "<api-key>",
"X-API-Nonce": "<api-key>",
"X-API-Signature": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-API-KEY': '<api-key>',
'X-API-Nonce': '<api-key>',
'X-API-Signature': '<api-key>'
}
};
fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}', 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/{automationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-API-Nonce", "<api-key>")
req.Header.Add("X-API-Signature", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}")
.header("X-API-KEY", "<api-key>")
.header("X-API-Nonce", "<api-key>")
.header("X-API-Signature", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
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"
}
}Partner Automations
Get Automation
Get a single automation by ID for a virtual account identified by reference
GET
/
partners
/
accounts
/
{account_ref}
/
automations
/
{automationId}
Get Automation
curl --request GET \
--url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId} \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-Nonce: <api-key>' \
--header 'X-API-Signature: <api-key>'import requests
url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}"
headers = {
"X-API-KEY": "<api-key>",
"X-API-Nonce": "<api-key>",
"X-API-Signature": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-API-KEY': '<api-key>',
'X-API-Nonce': '<api-key>',
'X-API-Signature': '<api-key>'
}
};
fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}', 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/{automationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-API-Nonce", "<api-key>")
req.Header.Add("X-API-Signature", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}")
.header("X-API-KEY", "<api-key>")
.header("X-API-Nonce", "<api-key>")
.header("X-API-Signature", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/automations/{automationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
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
Path Parameters
Merchant-defined virtual account reference
Unique automation identifier under the managed virtual account
⌘I