urlscan.io logo urlscan.io
SecurityTrails logo

service-lightning.services.rehive.io Open in urlscan Pro
2606:4700:20::681a:f8a  Public Scan

Back to summary
URL: https://service-lightning.services.rehive.io/
Submission: On September 03 via automatic, source certstream-suspicious

Form analysis 0 forms found in the DOM

Text Content

 * Authentication
 * activate
   * postactivate_create
 * admin
   * getadmin_charges_list
   * postadmin_charges_create
   * getadmin_company_list
   * patchadmin_company_partial_update
   * getadmin_company_configuration_list
   * putadmin_company_configuration_update
   * patchadmin_company_configuration_partial_update
   * getadmin_hotwallet_active_list
   * getadmin_hotwallet_fund_list
   * getadmin_withdrawals_list
 * deactivate
   * postdeactivate_create
 * hooks
   * posthooks_opennode_charge_create
   * posthooks_opennode_withdrawal_create
 * withdrawals
   * getwithdrawals_list
   * postwithdrawals_create

Documentation Powered by ReDoc





LIGHTNING 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.


AUTHENTICATION


BEARER



Security scheme type: API Key header parameter name: Authorization


ACTIVATE


ACTIVATE_CREATE

Activate a company in the service-lightning. A secret key is created on
activation.

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



token
required
string (Token) non-empty



RESPONSES

201

RESPONSE SCHEMA: APPLICATION/JSON

token
required
string (Token) non-empty

id
string (Id) non-empty

name
string (Name) non-empty

secret
string <uuid> (Secret)


post /activate/
https://service-lightning.services.rehive.io/api/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",
 * "name": "string",
 * "secret": "string"

}


ADMIN


ADMIN_CHARGES_LIST

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

RESPONSE SCHEMA: APPLICATION/JSON

count
required
integer

next
string <uri> Nullable

previous
string <uri> Nullable

results
required
Array of object (ListCharge)


get /admin/charges/
https://service-lightning.services.rehive.io/api/admin/charges/


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

{
 * "count": 0,
 * "next": "http://example.com",
 * "previous": "http://example.com",
 * "results":
   
   [
    * 
      {
       * "id": "string",
       * "amount": 0,
       * "invoice": "string",
       * "invoice_expiry": "string",
       * "status": "string",
       * "created": "string",
       * "updated": "string"
      
      }
   
   ]

}


ADMIN_CHARGES_CREATE

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



amount
required
integer (Amount) >= 0



RESPONSES

201

RESPONSE SCHEMA: APPLICATION/JSON

id
string <uuid> (Id)

amount
required
integer (Amount) >= 0

invoice
string (Invoice) non-empty

invoice_expiry
string (Invoice expiry)

status
string (Status) non-empty

created
string (Created)

updated
string (Updated)


post /admin/charges/
https://service-lightning.services.rehive.io/api/admin/charges/


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "amount": 0

}


RESPONSE SAMPLES

 * 201

application/json
Copy
Expand all Collapse all

{
 * "id": "string",
 * "amount": 0,
 * "invoice": "string",
 * "invoice_expiry": "string",
 * "status": "string",
 * "created": "string",
 * "updated": "string"

}


ADMIN_COMPANY_LIST

View and update company. Authenticates requests using a token in the
Authorization header.

AUTHORIZATIONS:

Bearer


RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

Array

id
string (Id) non-empty

identifier
required
string (Identifier) [ 1 .. 100 ] characters

secret
string <uuid> (Secret)

name
required
string (Name) non-empty



get /admin/company/
https://service-lightning.services.rehive.io/api/admin/company/


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

[
 * 
   {
    * "id": "string",
    * "identifier": "string",
    * "secret": "string",
    * "name": "string"
   
   }

]


ADMIN_COMPANY_PARTIAL_UPDATE

View and update company. Authenticates requests using a token in the
Authorization header.

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



identifier
required
string (Identifier) [ 1 .. 100 ] characters

name
required
string (Name) non-empty



RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

id
string (Id) non-empty

identifier
required
string (Identifier) [ 1 .. 100 ] characters

secret
string <uuid> (Secret)

name
required
string (Name) non-empty


patch /admin/company/
https://service-lightning.services.rehive.io/api/admin/company/


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "identifier": "string",
 * "name": "string"

}


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

{
 * "id": "string",
 * "identifier": "string",
 * "secret": "string",
 * "name": "string"

}


ADMIN_COMPANY_CONFIGURATION_LIST

Service configurable variables specific to the company

AUTHORIZATIONS:

Bearer


RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

Array

id
integer (ID)

opennode_api_key
string (Opennode api key) [ 1 .. 200 ] characters Nullable

created
string <date-time> (Created)

updated
string <date-time> (Updated)



get /admin/company/configuration/
https://service-lightning.services.rehive.io/api/admin/company/configuration/


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

[
 * 
   {
    * "id": 0,
    * "opennode_api_key": "string",
    * "created": "2021-09-03T14:22:26Z",
    * "updated": "2021-09-03T14:22:26Z"
   
   }

]


ADMIN_COMPANY_CONFIGURATION_UPDATE

Service configurable variables specific to the company

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



opennode_api_key
string (Opennode api key) [ 1 .. 200 ] characters Nullable



RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

id
integer (ID)

opennode_api_key
string (Opennode api key) [ 1 .. 200 ] characters Nullable

created
string <date-time> (Created)

