Create Pay-In Deposit Wallet

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/address \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "chain_id": 8453,
  "currency": "USDC",
  "deposit_splits": [
    {
      "account_id": 123,
      "account_ref": "<string>",
      "address": "<string>",
      "pct": "<string>"
    }
  ],
  "reference": "customer-123"
}
'

import requests

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

payload = {
    "chain_id": 8453,
    "currency": "USDC",
    "deposit_splits": [
        {
            "account_id": 123,
            "account_ref": "<string>",
            "address": "<string>",
            "pct": "<string>"
        }
    ],
    "reference": "customer-123"
}
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({
    chain_id: 8453,
    currency: 'USDC',
    deposit_splits: [
      {account_id: 123, account_ref: '<string>', address: '<string>', pct: '<string>'}
    ],
    reference: 'customer-123'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/address', 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/address",
  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([
    'chain_id' => 8453,
    'currency' => 'USDC',
    'deposit_splits' => [
        [
                'account_id' => 123,
                'account_ref' => '<string>',
                'address' => '<string>',
                'pct' => '<string>'
        ]
    ],
    'reference' => 'customer-123'
  ]),
  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}/payin/address"

	payload := strings.NewReader("{\n  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\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}/payin/address")
  .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  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\n}"

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

{
  "data": {
    "account_id": 123,
    "address": "<string>",
    "chain_id": 123,
    "currency": "<string>",
    "enabled": true,
    "reference": "<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"
  }
}

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

POST

partners

accounts

{account_ref}

payin

address

Create Pay-In Deposit Wallet

curl --request POST \
  --url https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/address \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-Nonce: <api-key>' \
  --header 'X-API-Signature: <api-key>' \
  --data '
{
  "chain_id": 8453,
  "currency": "USDC",
  "deposit_splits": [
    {
      "account_id": 123,
      "account_ref": "<string>",
      "address": "<string>",
      "pct": "<string>"
    }
  ],
  "reference": "customer-123"
}
'

import requests

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

payload = {
    "chain_id": 8453,
    "currency": "USDC",
    "deposit_splits": [
        {
            "account_id": 123,
            "account_ref": "<string>",
            "address": "<string>",
            "pct": "<string>"
        }
    ],
    "reference": "customer-123"
}
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({
    chain_id: 8453,
    currency: 'USDC',
    deposit_splits: [
      {account_id: 123, account_ref: '<string>', address: '<string>', pct: '<string>'}
    ],
    reference: 'customer-123'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/partners/accounts/{account_ref}/payin/address', 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/address",
  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([
    'chain_id' => 8453,
    'currency' => 'USDC',
    'deposit_splits' => [
        [
                'account_id' => 123,
                'account_ref' => '<string>',
                'address' => '<string>',
                'pct' => '<string>'
        ]
    ],
    'reference' => 'customer-123'
  ]),
  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}/payin/address"

	payload := strings.NewReader("{\n  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\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}/payin/address")
  .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  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"chain_id\": 8453,\n  \"currency\": \"USDC\",\n  \"deposit_splits\": [\n    {\n      \"account_id\": 123,\n      \"account_ref\": \"<string>\",\n      \"address\": \"<string>\",\n      \"pct\": \"<string>\"\n    }\n  ],\n  \"reference\": \"customer-123\"\n}"

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

{
  "data": {
    "account_id": 123,
    "address": "<string>",
    "chain_id": 123,
    "currency": "<string>",
    "enabled": true,
    "reference": "<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"
  }
}

{
  "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

Deposit address request (reference, chain_id, optional currency, optional deposit_splits)

chain_id

integer

Chain ID for the deposit wallet.

Example:

8453

currency

string

Optional currency symbol for the deposit wallet.

Example:

"USDC"

deposit_splits

object[]

Optional deposit split configuration for this pay-in wallet.

Show child attributes

reference

string

Customer or external reference used to identify the pay-in sub-account.

Example:

"customer-123"

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 Pay-In Deposit Wallet

Authorizations

Path Parameters

Body

Response