business.services.rehive.io
Open in
urlscan Pro
2606:4700:10::ac43:2857
Public Scan
URL:
https://business.services.rehive.io/
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* activate
* postActivate service
* admin
* getList categories
* postCreate category
* getRetrieve category
* putUpdate category
* patchPartially update category
* delDelete category
* getList business users
* postCreate business user
* getRetrieve business user
* putUpdate business user
* patchPartially update business user
* getList businesses
* getRetrieve business
* putUpdate business
* patchPartially update business
* getRetrieve business category
* delDelete business category
* getList business documents
* postCreate business document
* getRetrieve business document
* putUpdate business document
* patchPartially update business document
* delDelete business document
* getList business payouts
* postCreate business payout
* getRetrieve business payout
* getList business payout transactions
* getList business categories
* postCreate business category
* getRetrieve company
* putUpdate company
* patchPartially update company
* getList currencies
* getRetrieve currency
* postReceive Platform webhook
* customer
* getList businesses
* getRetrieve business
* postEnroll customer
* deactivate
* postDeactivate service
* manager
* getList categories
* getRetrieve business category
* getList businesses
* postCreate business
* getRetrieve business
* putUpdate business
* patchPartially update business
* getRetrieve business category
* delDelete business category
* getList business documents
* postCreate business document
* getRetrieve business document
* getList business invoices
* postCreate business invoice
* getRetrieve business invoice
* putUpdate business invoice
* patchPartially update business invoice
* getList business invoice logs
* getList business invoice refunds
* postCreate business invoice refund
* getList business invoice transactions
* getList business metrics
* getRetrieve business metric
* getList business metric points
* getList business payouts
* postCreate business payout
* getRetrieve business payout
* getList business payout transactions
* getList business transactions
* getRetrieve business transaction
* getList business users
* postCreate business user
* getRetrieve business user
* putUpdate business user
* patchPartially update business user
* getList business categories
* postCreate business category
* getRetrieve company
* user
* getList categories
* getRetrieve category
* getList businesses
* getRetrieve business
* getRetrieve company
* webhook
* postReceive Platform webhook
API docs by Redocly
BUSINESS SERVICE API (1 (1))
Download OpenAPI specification:Download
Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service
The Business Service API is used for managing businesses in Rehive.
Docs portal
ACTIVATE
ACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
RESPONSES
200
post/activate/
https://business.services.rehive.com/api/activate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
ADMIN
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/business-categories/
https://business.services.rehive.com/api/admin/business-categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
CREATE CATEGORY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
parent
string <uuid>
image
string <uri>
description
string or null <= 255 characters
RESPONSES
201
post/admin/business-categories/
https://business.services.rehive.com/api/admin/business-categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "description": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
RETRIEVE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/business-categories/{identifier}/
https://business.services.rehive.com/api/admin/business-categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
UPDATE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string <= 50 characters
parent
string <uuid>
image
string <uri>
description
string or null <= 255 characters
RESPONSES
200
put/admin/business-categories/{identifier}/
https://business.services.rehive.com/api/admin/business-categories/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
PARTIALLY UPDATE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string <= 50 characters
parent
string <uuid>
image
string <uri>
description
string or null <= 255 characters
RESPONSES
200
patch/admin/business-categories/{identifier}/
https://business.services.rehive.com/api/admin/business-categories/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "description": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
DELETE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/business-categories/{identifier}/
https://business.services.rehive.com/api/admin/business-categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
LIST BUSINESS USERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
business
string
email
string
mobile
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
roles
string
user
string
RESPONSES
200
get/admin/business-users/
https://business.services.rehive.com/api/admin/business-users/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "business": {
* "id": "string",
* "name": "string",
* "created": 0,
* "updated": 0
},
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
business
required
string
roles
required
Array of strings
Items Enum: "manager" "customer"
user
string
email
string or null <email> <= 254 characters
mobile
string or null <= 24 characters
RESPONSES
201
post/admin/business-users/
https://business.services.rehive.com/api/admin/business-users/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "business": "string",
* "user": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "business": {
* "id": "string",
* "name": "string",
* "created": 0,
* "updated": 0
},
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
user_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/business-users/{user_id}/
https://business.services.rehive.com/api/admin/business-users/{user_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "business": {
* "id": "string",
* "name": "string",
* "created": 0,
* "updated": 0
},
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
user_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
business
required
string
roles
required
Array of strings [ 0 .. 2 ] items
Items Enum: "manager" "customer"
RESPONSES
200
put/admin/business-users/{user_id}/
https://business.services.rehive.com/api/admin/business-users/{user_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "business": "string",
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "business": {
* "id": "string",
* "name": "string",
* "created": 0,
* "updated": 0
},
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
user_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
business
string
roles
Array of strings [ 0 .. 2 ] items
Items Enum: "manager" "customer"
RESPONSES
200
patch/admin/business-users/{user_id}/
https://business.services.rehive.com/api/admin/business-users/{user_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "business": "string",
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "business": {
* "id": "string",
* "name": "string",
* "created": 0,
* "updated": 0
},
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
LIST BUSINESSES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
identifier
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
RESPONSES
200
get/admin/businesses/
https://business.services.rehive.com/api/admin/businesses/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
RESPONSES
200
get/admin/businesses/{business_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
website
string or null <= 100 characters
inc_number
string or null <= 100 characters
colors
object or null
logo
string or null <uri>
icon
string or null <uri>
vat_number
string or null <= 30 characters
address_line_1
string or null <= 200 characters
address_line_2
string or null <= 200 characters
address_city
string or null <= 100 characters
address_state_province
string or null <= 100 characters
address_country
string or null
Enum: "AF" "EG" "AX" "AL" "DZ" "AS" "VI" "AD" "AO" "AI" "AQ" "AG" "GQ" "AR" "AM"
"AW" "AZ" "ET" "AU" "BS" "BH" "BD" "BB" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "VG" "IO" "BN" "BG" "BF" "BI" "CL" "CN" "MP" "CK" "CR" "CI" "CW"
"DK" "DE" "DM" "DO" "DJ" "EC" "SV" "ER" "EE" "FK" "FO" "FJ" "FI" "FR" "GF" "PF"
"TF" "GA" "GM" "GE" "GH" "GI" "GD" "GR" "GL" "GP" "GU" "GT" "GG" "GN" "GW" "GY"
"HT" "HM" "HN" "HK" "IN" "ID" "IQ" "IR" "IE" "IS" "IM" "IL" "IT" "JM" "JP" "YE"
"JE" "JO" "KY" "KH" "CM" "CA" "CV" "KZ" "QA" "KE" "KG" "KI" "CC" "CO" "KM" "CG"
"CD" "HR" "CU" "KW" "LA" "LS" "LV" "LB" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW"
"MY" "MV" "ML" "MT" "MA" "MH" "MQ" "MR" "MU" "YT" "MK" "MX" "FM" "MD" "MC" "MN"
"ME" "MS" "MZ" "MM" "NA" "NR" "NP" "NC" "NZ" "NI" "NL" "NE" "NG" "NU" "KP" "NF"
"NO" "OM" "AT" "TL" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR"
"RE" "RW" "RO" "RU" "BL" "PM" "SB" "ZM" "WS" "SM" "ST" "SA" "SE" "CH" "SN" "RS"
"SC" "SL" "ZW" "SG" "SX" "SK" "SI" "SO" "ES" "SJ" "LK" "SH" "KN" "LC" "MF" "VC"
"ZA" "SD" "GS" "KR" "SS" "SR" "SZ" "SY" "TJ" "TW" "TZ" "TH" "TG" "TK" "TO" "TT"
"TD" "CZ" "TN" "TR" "TM" "TC" "TV" "UM" "UG" "UA" "HU" "UY" "UZ" "VU" "VA" "VE"
"AE" "US" "GB" "VN" "WF" "CX" "BY" "EH" "CF" "CY" "" null
* AF - Afghanistan
* EG - Ägypten
* AX - Åland-Inseln
* AL - Albanien
* DZ - Algerien
* AS - Amerikanisch-Samoa
* VI - Amerikanische Jungferninseln
* AD - Andorra
* AO - Angola
* AI - Anguilla
* AQ - Antarktis
* AG - Antigua und Barbuda
* GQ - Äquatorialguinea
* AR - Argentinien
* AM - Armenien
* AW - Aruba
* AZ - Aserbaidschan
* ET - Äthiopien
* AU - Australien
* BS - Bahamas
* BH - Bahrain
* BD - Bangladesch
* BB - Barbados
* BE - Belgien
* BZ - Belize
* BJ - Benin
* BM - Bermuda
* BT - Bhutan
* BO - Bolivien
* BQ - Bonaire, Sint Eustatius und Saba
* BA - Bosnien und Herzegowina
* BW - Botswana
* BV - Bouvetinsel
* BR - Brasilien
* VG - Britische Jungferninseln
* IO - Britisches Territorium im Indischen Ozean
* BN - Brunei
* BG - Bulgarien
* BF - Burkina Faso
* BI - Burundi
* CL - Chile
* CN - China
* MP - Commonwealth der Nördlichen Marianen
* CK - Cookinseln
* CR - Costa Rica
* CI - Côte d'Ivoire
* CW - Curaçao
* DK - Dänemark
* DE - Deutschland
* DM - Dominica
* DO - Dominikanische Republik
* DJ - Dschibuti
* EC - Ecuador
* SV - El Salvador
* ER - Eritrea
* EE - Estland
* FK - Falklandinseln (Malwinen)
* FO - Faröerinseln
* FJ - Fidschi
* FI - Finnland
* FR - Frankreich
* GF - Französisch Guinea
* PF - Französisch-Polynesien
* TF - Französische Süd- und Antarktisgebiete
* GA - Gabun
* GM - Gambia
* GE - Georgien
* GH - Ghana
* GI - Gibraltar
* GD - Granada
* GR - Griechenland
* GL - Grönland
* GP - Guadeloupe
* GU - Guam
* GT - Guatemala
* GG - Guernsey
* GN - Guinea
* GW - Guinea-Bissau
* GY - Guyana
* HT - Haiti
* HM - Heard und McDonaldinseln
* HN - Honduras
* HK - Hong Kong
* IN - Indien
* ID - Indonesien
* IQ - Irak
* IR - Iran (Islamische Republik)
* IE - Irland
* IS - Island
* IM - Isle of Man
* IL - Israel
* IT - Italien
* JM - Jamaika
* JP - Japan
* YE - Jemen
* JE - Jersey
* JO - Jordanien
* KY - Kaimaninseln
* KH - Kambodscha
* CM - Kamerun
* CA - Kanada
* CV - Kap Verde
* KZ - Kasachstan
* QA - Katar
* KE - Kenia
* KG - Kirgisistan
* KI - Kirivati
* CC - Kokosinseln (Keelinginseln)
* CO - Kolumbien
* KM - Komoren
* CG - Kongo
* CD - Kongo (Demokratische Republik)
* HR - Kroatien
* CU - Kuba
* KW - Kuwait
* LA - Laos, Demokratische Volksrepublik
* LS - Lesotho
* LV - Lettland
* LB - Libanon
* LR - Liberia
* LY - Libyen
* LI - Liechtenstein
* LT - Litauen
* LU - Luxemburg
* MO - Macao
* MG - Madagaskar
* MW - Malawi
* MY - Malaysia
* MV - Malediven
* ML - Mali
* MT - Malta
* MA - Marokko
* MH - Marshallinseln
* MQ - Martinique
* MR - Mauretanien
* MU - Mauritius
* YT - Mayotte
* MK - Mazedonien
* MX - Mexiko
* FM - Mikronesien (Föderierte Staaten von)
* MD - Moldawien
* MC - Monaco
* MN - Mongolei
* ME - Montenegro
* MS - Montserrat
* MZ - Mozambique
* MM - Myanmar
* NA - Namibia
* NR - Nauru
* NP - Nepal
* NC - Neukaledonien
* NZ - Neuseeland
* NI - Nicaragua
* NL - Niederlande
* NE - Niger
* NG - Nigeria
* NU - Niue
* KP - Nordkorea
* NF - Norfolkinsel
* NO - Norwegen
* OM - Oman
* AT - Österreich
* TL - Osttimor
* PK - Pakistan
* PS - Palästina
* PW - Palau
* PA - Panama
* PG - Papua Neu Guinea
* PY - Paraguay
* PE - Peru
* PH - Philippinen
* PN - Pitcairn
* PL - Polen
* PT - Portugal
* PR - Puerto Rico
* RE - Réunion
* RW - Ruanda
* RO - Rumänien
* RU - Russland
* BL - Saint-Barthélemy
* PM - Saint-Pierre und Miquelon
* SB - Salomonen
* ZM - Sambia
* WS - Samoa
* SM - San Marino
* ST - São Tomé und Príncipe
* SA - Saudi Arabien
* SE - Schweden
* CH - Schweiz
* SN - Senegal
* RS - Serbien
* SC - Seychellen
* SL - Sierra Leone
* ZW - Simbabwe
* SG - Singapur
* SX - Sint Maarten (niederländischer Teil)
* SK - Slowakei
* SI - Slowenien
* SO - Somalia
* ES - Spanien
* SJ - Spitzbergen und Jan Mayen
* LK - Sri Lanka
* SH - St. Helena, Ascension und Tristan da Cunha
* KN - St. Kitts und Nevis
* LC - St. Lucia
* MF - St. Martin (französischer Teil)
* VC - St. Vincent und die Grenadinen
* ZA - Südafrika
* SD - Sudan
* GS - Südgeorgien und die Südlichen Sandwichinseln
* KR - Südkorea
* SS - Südsudan
* SR - Surinam
* SZ - Swasiland
* SY - Syrien
* TJ - Tadschikistan
* TW - Taiwan (Provinz Chinas)
* TZ - Tansania
* TH - Thailand
* TG - Togo
* TK - Tokelau
* TO - Tonga
* TT - Trinidad und Tobago
* TD - Tschad
* CZ - Tschechien
* TN - Tunesien
* TR - Türkei
* TM - Turkmenistan
* TC - Turks- und Caicosinseln
* TV - Tuvalu
* UM - USA - Sonstige Kleine Inseln
* UG - Uganda
* UA - Ukraine
* HU - Ungarn
* UY - Uruguay
* UZ - Usbekistan
* VU - Vanuatu
* VA - Vatikanstadt
* VE - Venezuela (Bolivarische Republik)
* AE - Vereinigte Arabische Emirate
* US - Vereinigte Staaten von Amerika
* GB - Vereinigtes Königreich
* VN - Vietnam
* WF - Wallis und Futuna
* CX - Weihnachtsinsel
* BY - Weißrussland
* EH - Westsahara
* CF - Zentralafrikanische Republik
* CY - Zypern
address_postal_code
string or null <= 10 characters
status
string
Enum: "declined" "pending" "verified"
* declined - Declined
* pending - Pending
* verified - Verified
metadata
object or null
RESPONSES
200
put/admin/businesses/{business_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "logo": "http://example.com",
* "icon": "http://example.com",
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
website
string or null <= 100 characters
inc_number
string or null <= 100 characters
colors
object or null
logo
string or null <uri>
icon
string or null <uri>
vat_number
string or null <= 30 characters
address_line_1
string or null <= 200 characters
address_line_2
string or null <= 200 characters
address_city
string or null <= 100 characters
address_state_province
string or null <= 100 characters
address_country
string or null
Enum: "AF" "EG" "AX" "AL" "DZ" "AS" "VI" "AD" "AO" "AI" "AQ" "AG" "GQ" "AR" "AM"
"AW" "AZ" "ET" "AU" "BS" "BH" "BD" "BB" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "VG" "IO" "BN" "BG" "BF" "BI" "CL" "CN" "MP" "CK" "CR" "CI" "CW"
"DK" "DE" "DM" "DO" "DJ" "EC" "SV" "ER" "EE" "FK" "FO" "FJ" "FI" "FR" "GF" "PF"
"TF" "GA" "GM" "GE" "GH" "GI" "GD" "GR" "GL" "GP" "GU" "GT" "GG" "GN" "GW" "GY"
"HT" "HM" "HN" "HK" "IN" "ID" "IQ" "IR" "IE" "IS" "IM" "IL" "IT" "JM" "JP" "YE"
"JE" "JO" "KY" "KH" "CM" "CA" "CV" "KZ" "QA" "KE" "KG" "KI" "CC" "CO" "KM" "CG"
"CD" "HR" "CU" "KW" "LA" "LS" "LV" "LB" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW"
"MY" "MV" "ML" "MT" "MA" "MH" "MQ" "MR" "MU" "YT" "MK" "MX" "FM" "MD" "MC" "MN"
"ME" "MS" "MZ" "MM" "NA" "NR" "NP" "NC" "NZ" "NI" "NL" "NE" "NG" "NU" "KP" "NF"
"NO" "OM" "AT" "TL" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR"
"RE" "RW" "RO" "RU" "BL" "PM" "SB" "ZM" "WS" "SM" "ST" "SA" "SE" "CH" "SN" "RS"
"SC" "SL" "ZW" "SG" "SX" "SK" "SI" "SO" "ES" "SJ" "LK" "SH" "KN" "LC" "MF" "VC"
"ZA" "SD" "GS" "KR" "SS" "SR" "SZ" "SY" "TJ" "TW" "TZ" "TH" "TG" "TK" "TO" "TT"
"TD" "CZ" "TN" "TR" "TM" "TC" "TV" "UM" "UG" "UA" "HU" "UY" "UZ" "VU" "VA" "VE"
"AE" "US" "GB" "VN" "WF" "CX" "BY" "EH" "CF" "CY" "" null
* AF - Afghanistan
* EG - Ägypten
* AX - Åland-Inseln
* AL - Albanien
* DZ - Algerien
* AS - Amerikanisch-Samoa
* VI - Amerikanische Jungferninseln
* AD - Andorra
* AO - Angola
* AI - Anguilla
* AQ - Antarktis
* AG - Antigua und Barbuda
* GQ - Äquatorialguinea
* AR - Argentinien
* AM - Armenien
* AW - Aruba
* AZ - Aserbaidschan
* ET - Äthiopien
* AU - Australien
* BS - Bahamas
* BH - Bahrain
* BD - Bangladesch
* BB - Barbados
* BE - Belgien
* BZ - Belize
* BJ - Benin
* BM - Bermuda
* BT - Bhutan
* BO - Bolivien
* BQ - Bonaire, Sint Eustatius und Saba
* BA - Bosnien und Herzegowina
* BW - Botswana
* BV - Bouvetinsel
* BR - Brasilien
* VG - Britische Jungferninseln
* IO - Britisches Territorium im Indischen Ozean
* BN - Brunei
* BG - Bulgarien
* BF - Burkina Faso
* BI - Burundi
* CL - Chile
* CN - China
* MP - Commonwealth der Nördlichen Marianen
* CK - Cookinseln
* CR - Costa Rica
* CI - Côte d'Ivoire
* CW - Curaçao
* DK - Dänemark
* DE - Deutschland
* DM - Dominica
* DO - Dominikanische Republik
* DJ - Dschibuti
* EC - Ecuador
* SV - El Salvador
* ER - Eritrea
* EE - Estland
* FK - Falklandinseln (Malwinen)
* FO - Faröerinseln
* FJ - Fidschi
* FI - Finnland
* FR - Frankreich
* GF - Französisch Guinea
* PF - Französisch-Polynesien
* TF - Französische Süd- und Antarktisgebiete
* GA - Gabun
* GM - Gambia
* GE - Georgien
* GH - Ghana
* GI - Gibraltar
* GD - Granada
* GR - Griechenland
* GL - Grönland
* GP - Guadeloupe
* GU - Guam
* GT - Guatemala
* GG - Guernsey
* GN - Guinea
* GW - Guinea-Bissau
* GY - Guyana
* HT - Haiti
* HM - Heard und McDonaldinseln
* HN - Honduras
* HK - Hong Kong
* IN - Indien
* ID - Indonesien
* IQ - Irak
* IR - Iran (Islamische Republik)
* IE - Irland
* IS - Island
* IM - Isle of Man
* IL - Israel
* IT - Italien
* JM - Jamaika
* JP - Japan
* YE - Jemen
* JE - Jersey
* JO - Jordanien
* KY - Kaimaninseln
* KH - Kambodscha
* CM - Kamerun
* CA - Kanada
* CV - Kap Verde
* KZ - Kasachstan
* QA - Katar
* KE - Kenia
* KG - Kirgisistan
* KI - Kirivati
* CC - Kokosinseln (Keelinginseln)
* CO - Kolumbien
* KM - Komoren
* CG - Kongo
* CD - Kongo (Demokratische Republik)
* HR - Kroatien
* CU - Kuba
* KW - Kuwait
* LA - Laos, Demokratische Volksrepublik
* LS - Lesotho
* LV - Lettland
* LB - Libanon
* LR - Liberia
* LY - Libyen
* LI - Liechtenstein
* LT - Litauen
* LU - Luxemburg
* MO - Macao
* MG - Madagaskar
* MW - Malawi
* MY - Malaysia
* MV - Malediven
* ML - Mali
* MT - Malta
* MA - Marokko
* MH - Marshallinseln
* MQ - Martinique
* MR - Mauretanien
* MU - Mauritius
* YT - Mayotte
* MK - Mazedonien
* MX - Mexiko
* FM - Mikronesien (Föderierte Staaten von)
* MD - Moldawien
* MC - Monaco
* MN - Mongolei
* ME - Montenegro
* MS - Montserrat
* MZ - Mozambique
* MM - Myanmar
* NA - Namibia
* NR - Nauru
* NP - Nepal
* NC - Neukaledonien
* NZ - Neuseeland
* NI - Nicaragua
* NL - Niederlande
* NE - Niger
* NG - Nigeria
* NU - Niue
* KP - Nordkorea
* NF - Norfolkinsel
* NO - Norwegen
* OM - Oman
* AT - Österreich
* TL - Osttimor
* PK - Pakistan
* PS - Palästina
* PW - Palau
* PA - Panama
* PG - Papua Neu Guinea
* PY - Paraguay
* PE - Peru
* PH - Philippinen
* PN - Pitcairn
* PL - Polen
* PT - Portugal
* PR - Puerto Rico
* RE - Réunion
* RW - Ruanda
* RO - Rumänien
* RU - Russland
* BL - Saint-Barthélemy
* PM - Saint-Pierre und Miquelon
* SB - Salomonen
* ZM - Sambia
* WS - Samoa
* SM - San Marino
* ST - São Tomé und Príncipe
* SA - Saudi Arabien
* SE - Schweden
* CH - Schweiz
* SN - Senegal
* RS - Serbien
* SC - Seychellen
* SL - Sierra Leone
* ZW - Simbabwe
* SG - Singapur
* SX - Sint Maarten (niederländischer Teil)
* SK - Slowakei
* SI - Slowenien
* SO - Somalia
* ES - Spanien
* SJ - Spitzbergen und Jan Mayen
* LK - Sri Lanka
* SH - St. Helena, Ascension und Tristan da Cunha
* KN - St. Kitts und Nevis
* LC - St. Lucia
* MF - St. Martin (französischer Teil)
* VC - St. Vincent und die Grenadinen
* ZA - Südafrika
* SD - Sudan
* GS - Südgeorgien und die Südlichen Sandwichinseln
* KR - Südkorea
* SS - Südsudan
* SR - Surinam
* SZ - Swasiland
* SY - Syrien
* TJ - Tadschikistan
* TW - Taiwan (Provinz Chinas)
* TZ - Tansania
* TH - Thailand
* TG - Togo
* TK - Tokelau
* TO - Tonga
* TT - Trinidad und Tobago
* TD - Tschad
* CZ - Tschechien
* TN - Tunesien
* TR - Türkei
* TM - Turkmenistan
* TC - Turks- und Caicosinseln
* TV - Tuvalu
* UM - USA - Sonstige Kleine Inseln
* UG - Uganda
* UA - Ukraine
* HU - Ungarn
* UY - Uruguay
* UZ - Usbekistan
* VU - Vanuatu
* VA - Vatikanstadt
* VE - Venezuela (Bolivarische Republik)
* AE - Vereinigte Arabische Emirate
* US - Vereinigte Staaten von Amerika
* GB - Vereinigtes Königreich
* VN - Vietnam
* WF - Wallis und Futuna
* CX - Weihnachtsinsel
* BY - Weißrussland
* EH - Westsahara
* CF - Zentralafrikanische Republik
* CY - Zypern
address_postal_code
string or null <= 10 characters
status
string
Enum: "declined" "pending" "verified"
* declined - Declined
* pending - Pending
* verified - Verified
metadata
object or null
RESPONSES
200
patch/admin/businesses/{business_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "logo": "http://example.com",
* "icon": "http://example.com",
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^([a-zA-Z0-9\_\-]+)$
category_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/businesses/{business_id}/categories/{category_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
DELETE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^([a-zA-Z0-9\_\-]+)$
category_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/businesses/{business_id}/categories/{category_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
LIST BUSINESS DOCUMENTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/businesses/{business_id}/documents/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
status
required
string
Enum: "obsolete" "declined" "pending" "incomplete" "verified"
* obsolete - obsolete
* declined - declined
* pending - pending
* incomplete - incomplete
* verified - verified
type
required
string
Enum: "incorporation_certificate" "tax_certificate" "financial_statement"
"trade_certificate" "shareholder_identification"
* incorporation_certificate - incorporation_certificate
* tax_certificate - tax_certificate
* financial_statement - financial_statement
* trade_certificate - trade_certificate
* shareholder_identification - shareholder_identification
metadata
object or null
note
string or null <= 250 characters
expires
integer or null
RESPONSES
201
post/admin/businesses/{business_id}/documents/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
document_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/businesses/{business_id}/documents/{document_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/{document_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
document_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "obsolete" "declined" "pending" "incomplete" "verified"
* obsolete - obsolete
* declined - declined
* pending - pending
* incomplete - incomplete
* verified - verified
metadata
object or null
note
string or null <= 250 characters
expires
integer or null
RESPONSES
200
put/admin/businesses/{business_id}/documents/{document_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/{document_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
document_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
string
Enum: "obsolete" "declined" "pending" "incomplete" "verified"
* obsolete - obsolete
* declined - declined
* pending - pending
* incomplete - incomplete
* verified - verified
metadata
object or null
note
string or null <= 250 characters
expires
integer or null
RESPONSES
200
patch/admin/businesses/{business_id}/documents/{document_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/{document_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
DELETE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
document_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/businesses/{business_id}/documents/{document_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/documents/{document_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS PAYOUTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/businesses/{business_id}/payouts/
https://business.services.rehive.com/api/admin/businesses/{business_id}/payouts/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS PAYOUT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
reference
string or null <= 100 characters
destinations
Array of objects (AdminCreateBusinessPayoutDestination)
RESPONSES
201
post/admin/businesses/{business_id}/payouts/
https://business.services.rehive.com/api/admin/businesses/{business_id}/payouts/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "destinations": [
* {
* "currency": "string",
* "type": "native",
* "percentage": 1,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS PAYOUT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
payout_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/businesses/{business_id}/payouts/{payout_id}/
https://business.services.rehive.com/api/admin/businesses/{business_id}/payouts/{payout_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS PAYOUT TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
payout_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/businesses/{business_id}/payouts/{payout_id}/transactions/
https://business.services.rehive.com/api/admin/businesses/{business_id}/payouts/{payout_id}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "collection": "string",
* "parent": "string",
* "partner": {
* "property1": null,
* "property2": null
},
* "tx_type": "string",
* "subtype": "string",
* "note": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "string",
* "reference": "string",
* "amount": 0,
* "total_amount": 0,
* "balance": 0,
* "currency": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
LIST BUSINESS CATEGORIES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/businesses/{identifier}/categories/
https://business.services.rehive.com/api/admin/businesses/{identifier}/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
CREATE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
categories
required
Array of strings <uuid>
RESPONSES
201
post/admin/businesses/{identifier}/categories/
https://business.services.rehive.com/api/admin/businesses/{identifier}/categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "categories": [
* "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/admin/company/
https://business.services.rehive.com/api/admin/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0
}
],
* "payout_exclusion_period": 12,
* "payout_day": 6,
* "payout_hour": 23
}
}
UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
manager_groups
Array of strings or null <= 10 items
payout_minimums
Array of objects (AdminUpdateCompanyPayoutMinimum)
payout_exclusion_period
integer [ 12 .. 168 ]
payout_day
integer [ 0 .. 6 ]
payout_hour
integer [ 0 .. 23 ]
RESPONSES
200
put/admin/company/
https://business.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": "string",
* "amount": 0
}
],
* "payout_exclusion_period": 12,
* "payout_day": 6,
* "payout_hour": 23
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0
}
],
* "payout_exclusion_period": 12,
* "payout_day": 6,
* "payout_hour": 23
}
}
PARTIALLY UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
manager_groups
Array of strings or null <= 10 items
payout_minimums
Array of objects (AdminUpdateCompanyPayoutMinimum)
payout_exclusion_period
integer [ 12 .. 168 ]
payout_day
integer [ 0 .. 6 ]
payout_hour
integer [ 0 .. 23 ]
RESPONSES
200
patch/admin/company/
https://business.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": "string",
* "amount": 0
}
],
* "payout_exclusion_period": 12,
* "payout_day": 6,
* "payout_hour": 23
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0
}
],
* "payout_exclusion_period": 12,
* "payout_day": 6,
* "payout_hour": 23
}
}
LIST CURRENCIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
code
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/currencies/
https://business.services.rehive.com/api/admin/currencies/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
}
RETRIEVE CURRENCY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
code
required
string^(\w+)$
RESPONSES
200
get/admin/currencies/{code}/
https://business.services.rehive.com/api/admin/currencies/{code}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
}
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "transaction.create" "currency.create" "currency.update" "user.update"
* transaction.create - transaction.create
* currency.create - currency.create
* currency.update - currency.update
* user.update - User Update
id
required
string
RESPONSES
200
post/admin/webhook/
https://business.services.rehive.com/api/admin/webhook/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "transaction.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
CUSTOMER
LIST BUSINESSES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/customer/businesses/
https://business.services.rehive.com/api/customer/businesses/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
RESPONSES
200
get/customer/businesses/{business_id}/
https://business.services.rehive.com/api/customer/businesses/{business_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
ENROLL CUSTOMER
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
business
required
string
RESPONSES
201
post/customer/enroll/
https://business.services.rehive.com/api/customer/enroll/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "business": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
DEACTIVATE
DEACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
purge
boolean
Default: false
RESPONSES
200
post/deactivate/
https://business.services.rehive.com/api/deactivate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string",
* "purge": false
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
MANAGER
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/business-categories/
https://business.services.rehive.com/api/manager/business-categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
RETRIEVE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/business-categories/{identifier}/
https://business.services.rehive.com/api/manager/business-categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
LIST BUSINESSES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
identifier
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
RESPONSES
200
get/manager/businesses/
https://business.services.rehive.com/api/manager/businesses/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string
currency
required
string
id
required
string
timezone
required
string
name
string or null <= 200 characters
description
string or null <= 255 characters
website
string or null <= 100 characters
inc_number
string or null <= 100 characters
colors
object or null
logo
string or null <uri>
icon
string or null <uri>
destinations
Array of objects (ManagerCreateUpdateBusinessAutomatedPayoutDestination)
vat_number
string or null <= 30 characters
address_line_1
string or null <= 200 characters
address_line_2
string or null <= 200 characters
address_city
string or null <= 100 characters
address_state_province
string or null <= 100 characters
address_country
string or null
Enum: "AF" "EG" "AX" "AL" "DZ" "AS" "VI" "AD" "AO" "AI" "AQ" "AG" "GQ" "AR" "AM"
"AW" "AZ" "ET" "AU" "BS" "BH" "BD" "BB" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "VG" "IO" "BN" "BG" "BF" "BI" "CL" "CN" "MP" "CK" "CR" "CI" "CW"
"DK" "DE" "DM" "DO" "DJ" "EC" "SV" "ER" "EE" "FK" "FO" "FJ" "FI" "FR" "GF" "PF"
"TF" "GA" "GM" "GE" "GH" "GI" "GD" "GR" "GL" "GP" "GU" "GT" "GG" "GN" "GW" "GY"
"HT" "HM" "HN" "HK" "IN" "ID" "IQ" "IR" "IE" "IS" "IM" "IL" "IT" "JM" "JP" "YE"
"JE" "JO" "KY" "KH" "CM" "CA" "CV" "KZ" "QA" "KE" "KG" "KI" "CC" "CO" "KM" "CG"
"CD" "HR" "CU" "KW" "LA" "LS" "LV" "LB" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW"
"MY" "MV" "ML" "MT" "MA" "MH" "MQ" "MR" "MU" "YT" "MK" "MX" "FM" "MD" "MC" "MN"
"ME" "MS" "MZ" "MM" "NA" "NR" "NP" "NC" "NZ" "NI" "NL" "NE" "NG" "NU" "KP" "NF"
"NO" "OM" "AT" "TL" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR"
"RE" "RW" "RO" "RU" "BL" "PM" "SB" "ZM" "WS" "SM" "ST" "SA" "SE" "CH" "SN" "RS"
"SC" "SL" "ZW" "SG" "SX" "SK" "SI" "SO" "ES" "SJ" "LK" "SH" "KN" "LC" "MF" "VC"
"ZA" "SD" "GS" "KR" "SS" "SR" "SZ" "SY" "TJ" "TW" "TZ" "TH" "TG" "TK" "TO" "TT"
"TD" "CZ" "TN" "TR" "TM" "TC" "TV" "UM" "UG" "UA" "HU" "UY" "UZ" "VU" "VA" "VE"
"AE" "US" "GB" "VN" "WF" "CX" "BY" "EH" "CF" "CY" "" null
* AF - Afghanistan
* EG - Ägypten
* AX - Åland-Inseln
* AL - Albanien
* DZ - Algerien
* AS - Amerikanisch-Samoa
* VI - Amerikanische Jungferninseln
* AD - Andorra
* AO - Angola
* AI - Anguilla
* AQ - Antarktis
* AG - Antigua und Barbuda
* GQ - Äquatorialguinea
* AR - Argentinien
* AM - Armenien
* AW - Aruba
* AZ - Aserbaidschan
* ET - Äthiopien
* AU - Australien
* BS - Bahamas
* BH - Bahrain
* BD - Bangladesch
* BB - Barbados
* BE - Belgien
* BZ - Belize
* BJ - Benin
* BM - Bermuda
* BT - Bhutan
* BO - Bolivien
* BQ - Bonaire, Sint Eustatius und Saba
* BA - Bosnien und Herzegowina
* BW - Botswana
* BV - Bouvetinsel
* BR - Brasilien
* VG - Britische Jungferninseln
* IO - Britisches Territorium im Indischen Ozean
* BN - Brunei
* BG - Bulgarien
* BF - Burkina Faso
* BI - Burundi
* CL - Chile
* CN - China
* MP - Commonwealth der Nördlichen Marianen
* CK - Cookinseln
* CR - Costa Rica
* CI - Côte d'Ivoire
* CW - Curaçao
* DK - Dänemark
* DE - Deutschland
* DM - Dominica
* DO - Dominikanische Republik
* DJ - Dschibuti
* EC - Ecuador
* SV - El Salvador
* ER - Eritrea
* EE - Estland
* FK - Falklandinseln (Malwinen)
* FO - Faröerinseln
* FJ - Fidschi
* FI - Finnland
* FR - Frankreich
* GF - Französisch Guinea
* PF - Französisch-Polynesien
* TF - Französische Süd- und Antarktisgebiete
* GA - Gabun
* GM - Gambia
* GE - Georgien
* GH - Ghana
* GI - Gibraltar
* GD - Granada
* GR - Griechenland
* GL - Grönland
* GP - Guadeloupe
* GU - Guam
* GT - Guatemala
* GG - Guernsey
* GN - Guinea
* GW - Guinea-Bissau
* GY - Guyana
* HT - Haiti
* HM - Heard und McDonaldinseln
* HN - Honduras
* HK - Hong Kong
* IN - Indien
* ID - Indonesien
* IQ - Irak
* IR - Iran (Islamische Republik)
* IE - Irland
* IS - Island
* IM - Isle of Man
* IL - Israel
* IT - Italien
* JM - Jamaika
* JP - Japan
* YE - Jemen
* JE - Jersey
* JO - Jordanien
* KY - Kaimaninseln
* KH - Kambodscha
* CM - Kamerun
* CA - Kanada
* CV - Kap Verde
* KZ - Kasachstan
* QA - Katar
* KE - Kenia
* KG - Kirgisistan
* KI - Kirivati
* CC - Kokosinseln (Keelinginseln)
* CO - Kolumbien
* KM - Komoren
* CG - Kongo
* CD - Kongo (Demokratische Republik)
* HR - Kroatien
* CU - Kuba
* KW - Kuwait
* LA - Laos, Demokratische Volksrepublik
* LS - Lesotho
* LV - Lettland
* LB - Libanon
* LR - Liberia
* LY - Libyen
* LI - Liechtenstein
* LT - Litauen
* LU - Luxemburg
* MO - Macao
* MG - Madagaskar
* MW - Malawi
* MY - Malaysia
* MV - Malediven
* ML - Mali
* MT - Malta
* MA - Marokko
* MH - Marshallinseln
* MQ - Martinique
* MR - Mauretanien
* MU - Mauritius
* YT - Mayotte
* MK - Mazedonien
* MX - Mexiko
* FM - Mikronesien (Föderierte Staaten von)
* MD - Moldawien
* MC - Monaco
* MN - Mongolei
* ME - Montenegro
* MS - Montserrat
* MZ - Mozambique
* MM - Myanmar
* NA - Namibia
* NR - Nauru
* NP - Nepal
* NC - Neukaledonien
* NZ - Neuseeland
* NI - Nicaragua
* NL - Niederlande
* NE - Niger
* NG - Nigeria
* NU - Niue
* KP - Nordkorea
* NF - Norfolkinsel
* NO - Norwegen
* OM - Oman
* AT - Österreich
* TL - Osttimor
* PK - Pakistan
* PS - Palästina
* PW - Palau
* PA - Panama
* PG - Papua Neu Guinea
* PY - Paraguay
* PE - Peru
* PH - Philippinen
* PN - Pitcairn
* PL - Polen
* PT - Portugal
* PR - Puerto Rico
* RE - Réunion
* RW - Ruanda
* RO - Rumänien
* RU - Russland
* BL - Saint-Barthélemy
* PM - Saint-Pierre und Miquelon
* SB - Salomonen
* ZM - Sambia
* WS - Samoa
* SM - San Marino
* ST - São Tomé und Príncipe
* SA - Saudi Arabien
* SE - Schweden
* CH - Schweiz
* SN - Senegal
* RS - Serbien
* SC - Seychellen
* SL - Sierra Leone
* ZW - Simbabwe
* SG - Singapur
* SX - Sint Maarten (niederländischer Teil)
* SK - Slowakei
* SI - Slowenien
* SO - Somalia
* ES - Spanien
* SJ - Spitzbergen und Jan Mayen
* LK - Sri Lanka
* SH - St. Helena, Ascension und Tristan da Cunha
* KN - St. Kitts und Nevis
* LC - St. Lucia
* MF - St. Martin (französischer Teil)
* VC - St. Vincent und die Grenadinen
* ZA - Südafrika
* SD - Sudan
* GS - Südgeorgien und die Südlichen Sandwichinseln
* KR - Südkorea
* SS - Südsudan
* SR - Surinam
* SZ - Swasiland
* SY - Syrien
* TJ - Tadschikistan
* TW - Taiwan (Provinz Chinas)
* TZ - Tansania
* TH - Thailand
* TG - Togo
* TK - Tokelau
* TO - Tonga
* TT - Trinidad und Tobago
* TD - Tschad
* CZ - Tschechien
* TN - Tunesien
* TR - Türkei
* TM - Turkmenistan
* TC - Turks- und Caicosinseln
* TV - Tuvalu
* UM - USA - Sonstige Kleine Inseln
* UG - Uganda
* UA - Ukraine
* HU - Ungarn
* UY - Uruguay
* UZ - Usbekistan
* VU - Vanuatu
* VA - Vatikanstadt
* VE - Venezuela (Bolivarische Republik)
* AE - Vereinigte Arabische Emirate
* US - Vereinigte Staaten von Amerika
* GB - Vereinigtes Königreich
* VN - Vietnam
* WF - Wallis und Futuna
* CX - Weihnachtsinsel
* BY - Weißrussland
* EH - Westsahara
* CF - Zentralafrikanische Republik
* CY - Zypern
address_postal_code
string or null <= 10 characters
metadata
object or null
RESPONSES
201
post/manager/businesses/
https://business.services.rehive.com/api/manager/businesses/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": "string",
* "timezone": "string",
* "destinations": [
* {
* "currency": "string",
* "type": "native",
* "percentage": 1,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
RESPONSES
200
get/manager/businesses/{business_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
website
string or null <= 100 characters
inc_number
string or null <= 100 characters
colors
object or null
logo
string or null <uri>
icon
string or null <uri>
destinations
Array of objects (ManagerCreateUpdateBusinessAutomatedPayoutDestination)
vat_number
string or null <= 30 characters
address_line_1
string or null <= 200 characters
address_line_2
string or null <= 200 characters
address_city
string or null <= 100 characters
address_state_province
string or null <= 100 characters
address_country
string or null
Enum: "AF" "EG" "AX" "AL" "DZ" "AS" "VI" "AD" "AO" "AI" "AQ" "AG" "GQ" "AR" "AM"
"AW" "AZ" "ET" "AU" "BS" "BH" "BD" "BB" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "VG" "IO" "BN" "BG" "BF" "BI" "CL" "CN" "MP" "CK" "CR" "CI" "CW"
"DK" "DE" "DM" "DO" "DJ" "EC" "SV" "ER" "EE" "FK" "FO" "FJ" "FI" "FR" "GF" "PF"
"TF" "GA" "GM" "GE" "GH" "GI" "GD" "GR" "GL" "GP" "GU" "GT" "GG" "GN" "GW" "GY"
"HT" "HM" "HN" "HK" "IN" "ID" "IQ" "IR" "IE" "IS" "IM" "IL" "IT" "JM" "JP" "YE"
"JE" "JO" "KY" "KH" "CM" "CA" "CV" "KZ" "QA" "KE" "KG" "KI" "CC" "CO" "KM" "CG"
"CD" "HR" "CU" "KW" "LA" "LS" "LV" "LB" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW"
"MY" "MV" "ML" "MT" "MA" "MH" "MQ" "MR" "MU" "YT" "MK" "MX" "FM" "MD" "MC" "MN"
"ME" "MS" "MZ" "MM" "NA" "NR" "NP" "NC" "NZ" "NI" "NL" "NE" "NG" "NU" "KP" "NF"
"NO" "OM" "AT" "TL" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR"
"RE" "RW" "RO" "RU" "BL" "PM" "SB" "ZM" "WS" "SM" "ST" "SA" "SE" "CH" "SN" "RS"
"SC" "SL" "ZW" "SG" "SX" "SK" "SI" "SO" "ES" "SJ" "LK" "SH" "KN" "LC" "MF" "VC"
"ZA" "SD" "GS" "KR" "SS" "SR" "SZ" "SY" "TJ" "TW" "TZ" "TH" "TG" "TK" "TO" "TT"
"TD" "CZ" "TN" "TR" "TM" "TC" "TV" "UM" "UG" "UA" "HU" "UY" "UZ" "VU" "VA" "VE"
"AE" "US" "GB" "VN" "WF" "CX" "BY" "EH" "CF" "CY" "" null
* AF - Afghanistan
* EG - Ägypten
* AX - Åland-Inseln
* AL - Albanien
* DZ - Algerien
* AS - Amerikanisch-Samoa
* VI - Amerikanische Jungferninseln
* AD - Andorra
* AO - Angola
* AI - Anguilla
* AQ - Antarktis
* AG - Antigua und Barbuda
* GQ - Äquatorialguinea
* AR - Argentinien
* AM - Armenien
* AW - Aruba
* AZ - Aserbaidschan
* ET - Äthiopien
* AU - Australien
* BS - Bahamas
* BH - Bahrain
* BD - Bangladesch
* BB - Barbados
* BE - Belgien
* BZ - Belize
* BJ - Benin
* BM - Bermuda
* BT - Bhutan
* BO - Bolivien
* BQ - Bonaire, Sint Eustatius und Saba
* BA - Bosnien und Herzegowina
* BW - Botswana
* BV - Bouvetinsel
* BR - Brasilien
* VG - Britische Jungferninseln
* IO - Britisches Territorium im Indischen Ozean
* BN - Brunei
* BG - Bulgarien
* BF - Burkina Faso
* BI - Burundi
* CL - Chile
* CN - China
* MP - Commonwealth der Nördlichen Marianen
* CK - Cookinseln
* CR - Costa Rica
* CI - Côte d'Ivoire
* CW - Curaçao
* DK - Dänemark
* DE - Deutschland
* DM - Dominica
* DO - Dominikanische Republik
* DJ - Dschibuti
* EC - Ecuador
* SV - El Salvador
* ER - Eritrea
* EE - Estland
* FK - Falklandinseln (Malwinen)
* FO - Faröerinseln
* FJ - Fidschi
* FI - Finnland
* FR - Frankreich
* GF - Französisch Guinea
* PF - Französisch-Polynesien
* TF - Französische Süd- und Antarktisgebiete
* GA - Gabun
* GM - Gambia
* GE - Georgien
* GH - Ghana
* GI - Gibraltar
* GD - Granada
* GR - Griechenland
* GL - Grönland
* GP - Guadeloupe
* GU - Guam
* GT - Guatemala
* GG - Guernsey
* GN - Guinea
* GW - Guinea-Bissau
* GY - Guyana
* HT - Haiti
* HM - Heard und McDonaldinseln
* HN - Honduras
* HK - Hong Kong
* IN - Indien
* ID - Indonesien
* IQ - Irak
* IR - Iran (Islamische Republik)
* IE - Irland
* IS - Island
* IM - Isle of Man
* IL - Israel
* IT - Italien
* JM - Jamaika
* JP - Japan
* YE - Jemen
* JE - Jersey
* JO - Jordanien
* KY - Kaimaninseln
* KH - Kambodscha
* CM - Kamerun
* CA - Kanada
* CV - Kap Verde
* KZ - Kasachstan
* QA - Katar
* KE - Kenia
* KG - Kirgisistan
* KI - Kirivati
* CC - Kokosinseln (Keelinginseln)
* CO - Kolumbien
* KM - Komoren
* CG - Kongo
* CD - Kongo (Demokratische Republik)
* HR - Kroatien
* CU - Kuba
* KW - Kuwait
* LA - Laos, Demokratische Volksrepublik
* LS - Lesotho
* LV - Lettland
* LB - Libanon
* LR - Liberia
* LY - Libyen
* LI - Liechtenstein
* LT - Litauen
* LU - Luxemburg
* MO - Macao
* MG - Madagaskar
* MW - Malawi
* MY - Malaysia
* MV - Malediven
* ML - Mali
* MT - Malta
* MA - Marokko
* MH - Marshallinseln
* MQ - Martinique
* MR - Mauretanien
* MU - Mauritius
* YT - Mayotte
* MK - Mazedonien
* MX - Mexiko
* FM - Mikronesien (Föderierte Staaten von)
* MD - Moldawien
* MC - Monaco
* MN - Mongolei
* ME - Montenegro
* MS - Montserrat
* MZ - Mozambique
* MM - Myanmar
* NA - Namibia
* NR - Nauru
* NP - Nepal
* NC - Neukaledonien
* NZ - Neuseeland
* NI - Nicaragua
* NL - Niederlande
* NE - Niger
* NG - Nigeria
* NU - Niue
* KP - Nordkorea
* NF - Norfolkinsel
* NO - Norwegen
* OM - Oman
* AT - Österreich
* TL - Osttimor
* PK - Pakistan
* PS - Palästina
* PW - Palau
* PA - Panama
* PG - Papua Neu Guinea
* PY - Paraguay
* PE - Peru
* PH - Philippinen
* PN - Pitcairn
* PL - Polen
* PT - Portugal
* PR - Puerto Rico
* RE - Réunion
* RW - Ruanda
* RO - Rumänien
* RU - Russland
* BL - Saint-Barthélemy
* PM - Saint-Pierre und Miquelon
* SB - Salomonen
* ZM - Sambia
* WS - Samoa
* SM - San Marino
* ST - São Tomé und Príncipe
* SA - Saudi Arabien
* SE - Schweden
* CH - Schweiz
* SN - Senegal
* RS - Serbien
* SC - Seychellen
* SL - Sierra Leone
* ZW - Simbabwe
* SG - Singapur
* SX - Sint Maarten (niederländischer Teil)
* SK - Slowakei
* SI - Slowenien
* SO - Somalia
* ES - Spanien
* SJ - Spitzbergen und Jan Mayen
* LK - Sri Lanka
* SH - St. Helena, Ascension und Tristan da Cunha
* KN - St. Kitts und Nevis
* LC - St. Lucia
* MF - St. Martin (französischer Teil)
* VC - St. Vincent und die Grenadinen
* ZA - Südafrika
* SD - Sudan
* GS - Südgeorgien und die Südlichen Sandwichinseln
* KR - Südkorea
* SS - Südsudan
* SR - Surinam
* SZ - Swasiland
* SY - Syrien
* TJ - Tadschikistan
* TW - Taiwan (Provinz Chinas)
* TZ - Tansania
* TH - Thailand
* TG - Togo
* TK - Tokelau
* TO - Tonga
* TT - Trinidad und Tobago
* TD - Tschad
* CZ - Tschechien
* TN - Tunesien
* TR - Türkei
* TM - Turkmenistan
* TC - Turks- und Caicosinseln
* TV - Tuvalu
* UM - USA - Sonstige Kleine Inseln
* UG - Uganda
* UA - Ukraine
* HU - Ungarn
* UY - Uruguay
* UZ - Usbekistan
* VU - Vanuatu
* VA - Vatikanstadt
* VE - Venezuela (Bolivarische Republik)
* AE - Vereinigte Arabische Emirate
* US - Vereinigte Staaten von Amerika
* GB - Vereinigtes Königreich
* VN - Vietnam
* WF - Wallis und Futuna
* CX - Weihnachtsinsel
* BY - Weißrussland
* EH - Westsahara
* CF - Zentralafrikanische Republik
* CY - Zypern
address_postal_code
string or null <= 10 characters
metadata
object or null
RESPONSES
200
put/manager/businesses/{business_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "logo": "http://example.com",
* "icon": "http://example.com",
* "destinations": [
* {
* "currency": "string",
* "type": "native",
* "percentage": 1,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string or null <= 200 characters
description
string or null <= 255 characters
website
string or null <= 100 characters
inc_number
string or null <= 100 characters
colors
object or null
logo
string or null <uri>
icon
string or null <uri>
destinations
Array of objects (ManagerCreateUpdateBusinessAutomatedPayoutDestination)
vat_number
string or null <= 30 characters
address_line_1
string or null <= 200 characters
address_line_2
string or null <= 200 characters
address_city
string or null <= 100 characters
address_state_province
string or null <= 100 characters
address_country
string or null
Enum: "AF" "EG" "AX" "AL" "DZ" "AS" "VI" "AD" "AO" "AI" "AQ" "AG" "GQ" "AR" "AM"
"AW" "AZ" "ET" "AU" "BS" "BH" "BD" "BB" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA"
"BW" "BV" "BR" "VG" "IO" "BN" "BG" "BF" "BI" "CL" "CN" "MP" "CK" "CR" "CI" "CW"
"DK" "DE" "DM" "DO" "DJ" "EC" "SV" "ER" "EE" "FK" "FO" "FJ" "FI" "FR" "GF" "PF"
"TF" "GA" "GM" "GE" "GH" "GI" "GD" "GR" "GL" "GP" "GU" "GT" "GG" "GN" "GW" "GY"
"HT" "HM" "HN" "HK" "IN" "ID" "IQ" "IR" "IE" "IS" "IM" "IL" "IT" "JM" "JP" "YE"
"JE" "JO" "KY" "KH" "CM" "CA" "CV" "KZ" "QA" "KE" "KG" "KI" "CC" "CO" "KM" "CG"
"CD" "HR" "CU" "KW" "LA" "LS" "LV" "LB" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW"
"MY" "MV" "ML" "MT" "MA" "MH" "MQ" "MR" "MU" "YT" "MK" "MX" "FM" "MD" "MC" "MN"
"ME" "MS" "MZ" "MM" "NA" "NR" "NP" "NC" "NZ" "NI" "NL" "NE" "NG" "NU" "KP" "NF"
"NO" "OM" "AT" "TL" "PK" "PS" "PW" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR"
"RE" "RW" "RO" "RU" "BL" "PM" "SB" "ZM" "WS" "SM" "ST" "SA" "SE" "CH" "SN" "RS"
"SC" "SL" "ZW" "SG" "SX" "SK" "SI" "SO" "ES" "SJ" "LK" "SH" "KN" "LC" "MF" "VC"
"ZA" "SD" "GS" "KR" "SS" "SR" "SZ" "SY" "TJ" "TW" "TZ" "TH" "TG" "TK" "TO" "TT"
"TD" "CZ" "TN" "TR" "TM" "TC" "TV" "UM" "UG" "UA" "HU" "UY" "UZ" "VU" "VA" "VE"
"AE" "US" "GB" "VN" "WF" "CX" "BY" "EH" "CF" "CY" "" null
* AF - Afghanistan
* EG - Ägypten
* AX - Åland-Inseln
* AL - Albanien
* DZ - Algerien
* AS - Amerikanisch-Samoa
* VI - Amerikanische Jungferninseln
* AD - Andorra
* AO - Angola
* AI - Anguilla
* AQ - Antarktis
* AG - Antigua und Barbuda
* GQ - Äquatorialguinea
* AR - Argentinien
* AM - Armenien
* AW - Aruba
* AZ - Aserbaidschan
* ET - Äthiopien
* AU - Australien
* BS - Bahamas
* BH - Bahrain
* BD - Bangladesch
* BB - Barbados
* BE - Belgien
* BZ - Belize
* BJ - Benin
* BM - Bermuda
* BT - Bhutan
* BO - Bolivien
* BQ - Bonaire, Sint Eustatius und Saba
* BA - Bosnien und Herzegowina
* BW - Botswana
* BV - Bouvetinsel
* BR - Brasilien
* VG - Britische Jungferninseln
* IO - Britisches Territorium im Indischen Ozean
* BN - Brunei
* BG - Bulgarien
* BF - Burkina Faso
* BI - Burundi
* CL - Chile
* CN - China
* MP - Commonwealth der Nördlichen Marianen
* CK - Cookinseln
* CR - Costa Rica
* CI - Côte d'Ivoire
* CW - Curaçao
* DK - Dänemark
* DE - Deutschland
* DM - Dominica
* DO - Dominikanische Republik
* DJ - Dschibuti
* EC - Ecuador
* SV - El Salvador
* ER - Eritrea
* EE - Estland
* FK - Falklandinseln (Malwinen)
* FO - Faröerinseln
* FJ - Fidschi
* FI - Finnland
* FR - Frankreich
* GF - Französisch Guinea
* PF - Französisch-Polynesien
* TF - Französische Süd- und Antarktisgebiete
* GA - Gabun
* GM - Gambia
* GE - Georgien
* GH - Ghana
* GI - Gibraltar
* GD - Granada
* GR - Griechenland
* GL - Grönland
* GP - Guadeloupe
* GU - Guam
* GT - Guatemala
* GG - Guernsey
* GN - Guinea
* GW - Guinea-Bissau
* GY - Guyana
* HT - Haiti
* HM - Heard und McDonaldinseln
* HN - Honduras
* HK - Hong Kong
* IN - Indien
* ID - Indonesien
* IQ - Irak
* IR - Iran (Islamische Republik)
* IE - Irland
* IS - Island
* IM - Isle of Man
* IL - Israel
* IT - Italien
* JM - Jamaika
* JP - Japan
* YE - Jemen
* JE - Jersey
* JO - Jordanien
* KY - Kaimaninseln
* KH - Kambodscha
* CM - Kamerun
* CA - Kanada
* CV - Kap Verde
* KZ - Kasachstan
* QA - Katar
* KE - Kenia
* KG - Kirgisistan
* KI - Kirivati
* CC - Kokosinseln (Keelinginseln)
* CO - Kolumbien
* KM - Komoren
* CG - Kongo
* CD - Kongo (Demokratische Republik)
* HR - Kroatien
* CU - Kuba
* KW - Kuwait
* LA - Laos, Demokratische Volksrepublik
* LS - Lesotho
* LV - Lettland
* LB - Libanon
* LR - Liberia
* LY - Libyen
* LI - Liechtenstein
* LT - Litauen
* LU - Luxemburg
* MO - Macao
* MG - Madagaskar
* MW - Malawi
* MY - Malaysia
* MV - Malediven
* ML - Mali
* MT - Malta
* MA - Marokko
* MH - Marshallinseln
* MQ - Martinique
* MR - Mauretanien
* MU - Mauritius
* YT - Mayotte
* MK - Mazedonien
* MX - Mexiko
* FM - Mikronesien (Föderierte Staaten von)
* MD - Moldawien
* MC - Monaco
* MN - Mongolei
* ME - Montenegro
* MS - Montserrat
* MZ - Mozambique
* MM - Myanmar
* NA - Namibia
* NR - Nauru
* NP - Nepal
* NC - Neukaledonien
* NZ - Neuseeland
* NI - Nicaragua
* NL - Niederlande
* NE - Niger
* NG - Nigeria
* NU - Niue
* KP - Nordkorea
* NF - Norfolkinsel
* NO - Norwegen
* OM - Oman
* AT - Österreich
* TL - Osttimor
* PK - Pakistan
* PS - Palästina
* PW - Palau
* PA - Panama
* PG - Papua Neu Guinea
* PY - Paraguay
* PE - Peru
* PH - Philippinen
* PN - Pitcairn
* PL - Polen
* PT - Portugal
* PR - Puerto Rico
* RE - Réunion
* RW - Ruanda
* RO - Rumänien
* RU - Russland
* BL - Saint-Barthélemy
* PM - Saint-Pierre und Miquelon
* SB - Salomonen
* ZM - Sambia
* WS - Samoa
* SM - San Marino
* ST - São Tomé und Príncipe
* SA - Saudi Arabien
* SE - Schweden
* CH - Schweiz
* SN - Senegal
* RS - Serbien
* SC - Seychellen
* SL - Sierra Leone
* ZW - Simbabwe
* SG - Singapur
* SX - Sint Maarten (niederländischer Teil)
* SK - Slowakei
* SI - Slowenien
* SO - Somalia
* ES - Spanien
* SJ - Spitzbergen und Jan Mayen
* LK - Sri Lanka
* SH - St. Helena, Ascension und Tristan da Cunha
* KN - St. Kitts und Nevis
* LC - St. Lucia
* MF - St. Martin (französischer Teil)
* VC - St. Vincent und die Grenadinen
* ZA - Südafrika
* SD - Sudan
* GS - Südgeorgien und die Südlichen Sandwichinseln
* KR - Südkorea
* SS - Südsudan
* SR - Surinam
* SZ - Swasiland
* SY - Syrien
* TJ - Tadschikistan
* TW - Taiwan (Provinz Chinas)
* TZ - Tansania
* TH - Thailand
* TG - Togo
* TK - Tokelau
* TO - Tonga
* TT - Trinidad und Tobago
* TD - Tschad
* CZ - Tschechien
* TN - Tunesien
* TR - Türkei
* TM - Turkmenistan
* TC - Turks- und Caicosinseln
* TV - Tuvalu
* UM - USA - Sonstige Kleine Inseln
* UG - Uganda
* UA - Ukraine
* HU - Ungarn
* UY - Uruguay
* UZ - Usbekistan
* VU - Vanuatu
* VA - Vatikanstadt
* VE - Venezuela (Bolivarische Republik)
* AE - Vereinigte Arabische Emirate
* US - Vereinigte Staaten von Amerika
* GB - Vereinigtes Königreich
* VN - Vietnam
* WF - Wallis und Futuna
* CX - Weihnachtsinsel
* BY - Weißrussland
* EH - Westsahara
* CF - Zentralafrikanische Republik
* CY - Zypern
address_postal_code
string or null <= 10 characters
metadata
object or null
RESPONSES
200
patch/manager/businesses/{business_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "logo": "http://example.com",
* "icon": "http://example.com",
* "destinations": [
* {
* "currency": "string",
* "type": "native",
* "percentage": 1,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "owner": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "account": "string",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "timezone": "string",
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
],
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "status": "declined",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^([a-zA-Z0-9\_\-]+)$
category_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/categories/{category_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
DELETE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^([a-zA-Z0-9\_\-]+)$
category_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/manager/businesses/{business_id}/categories/{category_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/categories/{category_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
LIST BUSINESS DOCUMENTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/documents/
https://business.services.rehive.com/api/manager/businesses/{business_id}/documents/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
file
required
string <uri>
type
required
string
Enum: "incorporation_certificate" "tax_certificate" "financial_statement"
"trade_certificate" "shareholder_identification"
* incorporation_certificate - incorporation_certificate
* tax_certificate - tax_certificate
* financial_statement - financial_statement
* trade_certificate - trade_certificate
* shareholder_identification - shareholder_identification
metadata
object or null
note
string or null <= 250 characters
expires
integer or null
RESPONSES
201
post/manager/businesses/{business_id}/documents/
https://business.services.rehive.com/api/manager/businesses/{business_id}/documents/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS DOCUMENT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
document_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/documents/{document_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/documents/{document_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "file": "http://example.com",
* "type": "incorporation_certificate",
* "status": "obsolete",
* "metadata": {
* "property1": null,
* "property2": null
},
* "note": "string",
* "expires": 0,
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS INVOICES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/invoices/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "user": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "property1": null,
* "property2": null
},
* "description": "string",
* "status": "string",
* "return_url": "string",
* "redirect_url": "string",
* "payer_user": {
* "property1": null,
* "property2": null
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": {
* "property1": null,
* "property2": null
},
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "refunded": true,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS INVOICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
request_amount
required
integer
status
required
string
request_reference
string
description
string
return_url
string
payer_email
string
payer_mobile_number
string
expiration_date
integer
due_date
integer
send_request_on
integer
send_reminders
boolean
metadata
object
RESPONSES
201
post/manager/businesses/{business_id}/invoices/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "request_reference": "string",
* "request_amount": 0,
* "description": "string",
* "status": "string",
* "return_url": "string",
* "payer_email": "string",
* "payer_mobile_number": "string",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "property1": null,
* "property2": null
},
* "description": "string",
* "status": "string",
* "return_url": "string",
* "redirect_url": "string",
* "payer_user": {
* "property1": null,
* "property2": null
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": {
* "property1": null,
* "property2": null
},
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS INVOICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/invoices/{invoice_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "property1": null,
* "property2": null
},
* "description": "string",
* "status": "string",
* "return_url": "string",
* "redirect_url": "string",
* "payer_user": {
* "property1": null,
* "property2": null
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": {
* "property1": null,
* "property2": null
},
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS INVOICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
request_amount
required
integer
status
required
string
request_reference
string
description
string
return_url
string
payer_email
string
payer_mobile_number
string
expiration_date
integer
due_date
integer
send_request_on
integer
send_reminders
boolean
metadata
object
RESPONSES
200
put/manager/businesses/{business_id}/invoices/{invoice_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "request_reference": "string",
* "request_amount": 0,
* "description": "string",
* "status": "string",
* "return_url": "string",
* "payer_email": "string",
* "payer_mobile_number": "string",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "property1": null,
* "property2": null
},
* "description": "string",
* "status": "string",
* "return_url": "string",
* "redirect_url": "string",
* "payer_user": {
* "property1": null,
* "property2": null
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": {
* "property1": null,
* "property2": null
},
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS INVOICE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
request_reference
string
request_amount
integer
description
string
status
string
return_url
string
payer_email
string
payer_mobile_number
string
expiration_date
integer
due_date
integer
send_request_on
integer
send_reminders
boolean
metadata
object
RESPONSES
200
patch/manager/businesses/{business_id}/invoices/{invoice_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "request_reference": "string",
* "request_amount": 0,
* "description": "string",
* "status": "string",
* "return_url": "string",
* "payer_email": "string",
* "payer_mobile_number": "string",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "property1": null,
* "property2": null
},
* "description": "string",
* "status": "string",
* "return_url": "string",
* "redirect_url": "string",
* "payer_user": {
* "property1": null,
* "property2": null
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": {
* "property1": null,
* "property2": null
},
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "send_reminders": true,
* "metadata": {
* "property1": null,
* "property2": null
},
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS INVOICE LOGS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/invoices/{invoice_id}/logs/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/logs/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "user_agent": "string",
* "ip_address": "string",
* "email": "string",
* "mobile_number": "string"
}
]
}
}
LIST BUSINESS INVOICE REFUNDS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/invoices/{invoice_id}/refunds/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "identifier": "string",
* "amount": 0,
* "currency": {
* "property1": null,
* "property2": null
},
* "status": "string",
* "type": "string",
* "transaction_collection": "string",
* "request": "string",
* "reason": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS INVOICE REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
amount
required
integer
currency
required
string
type
required
string
reason
string
RESPONSES
201
post/manager/businesses/{business_id}/invoices/{invoice_id}/refunds/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/refunds/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": 0,
* "currency": "string",
* "type": "string",
* "reason": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "identifier": "string",
* "amount": 0,
* "currency": "string",
* "status": "string",
* "type": "string",
* "transaction_collection": "string",
* "request": "string",
* "reason": "string",
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS INVOICE TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
invoice_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/invoices/{invoice_id}/transactions/
https://business.services.rehive.com/api/manager/businesses/{business_id}/invoices/{invoice_id}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "rehive_code": "string",
* "settled": true,
* "payment_processor_quote": 0,
* "details": {
* "property1": null,
* "property2": null
}
}
]
}
}
LIST BUSINESS METRICS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/metrics/
https://business.services.rehive.com/api/manager/businesses/{business_id}/metrics/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "resource": "string",
* "function": "string",
* "expression": "string",
* "currency": {
* "property1": null,
* "property2": null
},
* "timezone": "string",
* "query": {
* "property1": null,
* "property2": null
},
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE BUSINESS METRIC
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
metric_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/metrics/{metric_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/metrics/{metric_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "resource": "string",
* "function": "string",
* "expression": "string",
* "currency": {
* "property1": null,
* "property2": null
},
* "timezone": "string",
* "query": {
* "property1": null,
* "property2": null
},
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS METRIC POINTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
metric_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/metrics/{metric_id}/points/
https://business.services.rehive.com/api/manager/businesses/{business_id}/metrics/{metric_id}/points/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "value": 0,
* "date": 0
}
]
}
}
LIST BUSINESS PAYOUTS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/payouts/
https://business.services.rehive.com/api/manager/businesses/{business_id}/payouts/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS PAYOUT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
reference
string or null <= 100 characters
destinations
Array of objects (ManagerCreateBusinessPayoutDestination)
RESPONSES
201
post/manager/businesses/{business_id}/payouts/
https://business.services.rehive.com/api/manager/businesses/{business_id}/payouts/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "destinations": [
* {
* "currency": "string",
* "type": "native",
* "percentage": 1,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string"
}
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS PAYOUT
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
payout_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/payouts/{payout_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/payouts/{payout_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "reference": "string",
* "status": "queued",
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0,
* "destinations": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "percentage": 0,
* "account": "string",
* "bitcoin_account": "string",
* "bank_account": "string",
* "allocation": 0,
* "amount": 0,
* "conversion_collection": "string",
* "transfer_collection": "string",
* "withdraw_collection": "string"
}
],
* "errors": [
* "string"
],
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS PAYOUT TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
payout_id
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/payouts/{payout_id}/transactions/
https://business.services.rehive.com/api/manager/businesses/{business_id}/payouts/{payout_id}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "collection": "string",
* "parent": "string",
* "partner": {
* "property1": null,
* "property2": null
},
* "tx_type": "string",
* "subtype": "string",
* "note": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "string",
* "reference": "string",
* "amount": 0,
* "total_amount": 0,
* "balance": 0,
* "currency": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
LIST BUSINESS TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{business_id}/transactions/
https://business.services.rehive.com/api/manager/businesses/{business_id}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "collection": "string",
* "parent": "string",
* "partner": {
* "property1": null,
* "property2": null
},
* "tx_type": "string",
* "subtype": "string",
* "note": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "string",
* "reference": "string",
* "amount": 0,
* "total_amount": 0,
* "balance": 0,
* "currency": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE BUSINESS TRANSACTION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
transaction_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/transactions/{transaction_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/transactions/{transaction_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "collection": "string",
* "parent": "string",
* "partner": {
* "property1": null,
* "property2": null
},
* "tx_type": "string",
* "subtype": "string",
* "note": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "string",
* "reference": "string",
* "amount": 0,
* "total_amount": 0,
* "balance": 0,
* "currency": {
* "property1": null,
* "property2": null
},
* "account": "string",
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS USERS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
QUERY PARAMETERS
email
string
mobile
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
roles
string
user
string
RESPONSES
200
get/manager/businesses/{business_id}/users/
https://business.services.rehive.com/api/manager/businesses/{business_id}/users/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
]
}
}
CREATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
roles
required
Array of strings
Items Enum: "manager" "customer"
user
string
email
string or null <email> <= 254 characters
mobile
string or null <= 24 characters
RESPONSES
201
post/manager/businesses/{business_id}/users/
https://business.services.rehive.com/api/manager/businesses/{business_id}/users/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
RETRIEVE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
user_id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/manager/businesses/{business_id}/users/{user_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/users/{user_id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
UPDATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
user_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
roles
required
Array of strings [ 0 .. 2 ] items
Items Enum: "manager" "customer"
RESPONSES
200
put/manager/businesses/{business_id}/users/{user_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/users/{user_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE BUSINESS USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
business_id
required
string^\w+$
user_id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
roles
Array of strings [ 0 .. 2 ] items
Items Enum: "manager" "customer"
RESPONSES
200
patch/manager/businesses/{business_id}/users/{user_id}/
https://business.services.rehive.com/api/manager/businesses/{business_id}/users/{user_id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "roles": [
* "manager"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "email": "user@example.com",
* "mobile": "string",
* "roles": [
* "manager"
],
* "user": {
* "id": "string",
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string"
},
* "first_name": "string",
* "last_name": "string",
* "username": "string",
* "profile": "string",
* "created": 0,
* "updated": 0
}
}
LIST BUSINESS CATEGORIES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/manager/businesses/{identifier}/categories/
https://business.services.rehive.com/api/manager/businesses/{identifier}/categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
CREATE BUSINESS CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
categories
required
Array of strings <uuid>
RESPONSES
201
post/manager/businesses/{identifier}/categories/
https://business.services.rehive.com/api/manager/businesses/{identifier}/categories/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "categories": [
* "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/manager/company/
https://business.services.rehive.com/api/manager/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
],
* "payout_minimums": [
* {
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "amount": 0
}
],
* "payout_exclusion_period": 0,
* "payout_day": 0,
* "payout_hour": 0
}
}
USER
LIST CATEGORIES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/business-categories/
https://business.services.rehive.com/api/user/business-categories/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
]
}
}
RETRIEVE CATEGORY
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/business-categories/{identifier}/
https://business.services.rehive.com/api/user/business-categories/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
}
LIST BUSINESSES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
categories
string
identifier
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
status
string
RESPONSES
200
get/user/businesses/
https://business.services.rehive.com/api/user/businesses/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "timezone": "string",
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
]
}
}
RETRIEVE BUSINESS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/businesses/{identifier}/
https://business.services.rehive.com/api/user/businesses/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "name": "string",
* "description": "string",
* "website": "string",
* "inc_number": "string",
* "colors": {
* "property1": null,
* "property2": null
},
* "categories": [
* {
* "id": "string",
* "name": "string",
* "parent": {
* "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
* "name": "string",
* "parent": 0,
* "created": 0,
* "updated": 0,
* "description": "string"
},
* "image": "http://example.com",
* "created": 0,
* "updated": 0,
* "description": "string"
}
],
* "logo": "http://example.com",
* "icon": "http://example.com",
* "timezone": "string",
* "vat_number": "string",
* "address_line_1": "string",
* "address_line_2": "string",
* "address_city": "string",
* "address_state_province": "string",
* "address_country": "AF",
* "address_postal_code": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "created": 0,
* "updated": 0
}
}
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/user/company/
https://business.services.rehive.com/api/user/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "manager_groups": [
* "string"
]
}
}
WEBHOOK
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "transaction.create" "currency.create" "currency.update" "user.update"
* transaction.create - transaction.create
* currency.create - currency.create
* currency.update - currency.update
* user.update - User Update
id
required
string
RESPONSES
200
post/webhook/
https://business.services.rehive.com/api/webhook/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "transaction.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}