List Deposit Account Balances

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/{dep_account_ref}/balances \
  --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}/payin/{dep_account_ref}/balances"

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}/payin/{dep_account_ref}/balances', 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}/payin/{dep_account_ref}/balances",
  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}/payin/{dep_account_ref}/balances"

	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}/payin/{dep_account_ref}/balances")
  .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}/payin/{dep_account_ref}/balances")

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": [
    {
      "balances": {},
      "chain_id": 123,
      "chain_name": "<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"
  }
}

GET

partners

accounts

{account_ref}

payin

{dep_account_ref}

balances

List Deposit Account Balances

curl --request GET \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/{dep_account_ref}/balances \
  --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}/payin/{dep_account_ref}/balances"

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}/payin/{dep_account_ref}/balances', 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}/payin/{dep_account_ref}/balances",
  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}/payin/{dep_account_ref}/balances"

	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}/payin/{dep_account_ref}/balances")
  .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}/payin/{dep_account_ref}/balances")

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": [
    {
      "balances": {},
      "chain_id": 123,
      "chain_name": "<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

dep_account_ref

string

required

Pay-in deposit wallet reference under the virtual account

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

List Deposit Account Balances

Authorizations

Path Parameters

Response