Update Organisation

curl --request PUT \
  --url https://mapi.zbx.boomfi.xyz/v1/orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email_notification_option": "<string>",
  "fee_payer": "<string>",
  "forwarded_email_recipients": [
    "<string>"
  ],
  "logo_url": "<string>",
  "name": "<string>",
  "underpay_tolerance_amount": 123,
  "underpay_tolerance_percent": 123,
  "webhook_url": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/orgs"

payload = {
    "email_notification_option": "<string>",
    "fee_payer": "<string>",
    "forwarded_email_recipients": ["<string>"],
    "logo_url": "<string>",
    "name": "<string>",
    "underpay_tolerance_amount": 123,
    "underpay_tolerance_percent": 123,
    "webhook_url": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email_notification_option: '<string>',
    fee_payer: '<string>',
    forwarded_email_recipients: ['<string>'],
    logo_url: '<string>',
    name: '<string>',
    underpay_tolerance_amount: 123,
    underpay_tolerance_percent: 123,
    webhook_url: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/orgs', 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/orgs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'email_notification_option' => '<string>',
    'fee_payer' => '<string>',
    'forwarded_email_recipients' => [
        '<string>'
    ],
    'logo_url' => '<string>',
    'name' => '<string>',
    'underpay_tolerance_amount' => 123,
    'underpay_tolerance_percent' => 123,
    'webhook_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <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/orgs"

	payload := strings.NewReader("{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}")

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

	req.Header.Add("X-API-KEY", "<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.put("https://mapi.zbx.boomfi.xyz/v1/orgs")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/orgs")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}"

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

{
  "data": {
    "created_at": "<string>",
    "id": "<string>",
    "logo_url": "<string>",
    "name": "<string>",
    "owner_user_id": "<string>",
    "partner_id": "<string>",
    "updated_at": "<string>",
    "webhook_url": "<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"
  }
}

PUT

orgs

Update Organisation

curl --request PUT \
  --url https://mapi.zbx.boomfi.xyz/v1/orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email_notification_option": "<string>",
  "fee_payer": "<string>",
  "forwarded_email_recipients": [
    "<string>"
  ],
  "logo_url": "<string>",
  "name": "<string>",
  "underpay_tolerance_amount": 123,
  "underpay_tolerance_percent": 123,
  "webhook_url": "<string>"
}
'

import requests

url = "https://mapi.zbx.boomfi.xyz/v1/orgs"

payload = {
    "email_notification_option": "<string>",
    "fee_payer": "<string>",
    "forwarded_email_recipients": ["<string>"],
    "logo_url": "<string>",
    "name": "<string>",
    "underpay_tolerance_amount": 123,
    "underpay_tolerance_percent": 123,
    "webhook_url": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email_notification_option: '<string>',
    fee_payer: '<string>',
    forwarded_email_recipients: ['<string>'],
    logo_url: '<string>',
    name: '<string>',
    underpay_tolerance_amount: 123,
    underpay_tolerance_percent: 123,
    webhook_url: '<string>'
  })
};

fetch('https://mapi.zbx.boomfi.xyz/v1/orgs', 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/orgs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'email_notification_option' => '<string>',
    'fee_payer' => '<string>',
    'forwarded_email_recipients' => [
        '<string>'
    ],
    'logo_url' => '<string>',
    'name' => '<string>',
    'underpay_tolerance_amount' => 123,
    'underpay_tolerance_percent' => 123,
    'webhook_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <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/orgs"

	payload := strings.NewReader("{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}")

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

	req.Header.Add("X-API-KEY", "<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.put("https://mapi.zbx.boomfi.xyz/v1/orgs")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mapi.zbx.boomfi.xyz/v1/orgs")

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_notification_option\": \"<string>\",\n  \"fee_payer\": \"<string>\",\n  \"forwarded_email_recipients\": [\n    \"<string>\"\n  ],\n  \"logo_url\": \"<string>\",\n  \"name\": \"<string>\",\n  \"underpay_tolerance_amount\": 123,\n  \"underpay_tolerance_percent\": 123,\n  \"webhook_url\": \"<string>\"\n}"

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

{
  "data": {
    "created_at": "<string>",
    "id": "<string>",
    "logo_url": "<string>",
    "name": "<string>",
    "owner_user_id": "<string>",
    "partner_id": "<string>",
    "updated_at": "<string>",
    "webhook_url": "<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

Body

application/json

Update organisation request

email_notification_option

string

Email notification preference for the organisation.

fee_payer

string

Who pays network or platform fees (merchant or customer).

forwarded_email_recipients

string[]

Additional email addresses that receive forwarded notifications.

logo_url

string

URL of the organisation logo (when brand allows logo updates).

name

string

Organisation display name (when brand allows name updates).

underpay_tolerance_amount

number

Absolute underpayment tolerance amount accepted for payments.

underpay_tolerance_percent

number

Underpayment tolerance as a percentage of the amount due.

webhook_url

string

HTTPS URL that receives webhook events.

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 Organisation

Authorizations

Body

Response