stellar-testnet.services.rehive.io
Open in
urlscan Pro
2606:4700:10::ac43:2857
Public Scan
URL:
https://stellar-testnet.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
* Authentication
* activate
* activate_create
* admin
* admin_asset_list
* admin_asset_create
* admin_asset_read
* admin_asset_partial_update
* admin_asset_authorise_holder_create
* admin_asset_fund_create
* admin_blacklisted-account_read
* admin_blacklisted-account_update
* admin_blacklisted-account_partial_update
* admin_blacklisted-account_delete
* admin_blacklisted-accounts_list
* admin_blacklisted-accounts_create
* admin_coldstorage_list
* admin_coldstorage_accounts_list
* admin_coldstorage_accounts_create
* admin_coldstorage_accounts_read
* admin_coldstorage_accounts_partial_update
* admin_company_list
* admin_company_partial_update
* admin_company_configuration_list
* admin_company_configuration_update
* admin_company_configuration_partial_update
* admin_company_configuration_account-groups_list
* admin_company_configuration_account-groups_create
* admin_company_configuration_account-groups_read
* admin_company_configuration_account-groups_update
* admin_company_configuration_account-groups_partial_update
* admin_company_configuration_account-groups_delete
* admin_company_configuration_anchor_platform_list
* admin_company_configuration_anchor_platform_update
* admin_company_configuration_anchor_platform_partial_update
* admin_company_stellar-toml_list
* admin_federation_list
* admin_federation_create
* admin_hotwallet_list
* admin_hotwallet_create
* admin_hotwallet_partial_update
* admin_hotwallet_active_list
* admin_hotwallet_enable_mss_create
* admin_hotwallet_fees_list
* admin_hotwallet_fund_list
* admin_hotwallet_merge_create
* admin_hotwallet_send_create
* admin_known-public-addresses_list
* admin_known-public-addresses_create
* admin_known-public-addresses_read
* admin_known-public-addresses_update
* admin_known-public-addresses_partial_update
* admin_known-public-addresses_delete
* admin_memos_list
* admin_memos_create
* admin_sep10-authenticated-accounts_list
* admin_sep10-authenticated-accounts_read
* admin_sep24-transactions_list
* admin_sep24-transactions_read
* admin_stellar_accounts_list
* admin_stellar_accounts_generate_create
* admin_stellar_accounts_read
* admin_stellar_accounts_partial_update
* admin_stellar_accounts_change_ownership_create
* admin_transactions_list
* admin_transactions_send_create
* admin_transactions_read
* admin_transactions_partial_update
* admin_users_list
* admin_users_create
* admin_users_read
* admin_users_partial_update
* admin_users_memos_list
* admin_users_memos_create
* admin_warmstorage_list
* admin_warmstorage_accounts_list
* admin_warmstorage_accounts_create
* admin_warmstorage_accounts_read
* admin_warmstorage_accounts_partial_update
* company
* company_list
* company_assets_list
* deactivate
* deactivate_create
* hooks
* hooks_prs_create
* info
* info_list
* known-assets
* known-assets_list
* stellar_federation
* stellar_federation_read
* transactions
* transactions_list
* transactions_send_create
* user
* user_list
* user_partial_update
* user_account_list
* user_anchor_sessions_validate_create
* user_anchor_sessions_validate_account_create
* user_anchor_sessions_validate_session_create
* user_anchor_transactions_list
* user_anchor_transactions_read
* user_anchor_transactions_create
* user_anchor_transactions_partial_update
* user_anchor_auth_create
* user_known-public-addresses_list
* user_memos_list
* user_memos_create
* user_transactions_send_create
* user_username_set_create
STELLAR SERVICE API (V1)
Download OpenAPI specification:Download
Start by clicking Authorize and adding the header: Token . The user endpoints
require a normal rehive user token returned by Rehive's /auth/login/ or
/auth/register/ endpoints. The admin endpoints require a permanent token with
admin permissions. The /hooks/ enpoint requires the secret from the Rehive
webhook settings in the authorization header as Secret .
AUTHENTICATION
BEARER
Security scheme type: API Key header parameter name: Authorization
ACTIVATE
ACTIVATE_CREATE
This endpoint is used by the Rehive Marketplace to add this service for a
specific company. It requires an permanent API token for that company with admin
permissions.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
token
required
string (Token) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
token
required
string (Token) non-empty
id
string (Id) non-empty
email
string (Email) non-empty
secret
string <uuid> (Secret)
post /activate/
https://stellar-testnet.services.rehive.io/api/1/activate/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "token": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "id": "string",
* "email": "string",
* "secret": "string"
}
ADMIN
ADMIN_ASSET_LIST
Add a new stellar asset to the service, or list existing assets. You'll need to
include a valid stellar anchor issuing address and asset ID.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
address
required
string (Address) non-empty
currency_code
required
string (Currency code) [ 1 .. 12 ] characters
description
string (Description) non-empty
symbol
string (Symbol) non-empty
unit
string (Unit) non-empty
id
string (Id) non-empty
issued_by_company
boolean (Issued by company)
sep24_enabled
boolean (Sep24 enabled)
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) non-empty
divisibility
integer (Divisibility) [ 0 .. 7 ]
get /admin/asset/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "address": "string",
* "currency_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "id": "string",
* "issued_by_company": true,
* "sep24_enabled": true,
* "auth_required": true,
* "auth_signing_key": "string",
* "divisibility": 0
}
]
ADMIN_ASSET_CREATE
Add a new stellar asset to the service, or list existing assets. You'll need to
include a valid stellar anchor issuing address and asset ID.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
address
required
string (Address) non-empty
currency_code
required
string (Currency code) [ 1 .. 12 ] characters
description
string (Description) non-empty
symbol
string (Symbol) non-empty
unit
string (Unit) non-empty
issued_by_company
boolean (Issued by company)
sep24_enabled
boolean (Sep24 enabled)
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) non-empty
divisibility
integer (Divisibility) [ 0 .. 7 ]
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
address
required
string (Address) non-empty
currency_code
required
string (Currency code) [ 1 .. 12 ] characters
description
string (Description) non-empty
symbol
string (Symbol) non-empty
unit
string (Unit) non-empty
id
string (Id) non-empty
issued_by_company
boolean (Issued by company)
sep24_enabled
boolean (Sep24 enabled)
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) non-empty
divisibility
integer (Divisibility) [ 0 .. 7 ]
post /admin/asset/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "address": "string",
* "currency_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "issued_by_company": true,
* "sep24_enabled": true,
* "auth_required": true,
* "auth_signing_key": "string",
* "divisibility": 0
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "address": "string",
* "currency_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "id": "string",
* "issued_by_company": true,
* "sep24_enabled": true,
* "auth_required": true,
* "auth_signing_key": "string",
* "divisibility": 0
}
ADMIN_ASSET_READ
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
address
string (Address) non-empty Nullable
currency_code
string (Currency code) non-empty Nullable
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) <= 100 characters Nullable
display_decimals
integer (Display decimals) [ 0 .. 2147483647 ]
get /admin/asset/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "address": "string",
* "currency_code": "string",
* "auth_required": true,
* "auth_signing_key": "string",
* "display_decimals": 0
}
ADMIN_ASSET_PARTIAL_UPDATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) <= 100 characters Nullable
display_decimals
integer (Display decimals) [ 0 .. 2147483647 ]
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
address
string (Address) non-empty Nullable
currency_code
string (Currency code) non-empty Nullable
auth_required
boolean (Auth required)
auth_signing_key
string (Auth signing key) <= 100 characters Nullable
display_decimals
integer (Display decimals) [ 0 .. 2147483647 ]
patch /admin/asset/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "auth_required": true,
* "auth_signing_key": "string",
* "display_decimals": 0
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "address": "string",
* "currency_code": "string",
* "auth_required": true,
* "auth_signing_key": "string",
* "display_decimals": 0
}
ADMIN_ASSET_AUTHORISE_HOLDER_CREATE
A simple APIView for funding asset accounts.
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
trustor_public_address
required
integer (Trustor public address)
authorize
required
boolean (Authorize)
asset_id
required
string <uuid> (Asset id)
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
trustor_public_address
required
integer (Trustor public address)
authorize
required
boolean (Authorize)
asset_id
required
string <uuid> (Asset id)
post /admin/asset/{id}/authorise_holder/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/{id}/authorise_holder/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "trustor_public_address": 0,
* "authorize": true,
* "asset_id": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "trustor_public_address": 0,
* "authorize": true,
* "asset_id": "string"
}
ADMIN_ASSET_FUND_CREATE
A simple APIView for funding asset accounts.
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
issuer_secret
string (Issuer secret) Nullable
amount
required
integer (Amount)
asset_id
required
string <uuid> (Asset id)
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
issuer_secret
string (Issuer secret) Nullable
amount
required
integer (Amount)
asset_id
required
string <uuid> (Asset id)
post /admin/asset/{id}/fund/
https://stellar-testnet.services.rehive.io/api/1/admin/asset/{id}/fund/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "issuer_secret": "string",
* "amount": 0,
* "asset_id": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "issuer_secret": "string",
* "amount": 0,
* "asset_id": "string"
}
ADMIN_BLACKLISTED-ACCOUNT_READ
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/blacklisted-account/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-account/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_BLACKLISTED-ACCOUNT_UPDATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
put /admin/blacklisted-account/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-account/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_BLACKLISTED-ACCOUNT_PARTIAL_UPDATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
patch /admin/blacklisted-account/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-account/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_BLACKLISTED-ACCOUNT_DELETE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
204
No Content
delete /admin/blacklisted-account/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-account/{id}/
ADMIN_BLACKLISTED-ACCOUNTS_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
integer (ID)
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/blacklisted-accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-accounts/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
ADMIN_BLACKLISTED-ACCOUNTS_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
required
string (Public address) [ 1 .. 100 ] characters
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
post /admin/blacklisted-accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/blacklisted-accounts/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_COLDSTORAGE_LIST
VIEW COLDSTORAGE BALANCE
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/coldstorage/
https://stellar-testnet.services.rehive.io/api/1/admin/coldstorage/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "balance": "string",
* "rehive_account_reference": "string",
* "user_account_identifier": "string"
}
]
}
ADMIN_COLDSTORAGE_ACCOUNTS_LIST
LIST OR CREATE COLDSTORAGE ACCOUNTS FOR MONITORING
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/coldstorage/accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/coldstorage/accounts/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
]
}
ADMIN_COLDSTORAGE_ACCOUNTS_CREATE
LIST OR CREATE COLDSTORAGE ACCOUNTS FOR MONITORING
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
account_address
string (Account address) <= 100 characters Nullable
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
note
string (Note) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
service_controlled
boolean (Service controlled)
note
string (Note) <= 255 characters Nullable
post /admin/coldstorage/accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/coldstorage/accounts/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "account_address": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "note": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
ADMIN_COLDSTORAGE_ACCOUNTS_READ
VIEW OR UPDATE A COLD STORAGE ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
service_controlled
boolean (Service controlled)
note
string (Note) <= 255 characters Nullable
get /admin/coldstorage/accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/coldstorage/accounts/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
ADMIN_COLDSTORAGE_ACCOUNTS_PARTIAL_UPDATE
VIEW OR UPDATE A COLD STORAGE ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
account_address
string (Account address) <= 100 characters Nullable
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
note
string (Note) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
service_controlled
boolean (Service controlled)
note
string (Note) <= 255 characters Nullable
patch /admin/coldstorage/accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/coldstorage/accounts/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "account_address": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "note": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
ADMIN_COMPANY_LIST
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
identifier
string (Identifier) non-empty Nullable
secret
string <uuid> (Secret) Nullable
email
string <email> (Email) <= 254 characters Nullable
has_completed_setup
required
boolean (Has completed setup)
active
boolean (Active)
is_federated
string (Is federated)
federation_domain
string (Federation domain)
get /admin/company/
https://stellar-testnet.services.rehive.io/api/1/admin/company/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "identifier": "string",
* "secret": "string",
* "email": "user@example.com",
* "has_completed_setup": true,
* "active": true,
* "is_federated": "string",
* "federation_domain": "string"
}
]
ADMIN_COMPANY_PARTIAL_UPDATE
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
email
string <email> (Email) <= 254 characters Nullable
has_completed_setup
required
boolean (Has completed setup)
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string (Identifier) non-empty Nullable
secret
string <uuid> (Secret) Nullable
email
string <email> (Email) <= 254 characters Nullable
has_completed_setup
required
boolean (Has completed setup)
active
boolean (Active)
is_federated
string (Is federated)
federation_domain
string (Federation domain)
patch /admin/company/
https://stellar-testnet.services.rehive.io/api/1/admin/company/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "email": "user@example.com",
* "has_completed_setup": true
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "secret": "string",
* "email": "user@example.com",
* "has_completed_setup": true,
* "active": true,
* "is_federated": "string",
* "federation_domain": "string"
}
ADMIN_COMPANY_CONFIGURATION_LIST
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
transaction_credit_subtype
string (Transaction credit subtype) <= 100 characters Nullable
transaction_debit_subtype
string (Transaction debit subtype) <= 100 characters Nullable
transaction_fee_subtype
string (Transaction fee subtype) <= 100 characters Nullable
use_default_as_fallback
boolean (Use default as fallback)
transaction_fund_subtype
string (Transaction fund subtype) <= 100 characters Nullable
transaction_issue_subtype
string (Transaction issue subtype) <= 100 characters Nullable
transaction_withdraw_subtype
string (Transaction withdraw subtype) <= 100 characters Nullable
transaction_credit_warmstorage_subtype
string (Transaction credit warmstorage subtype) <= 100 characters Nullable
transaction_debit_warmstorage_subtype
string (Transaction debit warmstorage subtype) <= 100 characters Nullable
transaction_credit_hotwallet_subtype
string (Transaction credit hotwallet subtype) <= 100 characters Nullable
transaction_debit_hotwallet_subtype
string (Transaction debit hotwallet subtype) <= 100 characters Nullable
transaction_credit_coldstorage_subtype
string (Transaction credit coldstorage subtype) <= 100 characters Nullable
transaction_debit_coldstorage_subtype
string (Transaction debit coldstorage subtype) <= 100 characters Nullable
currency_fees_paid_by_company
Array of string
group_account_pairs
Array of object
disable_withdrawals
boolean (Disable withdrawals)
allow_multiple_memos_per_user
boolean (Allow multiple memos per user)
external_signer_url
string (External signer url) <= 255 characters Nullable
external_signer_key
string (External signer key) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/company/configuration/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "use_default_as_fallback": true,
* "transaction_fund_subtype": "string",
* "transaction_issue_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "transaction_credit_warmstorage_subtype": "string",
* "transaction_debit_warmstorage_subtype": "string",
* "transaction_credit_hotwallet_subtype": "string",
* "transaction_debit_hotwallet_subtype": "string",
* "transaction_credit_coldstorage_subtype": "string",
* "transaction_debit_coldstorage_subtype": "string",
* "currency_fees_paid_by_company":
[
* "string"
],
* "group_account_pairs":
[
*
{
* "id": "string",
* "group": "string",
* "account": "string"
}
],
* "disable_withdrawals": true,
* "allow_multiple_memos_per_user": true,
* "external_signer_url": "string",
* "external_signer_key": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
ADMIN_COMPANY_CONFIGURATION_UPDATE
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
transaction_credit_subtype
string (Transaction credit subtype) <= 100 characters Nullable
transaction_debit_subtype
string (Transaction debit subtype) <= 100 characters Nullable
transaction_fee_subtype
string (Transaction fee subtype) <= 100 characters Nullable
use_default_as_fallback
boolean (Use default as fallback)
transaction_fund_subtype
string (Transaction fund subtype) <= 100 characters Nullable
transaction_issue_subtype
string (Transaction issue subtype) <= 100 characters Nullable
transaction_withdraw_subtype
string (Transaction withdraw subtype) <= 100 characters Nullable
transaction_credit_warmstorage_subtype
string (Transaction credit warmstorage subtype) <= 100 characters Nullable
transaction_debit_warmstorage_subtype
string (Transaction debit warmstorage subtype) <= 100 characters Nullable
transaction_credit_hotwallet_subtype
string (Transaction credit hotwallet subtype) <= 100 characters Nullable
transaction_debit_hotwallet_subtype
string (Transaction debit hotwallet subtype) <= 100 characters Nullable
transaction_credit_coldstorage_subtype
string (Transaction credit coldstorage subtype) <= 100 characters Nullable
transaction_debit_coldstorage_subtype
string (Transaction debit coldstorage subtype) <= 100 characters Nullable
currency_fees_paid_by_company
Array of string
group_account_pairs
Array of object
disable_withdrawals
boolean (Disable withdrawals)
allow_multiple_memos_per_user
boolean (Allow multiple memos per user)
external_signer_url
string (External signer url) <= 255 characters Nullable
external_signer_key
string (External signer key) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
transaction_credit_subtype
string (Transaction credit subtype) <= 100 characters Nullable
transaction_debit_subtype
string (Transaction debit subtype) <= 100 characters Nullable
transaction_fee_subtype
string (Transaction fee subtype) <= 100 characters Nullable
use_default_as_fallback
boolean (Use default as fallback)
transaction_fund_subtype
string (Transaction fund subtype) <= 100 characters Nullable
transaction_issue_subtype
string (Transaction issue subtype) <= 100 characters Nullable
transaction_withdraw_subtype
string (Transaction withdraw subtype) <= 100 characters Nullable
transaction_credit_warmstorage_subtype
string (Transaction credit warmstorage subtype) <= 100 characters Nullable
transaction_debit_warmstorage_subtype
string (Transaction debit warmstorage subtype) <= 100 characters Nullable
transaction_credit_hotwallet_subtype
string (Transaction credit hotwallet subtype) <= 100 characters Nullable
transaction_debit_hotwallet_subtype
string (Transaction debit hotwallet subtype) <= 100 characters Nullable
transaction_credit_coldstorage_subtype
string (Transaction credit coldstorage subtype) <= 100 characters Nullable
transaction_debit_coldstorage_subtype
string (Transaction debit coldstorage subtype) <= 100 characters Nullable
currency_fees_paid_by_company
Array of string
group_account_pairs
Array of object
disable_withdrawals
boolean (Disable withdrawals)
allow_multiple_memos_per_user
boolean (Allow multiple memos per user)
external_signer_url
string (External signer url) <= 255 characters Nullable
external_signer_key
string (External signer key) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
put /admin/company/configuration/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "use_default_as_fallback": true,
* "transaction_fund_subtype": "string",
* "transaction_issue_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "transaction_credit_warmstorage_subtype": "string",
* "transaction_debit_warmstorage_subtype": "string",
* "transaction_credit_hotwallet_subtype": "string",
* "transaction_debit_hotwallet_subtype": "string",
* "transaction_credit_coldstorage_subtype": "string",
* "transaction_debit_coldstorage_subtype": "string",
* "currency_fees_paid_by_company":
[
* "string"
],
* "group_account_pairs":
[
*
{
* "group": "string",
* "account": "string"
}
],
* "disable_withdrawals": true,
* "allow_multiple_memos_per_user": true,
* "external_signer_url": "string",
* "external_signer_key": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "use_default_as_fallback": true,
* "transaction_fund_subtype": "string",
* "transaction_issue_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "transaction_credit_warmstorage_subtype": "string",
* "transaction_debit_warmstorage_subtype": "string",
* "transaction_credit_hotwallet_subtype": "string",
* "transaction_debit_hotwallet_subtype": "string",
* "transaction_credit_coldstorage_subtype": "string",
* "transaction_debit_coldstorage_subtype": "string",
* "currency_fees_paid_by_company":
[
* "string"
],
* "group_account_pairs":
[
*
{
* "id": "string",
* "group": "string",
* "account": "string"
}
],
* "disable_withdrawals": true,
* "allow_multiple_memos_per_user": true,
* "external_signer_url": "string",
* "external_signer_key": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_COMPANY_CONFIGURATION_PARTIAL_UPDATE
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
transaction_credit_subtype
string (Transaction credit subtype) <= 100 characters Nullable
transaction_debit_subtype
string (Transaction debit subtype) <= 100 characters Nullable
transaction_fee_subtype
string (Transaction fee subtype) <= 100 characters Nullable
use_default_as_fallback
boolean (Use default as fallback)
transaction_fund_subtype
string (Transaction fund subtype) <= 100 characters Nullable
transaction_issue_subtype
string (Transaction issue subtype) <= 100 characters Nullable
transaction_withdraw_subtype
string (Transaction withdraw subtype) <= 100 characters Nullable
transaction_credit_warmstorage_subtype
string (Transaction credit warmstorage subtype) <= 100 characters Nullable
transaction_debit_warmstorage_subtype
string (Transaction debit warmstorage subtype) <= 100 characters Nullable
transaction_credit_hotwallet_subtype
string (Transaction credit hotwallet subtype) <= 100 characters Nullable
transaction_debit_hotwallet_subtype
string (Transaction debit hotwallet subtype) <= 100 characters Nullable
transaction_credit_coldstorage_subtype
string (Transaction credit coldstorage subtype) <= 100 characters Nullable
transaction_debit_coldstorage_subtype
string (Transaction debit coldstorage subtype) <= 100 characters Nullable
currency_fees_paid_by_company
Array of string
group_account_pairs
Array of object
disable_withdrawals
boolean (Disable withdrawals)
allow_multiple_memos_per_user
boolean (Allow multiple memos per user)
external_signer_url
string (External signer url) <= 255 characters Nullable
external_signer_key
string (External signer key) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
transaction_credit_subtype
string (Transaction credit subtype) <= 100 characters Nullable
transaction_debit_subtype
string (Transaction debit subtype) <= 100 characters Nullable
transaction_fee_subtype
string (Transaction fee subtype) <= 100 characters Nullable
use_default_as_fallback
boolean (Use default as fallback)
transaction_fund_subtype
string (Transaction fund subtype) <= 100 characters Nullable
transaction_issue_subtype
string (Transaction issue subtype) <= 100 characters Nullable
transaction_withdraw_subtype
string (Transaction withdraw subtype) <= 100 characters Nullable
transaction_credit_warmstorage_subtype
string (Transaction credit warmstorage subtype) <= 100 characters Nullable
transaction_debit_warmstorage_subtype
string (Transaction debit warmstorage subtype) <= 100 characters Nullable
transaction_credit_hotwallet_subtype
string (Transaction credit hotwallet subtype) <= 100 characters Nullable
transaction_debit_hotwallet_subtype
string (Transaction debit hotwallet subtype) <= 100 characters Nullable
transaction_credit_coldstorage_subtype
string (Transaction credit coldstorage subtype) <= 100 characters Nullable
transaction_debit_coldstorage_subtype
string (Transaction debit coldstorage subtype) <= 100 characters Nullable
currency_fees_paid_by_company
Array of string
group_account_pairs
Array of object
disable_withdrawals
boolean (Disable withdrawals)
allow_multiple_memos_per_user
boolean (Allow multiple memos per user)
external_signer_url
string (External signer url) <= 255 characters Nullable
external_signer_key
string (External signer key) <= 255 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
patch /admin/company/configuration/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "use_default_as_fallback": true,
* "transaction_fund_subtype": "string",
* "transaction_issue_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "transaction_credit_warmstorage_subtype": "string",
* "transaction_debit_warmstorage_subtype": "string",
* "transaction_credit_hotwallet_subtype": "string",
* "transaction_debit_hotwallet_subtype": "string",
* "transaction_credit_coldstorage_subtype": "string",
* "transaction_debit_coldstorage_subtype": "string",
* "currency_fees_paid_by_company":
[
* "string"
],
* "group_account_pairs":
[
*
{
* "group": "string",
* "account": "string"
}
],
* "disable_withdrawals": true,
* "allow_multiple_memos_per_user": true,
* "external_signer_url": "string",
* "external_signer_key": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "use_default_as_fallback": true,
* "transaction_fund_subtype": "string",
* "transaction_issue_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "transaction_credit_warmstorage_subtype": "string",
* "transaction_debit_warmstorage_subtype": "string",
* "transaction_credit_hotwallet_subtype": "string",
* "transaction_debit_hotwallet_subtype": "string",
* "transaction_credit_coldstorage_subtype": "string",
* "transaction_debit_coldstorage_subtype": "string",
* "currency_fees_paid_by_company":
[
* "string"
],
* "group_account_pairs":
[
*
{
* "id": "string",
* "group": "string",
* "account": "string"
}
],
* "disable_withdrawals": true,
* "allow_multiple_memos_per_user": true,
* "external_signer_url": "string",
* "external_signer_key": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_LIST
Group/Account Pairs specified for the company
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
get /admin/company/configuration/account-groups/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "group": "string",
* "account": "string"
}
]
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_CREATE
Group/Account Pairs specified for the company
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
post /admin/company/configuration/account-groups/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "group": "string",
* "account": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "group": "string",
* "account": "string"
}
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_READ
Details for a Group/Account pair
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
get /admin/company/configuration/account-groups/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "group": "string",
* "account": "string"
}
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_UPDATE
Details for a Group/Account pair
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
put /admin/company/configuration/account-groups/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "group": "string",
* "account": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "group": "string",
* "account": "string"
}
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_PARTIAL_UPDATE
Details for a Group/Account pair
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
group
required
string (Group) [ 1 .. 100 ] characters
account
required
string (Account) [ 1 .. 100 ] characters
patch /admin/company/configuration/account-groups/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "group": "string",
* "account": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "group": "string",
* "account": "string"
}
ADMIN_COMPANY_CONFIGURATION_ACCOUNT-GROUPS_DELETE
Details for a Group/Account pair
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
204
No Content
delete /admin/company/configuration/account-groups/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/account-groups/{id}/
ADMIN_COMPANY_CONFIGURATION_ANCHOR_PLATFORM_LIST
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
sep10_jwt_secret
string (Sep10 jwt secret) [ 1 .. 100 ] characters Nullable
anchor_platform_api_key
string (Anchor platform api key) [ 1 .. 100 ] characters Nullable
anchor_platform_base_api
string (Anchor platform base api) [ 1 .. 100 ] characters Nullable
anchor_tier_requirement
string (Anchor tier requirement) [ 1 .. 100 ] characters Nullable
withdrawable_currencies
Array of string Nullable
get /admin/company/configuration/anchor_platform/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/anchor_platform/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "sep10_jwt_secret": "string",
* "anchor_platform_api_key": "string",
* "anchor_platform_base_api": "string",
* "anchor_tier_requirement": "string",
* "withdrawable_currencies":
[
* "string"
]
}
]
ADMIN_COMPANY_CONFIGURATION_ANCHOR_PLATFORM_UPDATE
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
sep10_jwt_secret
string (Sep10 jwt secret) [ 1 .. 100 ] characters Nullable
anchor_platform_api_key
string (Anchor platform api key) [ 1 .. 100 ] characters Nullable
anchor_platform_base_api
string (Anchor platform base api) [ 1 .. 100 ] characters Nullable
anchor_tier_requirement
string (Anchor tier requirement) [ 1 .. 100 ] characters Nullable
withdrawable_currencies
Array of string Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
sep10_jwt_secret
string (Sep10 jwt secret) [ 1 .. 100 ] characters Nullable
anchor_platform_api_key
string (Anchor platform api key) [ 1 .. 100 ] characters Nullable
anchor_platform_base_api
string (Anchor platform base api) [ 1 .. 100 ] characters Nullable
anchor_tier_requirement
string (Anchor tier requirement) [ 1 .. 100 ] characters Nullable
withdrawable_currencies
Array of string Nullable
put /admin/company/configuration/anchor_platform/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/anchor_platform/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "sep10_jwt_secret": "string",
* "anchor_platform_api_key": "string",
* "anchor_platform_base_api": "string",
* "anchor_tier_requirement": "string",
* "withdrawable_currencies":
[
* "string"
]
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "sep10_jwt_secret": "string",
* "anchor_platform_api_key": "string",
* "anchor_platform_base_api": "string",
* "anchor_tier_requirement": "string",
* "withdrawable_currencies":
[
* "string"
]
}
ADMIN_COMPANY_CONFIGURATION_ANCHOR_PLATFORM_PARTIAL_UPDATE
Details of Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
sep10_jwt_secret
string (Sep10 jwt secret) [ 1 .. 100 ] characters Nullable
anchor_platform_api_key
string (Anchor platform api key) [ 1 .. 100 ] characters Nullable
anchor_platform_base_api
string (Anchor platform base api) [ 1 .. 100 ] characters Nullable
anchor_tier_requirement
string (Anchor tier requirement) [ 1 .. 100 ] characters Nullable
withdrawable_currencies
Array of string Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
sep10_jwt_secret
string (Sep10 jwt secret) [ 1 .. 100 ] characters Nullable
anchor_platform_api_key
string (Anchor platform api key) [ 1 .. 100 ] characters Nullable
anchor_platform_base_api
string (Anchor platform base api) [ 1 .. 100 ] characters Nullable
anchor_tier_requirement
string (Anchor tier requirement) [ 1 .. 100 ] characters Nullable
withdrawable_currencies
Array of string Nullable
patch /admin/company/configuration/anchor_platform/
https://stellar-testnet.services.rehive.io/api/1/admin/company/configuration/anchor_platform/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "sep10_jwt_secret": "string",
* "anchor_platform_api_key": "string",
* "anchor_platform_base_api": "string",
* "anchor_tier_requirement": "string",
* "withdrawable_currencies":
[
* "string"
]
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "sep10_jwt_secret": "string",
* "anchor_platform_api_key": "string",
* "anchor_platform_base_api": "string",
* "anchor_tier_requirement": "string",
* "withdrawable_currencies":
[
* "string"
]
}
ADMIN_COMPANY_STELLAR-TOML_LIST
Create and sends back a link to a Stellar.toml file
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
file
string <uri> (File)
get /admin/company/stellar-toml/
https://stellar-testnet.services.rehive.io/api/1/admin/company/stellar-toml/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "file": "http://example.com"
}
]
ADMIN_FEDERATION_LIST
VIEW OR UPDATE A STELLAR ACCOUNT
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
domain
string (Domain) <= 255 characters Nullable
validated
boolean (Validated)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/federation/
https://stellar-testnet.services.rehive.io/api/1/admin/federation/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "domain": "string",
* "validated": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
ADMIN_FEDERATION_CREATE
VIEW OR UPDATE A STELLAR ACCOUNT
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
domain
string (Domain) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
domain
string (Domain) <= 255 characters Nullable
validated
boolean (Validated)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
post /admin/federation/
https://stellar-testnet.services.rehive.io/api/1/admin/federation/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "domain": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "domain": "string",
* "validated": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_HOTWALLET_LIST
VIEW, CREATE AND UPDATE THE HOT WALLET
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
rehive_account_reference
string (Rehive account reference) non-empty
low_balance_percentage
string <decimal> (Low balance percentage)
low_balance_amount
integer (Low balance amount) [ -9223372036854776000 .. 9223372036854776000 ]
fee_priority
string (Fee priority)
Enum:"high" "medium" "low"
fee_maximum
string (Fee maximum)
Enum:"10" "20" "30" "40" "50" "60" "70" "80" "90" "95" "99"
externally_signed
boolean (Externally signed)
primary_hotwallet_account
string (Primary hotwallet account)
get /admin/hotwallet/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "rehive_account_reference": "string",
* "low_balance_percentage": "string",
* "low_balance_amount": -9223372036854776000,
* "fee_priority": "high",
* "fee_maximum": "10",
* "externally_signed": true,
* "primary_hotwallet_account": "string"
}
]
ADMIN_HOTWALLET_CREATE
VIEW, CREATE AND UPDATE THE HOT WALLET
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
low_balance_percentage
string <decimal> (Low balance percentage)
low_balance_amount
integer (Low balance amount) [ -9223372036854776000 .. 9223372036854776000 ]
fee_priority
string (Fee priority)
Enum:"high" "medium" "low"
fee_maximum
string (Fee maximum)
Enum:"10" "20" "30" "40" "50" "60" "70" "80" "90" "95" "99"
externally_signed
boolean (Externally signed)
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
rehive_account_reference
string (Rehive account reference) non-empty
low_balance_percentage
string <decimal> (Low balance percentage)
low_balance_amount
integer (Low balance amount) [ -9223372036854776000 .. 9223372036854776000 ]
fee_priority
string (Fee priority)
Enum:"high" "medium" "low"
fee_maximum
string (Fee maximum)
Enum:"10" "20" "30" "40" "50" "60" "70" "80" "90" "95" "99"
externally_signed
boolean (Externally signed)
primary_hotwallet_account
string (Primary hotwallet account)
post /admin/hotwallet/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "low_balance_percentage": "string",
* "low_balance_amount": -9223372036854776000,
* "fee_priority": "high",
* "fee_maximum": "10",
* "externally_signed": true
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "rehive_account_reference": "string",
* "low_balance_percentage": "string",
* "low_balance_amount": -9223372036854776000,
* "fee_priority": "high",
* "fee_maximum": "10",
* "externally_signed": true,
* "primary_hotwallet_account": "string"
}
ADMIN_HOTWALLET_PARTIAL_UPDATE
VIEW, CREATE AND UPDATE THE HOT WALLET
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
low_balance_percentage
string <decimal> (Low balance percentage)
low_balance_amount
integer (Low balance amount) [ -9223372036854776000 .. 9223372036854776000 ]
fee_priority
string (Fee priority)
Enum:"high" "medium" "low"
fee_maximum
string (Fee maximum)
Enum:"10" "20" "30" "40" "50" "60" "70" "80" "90" "95" "99"
externally_signed
boolean (Externally signed)
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
rehive_account_reference
string (Rehive account reference) non-empty
low_balance_percentage
string <decimal> (Low balance percentage)
low_balance_amount
integer (Low balance amount) [ -9223372036854776000 .. 9223372036854776000 ]
fee_priority
string (Fee priority)
Enum:"high" "medium" "low"
fee_maximum
string (Fee maximum)
Enum:"10" "20" "30" "40" "50" "60" "70" "80" "90" "95" "99"
externally_signed
boolean (Externally signed)
primary_hotwallet_account
string (Primary hotwallet account)
patch /admin/hotwallet/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "low_balance_percentage": "string",
* "low_balance_amount": -9223372036854776000,
* "fee_priority": "high",
* "fee_maximum": "10",
* "externally_signed": true
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "rehive_account_reference": "string",
* "low_balance_percentage": "string",
* "low_balance_amount": -9223372036854776000,
* "fee_priority": "high",
* "fee_maximum": "10",
* "externally_signed": true,
* "primary_hotwallet_account": "string"
}
ADMIN_HOTWALLET_ACTIVE_LIST
VIEW HOTWALLET BALANCE
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
balance
string (Balance)
rehive_account_reference
string (Rehive account reference)
low_balance_percentage
string (Low balance percentage)
user_account_identifier
string (User account identifier)
primary_stellar_account
string (Primary stellar account)
get /admin/hotwallet/active/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/active/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "balance": "string",
* "rehive_account_reference": "string",
* "low_balance_percentage": "string",
* "user_account_identifier": "string",
* "primary_stellar_account": "string"
}
]
ADMIN_HOTWALLET_ENABLE_MSS_CREATE
A simple APIView for funding asset accounts.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
account_address
string (Account address)
post /admin/hotwallet/enable_mss/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/enable_mss/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{ }
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "account_address": "string"
}
ADMIN_HOTWALLET_FEES_LIST
VIEW HOTWALLET BALANCE
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
total_fees
string (Total fees)
get /admin/hotwallet/fees/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/fees/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "total_fees": "string"
}
]
ADMIN_HOTWALLET_FUND_LIST
View and update company. Authenticates requests using a token in the
Authorization header.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
account_address
string (Account address)
get /admin/hotwallet/fund/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/fund/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "account_address": "string"
}
]
ADMIN_HOTWALLET_MERGE_CREATE
MERGES AND DELETES THE CURRENT HOTWALLET
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
destination_account
required
string (Destination account) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
destination_account
required
string (Destination account) non-empty
post /admin/hotwallet/merge/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/merge/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "destination_account": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "destination_account": "string"
}
ADMIN_HOTWALLET_SEND_CREATE
SENDS AN ONCHAIN TRANSACTIONS DIRECTLY FROM THE HOTWALLET
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
rehive_code
string (Rehive code) non-empty
rehive_response
object (Rehive response)
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
post /admin/hotwallet/send/
https://stellar-testnet.services.rehive.io/api/1/admin/hotwallet/send/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "rehive_code": "string",
* "rehive_response": { },
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
ADMIN_KNOWN-PUBLIC-ADDRESSES_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/known-public-addresses/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
ADMIN_KNOWN-PUBLIC-ADDRESSES_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
requires_memo
boolean (Requires memo)
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
post /admin/known-public-addresses/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string",
* "requires_memo": true
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_KNOWN-PUBLIC-ADDRESSES_READ
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/known-public-addresses/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_KNOWN-PUBLIC-ADDRESSES_UPDATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
requires_memo
boolean (Requires memo)
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
put /admin/known-public-addresses/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string",
* "requires_memo": true
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_KNOWN-PUBLIC-ADDRESSES_PARTIAL_UPDATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
requires_memo
boolean (Requires memo)
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
patch /admin/known-public-addresses/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "public_address": "string",
* "name": "string",
* "description": "string",
* "requires_memo": true
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_KNOWN-PUBLIC-ADDRESSES_DELETE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
204
No Content
delete /admin/known-public-addresses/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/known-public-addresses/{id}/
ADMIN_MEMOS_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
get /admin/memos/
https://stellar-testnet.services.rehive.io/api/1/admin/memos/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
]
ADMIN_MEMOS_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
rehive_account
string (Rehive account) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
post /admin/memos/
https://stellar-testnet.services.rehive.io/api/1/admin/memos/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "rehive_account": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
ADMIN_SEP10-AUTHENTICATED-ACCOUNTS_LIST
LIST TRANSACTIONS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/sep10-authenticated-accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/sep10-authenticated-accounts/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "identifier": "string",
* "onchain_identifier": "string",
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "first_name": "string",
* "last_name": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "account_id": "string",
* "username": "string",
* "memo": "string"
},
* "is_validated": true,
* "client_domain": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
}
ADMIN_SEP10-AUTHENTICATED-ACCOUNTS_READ
GET A SINGLE SEP10AUTHENTICATEDACCOUNT OBJECT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string <uuid> (Identifier)
onchain_identifier
string (Onchain identifier) non-empty
user
required
object (UserSeralizer)
is_validated
boolean (Is validated)
client_domain
string (Client domain) non-empty Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /admin/sep10-authenticated-accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/sep10-authenticated-accounts/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "onchain_identifier": "string",
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "first_name": "string",
* "last_name": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "account_id": "string",
* "username": "string",
* "memo": "string"
},
* "is_validated": true,
* "client_domain": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
ADMIN_SEP24-TRANSACTIONS_LIST
LIST ALL SEP24TRANSACTION OBJECTS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/sep24-transactions/
https://stellar-testnet.services.rehive.io/api/1/admin/sep24-transactions/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "sep10_authenticated_account": "string",
* "prs_request": "string",
* "tx_type": "deposit",
* "amount": 0,
* "currency": "string",
* "transaction":
{
* "id": 0,
* "user": "string",
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
},
* "rehive_withdrawal_account_reference": "string",
* "rehive_withdrawal_transaction_id": "string",
* "processing_account": "string",
* "rehive_internal_dispersal_collection_id": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
]
}
ADMIN_SEP24-TRANSACTIONS_READ
GET A SINGLE SEP24TRANSACTION OBJECT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string <uuid> (Identifier)
anchor_platform_id
string (Anchor platform id) non-empty
sep10_authenticated_account
string <uuid> (Sep10 authenticated account) Nullable
prs_request
string (Prs request)
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount)
currency
string (Currency) non-empty
transaction
required
object (Transaction)
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) non-empty Nullable
rehive_withdrawal_transaction_id
string (Rehive withdrawal transaction id) non-empty Nullable
processing_account
string (Processing account) non-empty
rehive_internal_dispersal_collection_id
string (Rehive internal dispersal collection id) non-empty
created
string <date-time> (Created)
updated
string <date-time> (Updated)
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
get /admin/sep24-transactions/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/sep24-transactions/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "sep10_authenticated_account": "string",
* "prs_request": "string",
* "tx_type": "deposit",
* "amount": 0,
* "currency": "string",
* "transaction":
{
* "id": 0,
* "user": "string",
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
},
* "rehive_withdrawal_account_reference": "string",
* "rehive_withdrawal_transaction_id": "string",
* "processing_account": "string",
* "rehive_internal_dispersal_collection_id": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
ADMIN_STELLAR_ACCOUNTS_LIST
LIST STELLAR ACCOUNTS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/stellar_accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/stellar_accounts/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
]
}
ADMIN_STELLAR_ACCOUNTS_GENERATE_CREATE
VIEW OR UPDATE A STELLAR ACCOUNT
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) non-empty Nullable
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
post /admin/stellar_accounts/generate/
https://stellar-testnet.services.rehive.io/api/1/admin/stellar_accounts/generate/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "type": "deposit"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "type": "deposit"
}
ADMIN_STELLAR_ACCOUNTS_READ
VIEW OR UPDATE A STELLAR ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
service_controlled
boolean (Service controlled)
note
string (Note) <= 255 characters Nullable
get /admin/stellar_accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/stellar_accounts/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
ADMIN_STELLAR_ACCOUNTS_PARTIAL_UPDATE
VIEW OR UPDATE A STELLAR ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
account_address
string (Account address) <= 100 characters Nullable
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
note
string (Note) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
service_controlled
boolean (Service controlled)
note
string (Note) <= 255 characters Nullable
patch /admin/stellar_accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/stellar_accounts/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "account_address": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "note": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "service_controlled": true,
* "note": "string"
}
ADMIN_STELLAR_ACCOUNTS_CHANGE_OWNERSHIP_CREATE
CHANGE THE OWNERSHIP OF A SERVICE GENERATED ACCOUNT
ADDS A NEW PRIMARY SIGNER AND REMOVES THE SERVICES SECRET AS A SIGNER
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
new_owner_address
required
string (New owner address) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
new_owner_address
required
string (New owner address) non-empty
post /admin/stellar_accounts/{id}/change_ownership/
https://stellar-testnet.services.rehive.io/api/1/admin/stellar_accounts/{id}/change_ownership/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "new_owner_address": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "new_owner_address": "string"
}
ADMIN_TRANSACTIONS_LIST
LIST TRANSACTIONS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/transactions/
https://stellar-testnet.services.rehive.io/api/1/admin/transactions/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": 0,
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
},
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
}
]
}
ADMIN_TRANSACTIONS_SEND_CREATE
View for sending assets directly out of the hotwallet account
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
user
required
string (User) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
rehive_code
string (Rehive code) non-empty
rehive_response
object (Rehive response)
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
user
required
string (User) non-empty
post /admin/transactions/send/
https://stellar-testnet.services.rehive.io/api/1/admin/transactions/send/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": "",
* "user": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "rehive_code": "string",
* "rehive_response": { },
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": "",
* "user": "string"
}
ADMIN_TRANSACTIONS_READ
GET AND PATCH A SINGLE TRANSACTION ON THE STELLAR SERVICE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
user
required
object (AdminUserInfoSeralizer)
reason_for_assigning
string (Reason for assigning) <= 255 characters Nullable
rehive_code
string (Rehive code) non-empty Nullable
external_id
string (External id) non-empty Nullable
rehive_response
object (Rehive response) Nullable
tx_type
string (Tx type)
Enum:"debit" "credit" "deposit" "withdraw" "transfer" "fund" "issue"
"asset_auth"
amount
integer (Amount)
currency
string (Currency) non-empty
status
string (Status) Nullable
Enum:"Initiated" "Quoted" "Unfunded" "Funded" "Waiting" "Pending" "Confirmed"
"Complete" "Failed" "Cancelled"
fee
integer (Fee)
to_reference
string (To reference) non-empty Nullable
from_reference
string (From reference) non-empty Nullable
horizon_response
object (Horizon response) Nullable
withdrawal_status
string (Withdrawal status) Nullable
Enum:"pending_withdrawal" "failed_withdrawal" "approved_withdrawal"
transaction_hash
string (Transaction hash)
xdr
string (Xdr) non-empty Nullable
signed
boolean (Signed)
memo
string (Memo) non-empty
created
string <date-time> (Created)
updated
string <date-time> (Updated)
completed
string <date-time> (Completed) Nullable
get /admin/transactions/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/transactions/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
},
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
}
ADMIN_TRANSACTIONS_PARTIAL_UPDATE
GET AND PATCH A SINGLE TRANSACTION ON THE STELLAR SERVICE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
user
required
object (AdminUserInfoSeralizer)
reason_for_assigning
string (Reason for assigning) <= 255 characters Nullable
withdrawal_status
string (Withdrawal status) Nullable
Enum:"pending_withdrawal" "failed_withdrawal" "approved_withdrawal"
signed
boolean (Signed)
memo
string (Memo) non-empty
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
integer (ID)
user
required
object (AdminUserInfoSeralizer)
reason_for_assigning
string (Reason for assigning) <= 255 characters Nullable
rehive_code
string (Rehive code) non-empty Nullable
external_id
string (External id) non-empty Nullable
rehive_response
object (Rehive response) Nullable
tx_type
string (Tx type)
Enum:"debit" "credit" "deposit" "withdraw" "transfer" "fund" "issue"
"asset_auth"
amount
integer (Amount)
currency
string (Currency) non-empty
status
string (Status) Nullable
Enum:"Initiated" "Quoted" "Unfunded" "Funded" "Waiting" "Pending" "Confirmed"
"Complete" "Failed" "Cancelled"
fee
integer (Fee)
to_reference
string (To reference) non-empty Nullable
from_reference
string (From reference) non-empty Nullable
horizon_response
object (Horizon response) Nullable
withdrawal_status
string (Withdrawal status) Nullable
Enum:"pending_withdrawal" "failed_withdrawal" "approved_withdrawal"
transaction_hash
string (Transaction hash)
xdr
string (Xdr) non-empty Nullable
signed
boolean (Signed)
memo
string (Memo) non-empty
created
string <date-time> (Created)
updated
string <date-time> (Updated)
completed
string <date-time> (Completed) Nullable
patch /admin/transactions/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/transactions/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "user":
{
* "username": "string"
},
* "reason_for_assigning": "string",
* "withdrawal_status": "pending_withdrawal",
* "signed": true,
* "memo": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": 0,
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
},
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
}
ADMIN_USERS_LIST
LIST USERS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/users/
https://stellar-testnet.services.rehive.io/api/1/admin/users/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
}
]
}
ADMIN_USERS_CREATE
LIST USERS
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
username
string (Username) <= 150 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string (Id) non-empty
email
string <email> (Email) non-empty Nullable
identifier
string (Identifier) non-empty
crypto
string (Crypto)
username
string (Username) <= 150 characters Nullable
memo
string (Memo)
post /admin/users/
https://stellar-testnet.services.rehive.io/api/1/admin/users/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "username": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
}
ADMIN_USERS_READ
LIST USERS
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string (Id) non-empty
email
string <email> (Email) non-empty Nullable
identifier
string (Identifier) non-empty
first_name
string (First name) <= 50 characters Nullable
last_name
string (Last name) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
account_id
string (Account id) non-empty Nullable
crypto
string (Crypto)
username
string (Username) <= 150 characters Nullable
memo
string (Memo)
get /admin/users/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/users/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "first_name": "string",
* "last_name": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "account_id": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
}
ADMIN_USERS_PARTIAL_UPDATE
LIST USERS
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
first_name
string (First name) <= 50 characters Nullable
last_name
string (Last name) <= 50 characters Nullable
username
string (Username) <= 150 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string (Id) non-empty
email
string <email> (Email) non-empty Nullable
identifier
string (Identifier) non-empty
first_name
string (First name) <= 50 characters Nullable
last_name
string (Last name) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
account_id
string (Account id) non-empty Nullable
username
string (Username) <= 150 characters Nullable
memo
string (Memo)
patch /admin/users/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/users/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "first_name": "string",
* "last_name": "string",
* "username": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "first_name": "string",
* "last_name": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "account_id": "string",
* "username": "string",
* "memo": "string"
}
ADMIN_USERS_MEMOS_LIST
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
get /admin/users/{id}/memos/
https://stellar-testnet.services.rehive.io/api/1/admin/users/{id}/memos/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
]
ADMIN_USERS_MEMOS_CREATE
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
rehive_account
string (Rehive account) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
post /admin/users/{id}/memos/
https://stellar-testnet.services.rehive.io/api/1/admin/users/{id}/memos/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "rehive_account": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
ADMIN_WARMSTORAGE_LIST
VIEW WARMSTORAGE BALANCE
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/warmstorage/
https://stellar-testnet.services.rehive.io/api/1/admin/warmstorage/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "balance": "string",
* "rehive_account_reference": "string",
* "user_account_identifier": "string"
}
]
}
ADMIN_WARMSTORAGE_ACCOUNTS_LIST
LIST OR CREATE WARMSTORAGE ACCOUNTS FOR MONITORING
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /admin/warmstorage/accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/warmstorage/accounts/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "note": "string"
}
]
}
ADMIN_WARMSTORAGE_ACCOUNTS_CREATE
LIST OR CREATE WARMSTORAGE ACCOUNTS FOR MONITORING
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
account_address
string (Account address) <= 100 characters Nullable
status
string (Status)
Enum:"Active" "Disabled" "Removed"
primary
boolean (Primary)
note
string (Note) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
note
string (Note) <= 255 characters Nullable
post /admin/warmstorage/accounts/
https://stellar-testnet.services.rehive.io/api/1/admin/warmstorage/accounts/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "account_address": "string",
* "status": "Active",
* "primary": true,
* "note": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "note": "string"
}
ADMIN_WARMSTORAGE_ACCOUNTS_READ
VIEW OR UPDATE A WARM STORAGE ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
note
string (Note) <= 255 characters Nullable
get /admin/warmstorage/accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/warmstorage/accounts/{id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "note": "string"
}
ADMIN_WARMSTORAGE_ACCOUNTS_PARTIAL_UPDATE
VIEW OR UPDATE A WARM STORAGE ACCOUNT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
account_address
string (Account address) <= 100 characters Nullable
status
string (Status)
Enum:"Active" "Disabled" "Removed"
primary
boolean (Primary)
note
string (Note) <= 255 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
account_address
string (Account address) <= 100 characters Nullable
cursor
integer (Cursor)
user
string (User)
status
string (Status)
Enum:"Active" "Disabled" "Removed"
type
string (Type) Nullable
Enum:"deposit" "withdraw" "issue"
primary
boolean (Primary)
date_monitoring_was_disabled
string <date-time> (Date monitoring was disabled) Nullable
note
string (Note) <= 255 characters Nullable
patch /admin/warmstorage/accounts/{id}/
https://stellar-testnet.services.rehive.io/api/1/admin/warmstorage/accounts/{id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "account_address": "string",
* "status": "Active",
* "primary": true,
* "note": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "account_address": "string",
* "cursor": 0,
* "user": "string",
* "status": "Active",
* "type": "deposit",
* "primary": true,
* "date_monitoring_was_disabled": "2024-08-27T10:10:38Z",
* "note": "string"
}
COMPANY
COMPANY_LIST
Public details of the Rehive company that was added via the /activate/ endpoint.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
identifier
string (Identifier) non-empty Nullable
active
boolean (Active)
is_federated
string (Is federated)
federation_domain
string (Federation domain)
has_service_issued_acccounts
string (Has service issued acccounts)
company_configuration
required
object (UserCompanyConfiguration)
anchor_tier_requirement
string (Anchor tier requirement)
sep24_withdrawable_currencies
string (Sep24 withdrawable currencies)
get /company/
https://stellar-testnet.services.rehive.io/api/1/company/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "identifier": "string",
* "active": true,
* "is_federated": "string",
* "federation_domain": "string",
* "has_service_issued_acccounts": "string",
* "company_configuration":
{
* "transaction_credit_subtype": "string",
* "transaction_debit_subtype": "string",
* "transaction_fee_subtype": "string",
* "transaction_fund_subtype": "string",
* "transaction_withdraw_subtype": "string",
* "disable_withdrawals": true
},
* "anchor_tier_requirement": "string",
* "sep24_withdrawable_currencies": "string"
}
]
COMPANY_ASSETS_LIST
Add a new stellar asset to the service, or list existing assets. You'll need to
include a valid stellar anchor issuing address and asset ID.
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
hotwallet_account_id
string (Hotwallet account id) non-empty
currency_code
string (Currency code) non-empty
display_decimals
string (Display decimals) non-empty
address
string (Address) non-empty
id
required
string (Id) non-empty
sep24_enabled
boolean (Sep24 enabled)
get /company/assets/
https://stellar-testnet.services.rehive.io/api/1/company/assets/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "hotwallet_account_id": "string",
* "currency_code": "string",
* "display_decimals": "string",
* "address": "string",
* "id": "string",
* "sep24_enabled": true
}
]
DEACTIVATE
DEACTIVATE_CREATE
This endpoint is used by the Rehive Marketplace to remove this service for a
specific company. It requires a permanent API token for that company.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
token
required
string (Token) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
token
required
string (Token) non-empty
post /deactivate/
https://stellar-testnet.services.rehive.io/api/1/deactivate/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "token": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "token": "string"
}
HOOKS
HOOKS_PRS_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
id
required
string (Id) non-empty
event
required
string (Event)
Enum:"service_payment_requests.request.update"
company
required
string (Company) non-empty
data
required
object (Data)
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
required
string (Id) non-empty
event
required
string (Event)
Enum:"service_payment_requests.request.update"
company
required
string (Company) non-empty
data
required
object (Data)
post /hooks/prs/
https://stellar-testnet.services.rehive.io/api/1/hooks/prs/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "service_payment_requests.request.update",
* "company": "string",
* "data": { }
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "service_payment_requests.request.update",
* "company": "string",
* "data": { }
}
INFO
INFO_LIST
Returns node and network data for the service
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
stellar_network
string (Stellar network)
get /info/
https://stellar-testnet.services.rehive.io/api/1/info/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "stellar_network": "string"
}
]
KNOWN-ASSETS
KNOWN-ASSETS_LIST
Returns node and network data for the service
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /known-assets/
https://stellar-testnet.services.rehive.io/api/1/known-assets/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "address": "string",
* "code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "icon": "string",
* "website": "string",
* "name": "string"
}
]
}
STELLAR_FEDERATION
STELLAR_FEDERATION_READ
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
company
required
string
RESPONSES
200
OK
get /stellar_federation/{company}/
https://stellar-testnet.services.rehive.io/api/1/stellar_federation/{company}/
TRANSACTIONS
TRANSACTIONS_LIST
LIST TRANSACTIONS
AUTHORIZATIONS:
Bearer
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
count
required
integer
next
string <uri> Nullable
previous
string <uri> Nullable
results
required
Array of object
get /transactions/
https://stellar-testnet.services.rehive.io/api/1/transactions/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "count": 0,
* "next": "http://example.com",
* "previous": "http://example.com",
* "results":
[
*
{
* "id": 0,
* "user":
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
},
* "reason_for_assigning": "string",
* "rehive_code": "string",
* "external_id": "string",
* "rehive_response": { },
* "tx_type": "debit",
* "amount": 0,
* "currency": "string",
* "status": "Initiated",
* "fee": 0,
* "to_reference": "string",
* "from_reference": "string",
* "horizon_response": { },
* "withdrawal_status": "pending_withdrawal",
* "transaction_hash": "string",
* "xdr": "string",
* "signed": true,
* "memo": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "completed": "2024-08-27T10:10:38Z"
}
]
}
TRANSACTIONS_SEND_CREATE
Create the send transaction on Rehive, and/or on the stellar blockchain. When
the an email address, the transaction will be handled off-chain, only on the
rehive ledger. When sent to a stellar address, the transaction is created on
Rehive. Rehive then sends a webhook to the /hooks/debit/ endpoint and a
blockchain transaction is created and broadcasted.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
rehive_code
string (Rehive code) non-empty
rehive_response
object (Rehive response)
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
post /transactions/send/
https://stellar-testnet.services.rehive.io/api/1/transactions/send/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "rehive_code": "string",
* "rehive_response": { },
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
USER
USER_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string (Id) non-empty
email
string <email> (Email) non-empty Nullable
identifier
string (Identifier) non-empty
crypto
string (Crypto)
username
string (Username) <= 150 characters Nullable
memo
string (Memo)
get /user/
https://stellar-testnet.services.rehive.io/api/1/user/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
}
]
USER_PARTIAL_UPDATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
username
string (Username) <= 150 characters Nullable
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
id
string (Id) non-empty
email
string <email> (Email) non-empty Nullable
identifier
string (Identifier) non-empty
crypto
string (Crypto)
username
string (Username) <= 150 characters Nullable
memo
string (Memo)
patch /user/
https://stellar-testnet.services.rehive.io/api/1/user/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "username": "string"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "email": "user@example.com",
* "identifier": "string",
* "crypto": "string",
* "username": "string",
* "memo": "string"
}
USER_ACCOUNT_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
get /user/account/
https://stellar-testnet.services.rehive.io/api/1/user/account/
USER_ANCHOR_SESSIONS_VALIDATE_CREATE
ENDPOINT FOR VALIDATING A SPECIFIC SESSION ID USING A VALID REHIVE USER SESSION
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
session_id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
post /user/anchor/sessions/{session_id}/validate/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/sessions/{session_id}/validate/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{ }
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{ }
USER_ANCHOR_SESSIONS_VALIDATE_ACCOUNT_CREATE
ENDPOINT FOR VALIDATING A SPECIFIC SESSION ID USING A VALID REHIVE USER SESSION
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
session_id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
post /user/anchor/sessions/{session_id}/validate_account/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/sessions/{session_id}/validate_account/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{ }
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{ }
USER_ANCHOR_SESSIONS_VALIDATE_SESSION_CREATE
ENDPOINT FOR VALIDATING A SPECIFIC SESSION ID USING A VALID REHIVE USER SESSION
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
session_id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
post /user/anchor/sessions/{session_id}/validate_session/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/sessions/{session_id}/validate_session/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{ }
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{ }
USER_ANCHOR_TRANSACTIONS_LIST
ENDPOINT FOR VIEWING ALL USER SEP-10 SESSIONS
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
identifier
string <uuid> (Identifier)
anchor_platform_id
string (Anchor platform id) non-empty
prs_request_id
string (Prs request id)
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
transaction_hash
string (Transaction hash)
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
get /user/anchor/transactions/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/transactions/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "prs_request_id": "string",
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "transaction_hash": "string",
* "rehive_withdrawal_account_reference": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
]
USER_ANCHOR_TRANSACTIONS_READ
ENDPOINT FOR VIEWING ALL USER SEP-10 SESSIONS
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
transaction_id
required
string
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string <uuid> (Identifier)
anchor_platform_id
string (Anchor platform id) non-empty
prs_request_id
string (Prs request id)
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
transaction_hash
string (Transaction hash)
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
get /user/anchor/transactions/{transaction_id}/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/transactions/{transaction_id}/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "prs_request_id": "string",
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "transaction_hash": "string",
* "rehive_withdrawal_account_reference": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
USER_ANCHOR_TRANSACTIONS_CREATE
ENDPOINT FOR VIEWING ALL USER SEP-10 SESSIONS
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
transaction_id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string <uuid> (Identifier)
anchor_platform_id
string (Anchor platform id) non-empty
prs_request_id
string (Prs request id)
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
transaction_hash
string (Transaction hash)
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
post /user/anchor/transactions/{transaction_id}/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/transactions/{transaction_id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "rehive_withdrawal_account_reference": "string",
* "status": "initiated"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "prs_request_id": "string",
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "transaction_hash": "string",
* "rehive_withdrawal_account_reference": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
USER_ANCHOR_TRANSACTIONS_PARTIAL_UPDATE
ENDPOINT FOR VIEWING ALL USER SEP-10 SESSIONS
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
transaction_id
required
string
REQUEST BODY SCHEMA: APPLICATION/JSON
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
identifier
string <uuid> (Identifier)
anchor_platform_id
string (Anchor platform id) non-empty
prs_request_id
string (Prs request id)
tx_type
required
string (Tx type)
Enum:"deposit" "withdraw"
amount
integer (Amount) [ -9223372036854776000 .. 9223372036854776000 ]
currency
required
string (Currency) [ 1 .. 10 ] characters
transaction_hash
string (Transaction hash)
rehive_withdrawal_account_reference
string (Rehive withdrawal account reference) <= 50 characters Nullable
created
string <date-time> (Created)
updated
string <date-time> (Updated)
status
required
string (Status)
Enum:"initiated" "initiated_invoicing" "prs_requested" "prs_quoted"
"prs_processing" "prs_complete" "processing_internal_dispersal"
"completed_internal_dispersal" "processing_external_dispersal"
"completed_external_dispersal" "complete" "failed"
patch /user/anchor/transactions/{transaction_id}/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/transactions/{transaction_id}/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "rehive_withdrawal_account_reference": "string",
* "status": "initiated"
}
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
{
* "identifier": "string",
* "anchor_platform_id": "string",
* "prs_request_id": "string",
* "tx_type": "deposit",
* "amount": -9223372036854776000,
* "currency": "string",
* "transaction_hash": "string",
* "rehive_withdrawal_account_reference": "string",
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "status": "initiated"
}
USER_ANCHOR_AUTH_CREATE
ENDPOINT FOR GENERATING A NEW UNVALIDATED AUTHENTICATION SESSION USING A SEP 10
JWT
AUTHORIZATIONS:
Bearer
PATH PARAMETERS
company_id
required
string
RESPONSES
201
Created
post /user/anchor/{company_id}/auth/
https://stellar-testnet.services.rehive.io/api/1/user/anchor/{company_id}/auth/
USER_KNOWN-PUBLIC-ADDRESSES_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
integer (ID)
public_address
string (Public address) <= 100 characters Nullable
name
string (Name) <= 100 characters Nullable
description
string (Description) <= 255 characters Nullable
logo
string <uri> (Logo) Nullable
requires_memo
boolean (Requires memo)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
get /user/known-public-addresses/
https://stellar-testnet.services.rehive.io/api/1/user/known-public-addresses/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": 0,
* "public_address": "string",
* "name": "string",
* "description": "string",
* "logo": "http://example.com",
* "requires_memo": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z"
}
]
USER_MEMOS_LIST
AUTHORIZATIONS:
Bearer
RESPONSES
200
OK
RESPONSE SCHEMA: APPLICATION/JSON
Array
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
get /user/memos/
https://stellar-testnet.services.rehive.io/api/1/user/memos/
RESPONSE SAMPLES
* 200
application/json
Copy
Expand all Collapse all
[
*
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
]
USER_MEMOS_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
rehive_account
string (Rehive account) <= 255 characters Nullable
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
id
string <uuid> (Id)
data
string (Data) non-empty Nullable
memo_type
string (Memo type) Nullable
Enum:"MEMO_TEXT" "MEMO_ID" "MEMO_HASH" "MEMO_RETURN"
rehive_account
string (Rehive account) <= 255 characters Nullable
primary
boolean (Primary)
created
string <date-time> (Created)
updated
string <date-time> (Updated)
user
integer (User) Nullable
post /user/memos/
https://stellar-testnet.services.rehive.io/api/1/user/memos/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "rehive_account": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "data": "string",
* "memo_type": "MEMO_TEXT",
* "rehive_account": "string",
* "primary": true,
* "created": "2024-08-27T10:10:38Z",
* "updated": "2024-08-27T10:10:38Z",
* "user": 0
}
USER_TRANSACTIONS_SEND_CREATE
Create the send transaction on Rehive, and/or on the stellar blockchain. When
the an email address, the transaction will be handled off-chain, only on the
rehive ledger. When sent to a stellar address, the transaction is created on
Rehive. Rehive then sends a webhook to the /hooks/debit/ endpoint and a
blockchain transaction is created and broadcasted.
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
rehive_code
string (Rehive code) non-empty
rehive_response
object (Rehive response)
reference
string (Reference) Nullable
to_reference
string (To reference) Nullable
amount
required
integer (Amount) >= 0
currency
string (Currency) Nullable
Default: "XLM"
account
string (Account) Nullable
Default: "default"
debit_account
string (Debit account) Nullable
Default: "default"
memo
string (Memo) <= 28 characters
post /user/transactions/send/
https://stellar-testnet.services.rehive.io/api/1/user/transactions/send/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "rehive_code": "string",
* "rehive_response": { },
* "reference": "string",
* "to_reference": "string",
* "amount": 0,
* "currency": "XLM",
* "account": "default",
* "debit_account": "default",
* "memo": ""
}
USER_USERNAME_SET_CREATE
AUTHORIZATIONS:
Bearer
REQUEST BODY SCHEMA: APPLICATION/JSON
username
required
string (Username) non-empty
RESPONSES
201
Created
RESPONSE SCHEMA: APPLICATION/JSON
username
required
string (Username) non-empty
post /user/username/set/
https://stellar-testnet.services.rehive.io/api/1/user/username/set/
REQUEST SAMPLES
* Payload
application/json
Copy
Expand all Collapse all
{
* "username": "string"
}
RESPONSE SAMPLES
* 201
application/json
Copy
Expand all Collapse all
{
* "username": "string"
}