Update Virtual Account

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "chains": [
    {
      "chain_id": 123,
      "currencies": [
        "<string>"
      ],
      "wallet_address": "<string>"
    }
  ],
  "deposit_splits": [
    {
      "account_id": 123,
      "account_ref": "<string>",
      "pct": "<string>"
    }
  ],
  "disable_chains": [
    123
  ],
  "reference": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account"

payload = {
    "chains": [
        {
            "chain_id": 123,
            "currencies": ["<string>"],
            "wallet_address": "<string>"
        }
    ],
    "deposit_splits": [
        {
            "account_id": 123,
            "account_ref": "<string>",
            "pct": "<string>"
        }
    ],
    "disable_chains": [123],
    "reference": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-API-Nonce": "<api-key>",
    "X-API-Signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-API-Nonce': '<api-key>',
    'X-API-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    chains: [{chain_id: 123, currencies: ['<string>'], wallet_address: '<string>'}],
    deposit_splits: [{account_id: 123, account_ref: '<string>', pct: '<string>'}],
    disable_chains: [123],
    reference: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account', 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/update-virtual-account",
  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([
    'chains' => [
        [
                'chain_id' => 123,
                'currencies' => [
                                '<string>'
                ],
                'wallet_address' => '<string>'
        ]
    ],
    'deposit_splits' => [
        [
                'account_id' => 123,
                'account_ref' => '<string>',
                'pct' => '<string>'
        ]
    ],
    'disable_chains' => [
        123
    ],
    'reference' => '<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/update-virtual-account"

	payload := strings.NewReader("{\n  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account")
  .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  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account")

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

request = Net::HTTP::Patch.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  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}"

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

{
  "data": {
    "account_number": "<string>",
    "address": "<string>",
    "chain": {
      "id": 123,
      "name": "<string>",
      "native_currency_symbol": "<string>"
    },
    "chain_id": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "currencies": [
      "<string>"
    ],
    "deleted_at": "<string>",
    "deposit_splits": [
      {
        "account_id": 123,
        "account_ref": "<string>",
        "address": "<string>",
        "pct": "<string>"
      }
    ],
    "enabled": true,
    "id": 123,
    "name": "<string>",
    "org_id": "<string>",
    "parent_id": 123,
    "properties": [
      123
    ],
    "provider": "<string>",
    "reference": "<string>",
    "sort_code": "<string>",
    "sub_accounts": "<array>",
    "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"
  }
}

PATCH

partners

accounts

update-virtual-account

Update Virtual Account

curl --request PATCH \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "chains": [
    {
      "chain_id": 123,
      "currencies": [
        "<string>"
      ],
      "wallet_address": "<string>"
    }
  ],
  "deposit_splits": [
    {
      "account_id": 123,
      "account_ref": "<string>",
      "pct": "<string>"
    }
  ],
  "disable_chains": [
    123
  ],
  "reference": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account"

payload = {
    "chains": [
        {
            "chain_id": 123,
            "currencies": ["<string>"],
            "wallet_address": "<string>"
        }
    ],
    "deposit_splits": [
        {
            "account_id": 123,
            "account_ref": "<string>",
            "pct": "<string>"
        }
    ],
    "disable_chains": [123],
    "reference": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-API-Nonce": "<api-key>",
    "X-API-Signature": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-API-Nonce': '<api-key>',
    'X-API-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    chains: [{chain_id: 123, currencies: ['<string>'], wallet_address: '<string>'}],
    deposit_splits: [{account_id: 123, account_ref: '<string>', pct: '<string>'}],
    disable_chains: [123],
    reference: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account', 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/update-virtual-account",
  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([
    'chains' => [
        [
                'chain_id' => 123,
                'currencies' => [
                                '<string>'
                ],
                'wallet_address' => '<string>'
        ]
    ],
    'deposit_splits' => [
        [
                'account_id' => 123,
                'account_ref' => '<string>',
                'pct' => '<string>'
        ]
    ],
    'disable_chains' => [
        123
    ],
    'reference' => '<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/update-virtual-account"

	payload := strings.NewReader("{\n  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account")
  .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  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/partners/accounts/update-virtual-account")

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

request = Net::HTTP::Patch.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  \"chains\": [\n    {\n      \"chain_id\": 123,\n      \"currencies\": [\n        \"<string>\"\n      ],\n      \"wallet_address\": \"<string>\"\n    }\n  ],\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"disable_chains\": [\n    123\n  ],\n  \"reference\": \"<string>\"\n}"

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

{
  "data": {
    "account_number": "<string>",
    "address": "<string>",
    "chain": {
      "id": 123,
      "name": "<string>",
      "native_currency_symbol": "<string>"
    },
    "chain_id": 123,
    "created_at": "<string>",
    "created_by": "<string>",
    "currencies": [
      "<string>"
    ],
    "deleted_at": "<string>",
    "deposit_splits": [
      {
        "account_id": 123,
        "account_ref": "<string>",
        "address": "<string>",
        "pct": "<string>"
      }
    ],
    "enabled": true,
    "id": 123,
    "name": "<string>",
    "org_id": "<string>",
    "parent_id": 123,
    "properties": [
      123
    ],
    "provider": "<string>",
    "reference": "<string>",
    "sort_code": "<string>",
    "sub_accounts": "<array>",
    "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

Body

application/json

Request

chains

object[]

Add/enable chains and update currencies

Show child attributes

deposit_splits

object[]

nil=no change, []=clear, [...]= replace

Show child attributes

disable_chains

integer[]

Disable CryptoPayIn chains

reference

string

Reference of the virtual account to update

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

Update Virtual Account

Authorizations

Body

Response