updated
string <date-time> (Updated)


put /admin/company/configuration/
https://service-lightning.services.rehive.io/api/admin/company/configuration/


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "opennode_api_key": "string"

}


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

{
 * "id": 0,
 * "opennode_api_key": "string",
 * "created": "2021-09-03T14:22:26Z",
 * "updated": "2021-09-03T14:22:26Z"

}


ADMIN_COMPANY_CONFIGURATION_PARTIAL_UPDATE

Service configurable variables specific to the company

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



opennode_api_key
string (Opennode api key) [ 1 .. 200 ] characters Nullable



RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

id
integer (ID)

opennode_api_key
string (Opennode api key) [ 1 .. 200 ] characters Nullable

created
string <date-time> (Created)

updated
string <date-time> (Updated)


patch /admin/company/configuration/
https://service-lightning.services.rehive.io/api/admin/company/configuration/


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "opennode_api_key": "string"

}


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

{
 * "id": 0,
 * "opennode_api_key": "string",
 * "created": "2021-09-03T14:22:26Z",
 * "updated": "2021-09-03T14:22:26Z"

}


ADMIN_HOTWALLET_ACTIVE_LIST

AUTHORIZATIONS:

Bearer


RESPONSES

200
get /admin/hotwallet/active/
https://service-lightning.services.rehive.io/api/admin/hotwallet/active/


ADMIN_HOTWALLET_FUND_LIST

AUTHORIZATIONS:

Bearer


RESPONSES

200
get /admin/hotwallet/fund/
https://service-lightning.services.rehive.io/api/admin/hotwallet/fund/


ADMIN_WITHDRAWALS_LIST

AUTHORIZATIONS:

Bearer


RESPONSES

200

RESPONSE SCHEMA: APPLICATION/JSON

Array

id
string <uuid> (Id)

amount
integer (Amount)

invoice
string (Invoice) non-empty

invoice_expiry
string (Invoice expiry)

status
string (Status) non-empty

created
string (Created)

updated
string (Updated)



get /admin/withdrawals/
https://service-lightning.services.rehive.io/api/admin/withdrawals/


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

[
 * 
   {
    * "id": "string",
    * "amount": 0,
    * "invoice": "string",
    * "invoice_expiry": "string",
    * "status": "string",
    * "created": "string",
    * "updated": "string"
   
   }

]


DEACTIVATE


DEACTIVATE_CREATE

Dectivate a company in the service-lightning.

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



token
required
string (Token) non-empty



RESPONSES

201

RESPONSE SCHEMA: APPLICATION/JSON

token
required
string (Token) non-empty


post /deactivate/
https://service-lightning.services.rehive.io/api/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_OPENNODE_CHARGE_CREATE

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

charge_id
required
string



RESPONSES

201
post /hooks/opennode/charge/{charge_id}/
https://service-lightning.services.rehive.io/api/hooks/opennode/charge/{charge_id}/


HOOKS_OPENNODE_WITHDRAWAL_CREATE

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

withdrawal_id
required
string



RESPONSES

201
post /hooks/opennode/withdrawal/{withdrawal_id}/
https://service-lightning.services.rehive.io/api/hooks/opennode/withdrawal/{withdrawal_id}/


WITHDRAWALS


WITHDRAWALS_LIST

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

RESPONSE SCHEMA: APPLICATION/JSON

count
required
integer

next
string <uri> Nullable

previous
string <uri> Nullable

results
required
Array of object (ListWithdrawal)


get /withdrawals/
https://service-lightning.services.rehive.io/api/withdrawals/


RESPONSE SAMPLES

 * 200

application/json
Copy
Expand all Collapse all

{
 * "count": 0,
 * "next": "http://example.com",
 * "previous": "http://example.com",
 * "results":
   
   [
    * 
      {
       * "id": "string",
       * "amount": 0,
       * "invoice": "string",
       * "invoice_expiry": "string",
       * "status": "string",
       * "created": "string",
       * "updated": "string"
      
      }
   
   ]

}


WITHDRAWALS_CREATE

AUTHORIZATIONS:

Bearer

REQUEST BODY SCHEMA: APPLICATION/JSON



amount
string <decimal> (Amount)

invoice
required
string (Invoice) [ 1 .. 500 ] characters



RESPONSES

201

RESPONSE SCHEMA: APPLICATION/JSON

id
integer (ID)

amount
string <decimal> (Amount)

reference
string (Reference) non-empty

status
string (Status)
Enum:"initiated" "unfunded" "reprocess" "funded" "queued" "pending" "confirmed"
"complete" "failed" "cancelled"

created
string <date-time> (Created)

updated
string <date-time> (Updated)

invoice
required
string (Invoice) [ 1 .. 500 ] characters

lightning_provider_error
string (Lightning provider error) non-empty

invoice_description
string (Invoice description) non-empty


post /withdrawals/
https://service-lightning.services.rehive.io/api/withdrawals/


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "amount": "string",
 * "invoice": "string"

}


RESPONSE SAMPLES

 * 201

application/json
Copy
Expand all Collapse all

{
 * "id": 0,
 * "amount": "string",
 * "reference": "string",
 * "status": "initiated",
 * "created": "2021-09-03T14:22:26Z",
 * "updated": "2021-09-03T14:22:26Z",
 * "invoice": "string",
 * "lightning_provider_error": "string",
 * "invoice_description": "string"

}