Skip to content
/
Get company profile

Lumo B2B Platform API (1.0.0)

API reference for company-facing endpoints of Lumo B2B platform.

Scope of this reference:

  • Company auth/profile
  • Orders (prepare/accept/list/get)
  • Company disputes
  • Company wallet + deposits
  • User wallets (per externalId) + user deposits

Not included:

  • Admin endpoints
Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://b2b-app.lumowallet.io/_mock/apis
Production
https://b2b.lumowallet.io
Staging
https://b2b-staging.lumowallet.io

Company Auth

Company registration, login, and profile management.

Operations

Company login

Request

Authenticates company by email/password and rotates API key. Previous key becomes invalid after successful login.

Bodyapplication/jsonrequired
emailstring(email)required
passwordstringrequired
curl -i -X POST \
  https://b2b-app.lumowallet.io/_mock/apis/auth/company/login \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "[email protected]",
    "password": "string"
  }'

Responses

Logged in, fresh API key issued

Bodyapplication/json
companyobject(CompanyInfo)required
company.​idstring(uuid)required
company.​namestringrequired
company.​emailstring(email)required
apiKeystringrequired

Save securely; used for company API auth.

Example: "lb2b_5f7f1f7b7f034dbf81b0b8b8d7c0b9f1"
Response
application/json
{
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "email": "[email protected]"
  },
  "apiKey": "lb2b_5f7f1f7b7f034dbf81b0b8b8d7c0b9f1"
}

Get company profile

Request

Security
apiKeyAuth
curl -i -X GET \
  https://b2b-app.lumowallet.io/_mock/apis/auth/company/profile \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Company profile

Bodyapplication/json
idstring(uuid)required
namestringrequired
emailstring(email)required
contactEmailstring or null(email)
contactTelegramstring or null
isActivebooleanrequired
webhookUrlstring or null
depositForwardAddressstring or null

TRON address where captured deposits are forwarded after fee is charged

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "email": "[email protected]",
  "contactEmail": "[email protected]",
  "contactTelegram": "string",
  "isActive": true,
  "webhookUrl": "string",
  "depositForwardAddress": "string"
}

Update company profile

Request

Security
apiKeyAuth
Bodyapplication/jsonrequired
webhookUrlstring(uri)
Example: "https://merchant.example.com/webhooks/lumo"
depositForwardAddressstring

TRON address where captured deposits are forwarded

Example: "TQ2x4..."
curl -i -X PATCH \
  https://b2b-app.lumowallet.io/_mock/apis/auth/company/profile \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "webhookUrl": "https://merchant.example.com/webhooks/lumo",
    "depositForwardAddress": "TQ2x4..."
  }'

Responses

Updated company profile

Bodyapplication/json
idstring(uuid)required
namestringrequired
emailstring(email)required
contactEmailstring or null(email)
contactTelegramstring or null
isActivebooleanrequired
webhookUrlstring or null
depositForwardAddressstring or null

TRON address where captured deposits are forwarded after fee is charged

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "email": "[email protected]",
  "contactEmail": "[email protected]",
  "contactTelegram": "string",
  "isActive": true,
  "webhookUrl": "string",
  "depositForwardAddress": "string"
}

Regenerate company API key

Request

Rotates and returns a new API key for current company.

Security
apiKeyAuth
curl -i -X POST \
  https://b2b-app.lumowallet.io/_mock/apis/auth/company/regenerate-key \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

New API key issued

Bodyapplication/json
companyobject(CompanyInfo)required
company.​idstring(uuid)required
company.​namestringrequired
company.​emailstring(email)required
apiKeystringrequired

Save securely; used for company API auth.

Example: "lb2b_5f7f1f7b7f034dbf81b0b8b8d7c0b9f1"
Response
application/json
{
  "company": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "email": "[email protected]"
  },
  "apiKey": "lb2b_5f7f1f7b7f034dbf81b0b8b8d7c0b9f1"
}

Orders

Quote preparation and order lifecycle operations.

Operations

Disputes

Company dispute creation and listing.

Operations

Company Wallet

Company deposit wallet, balances, and deposit history.

Operations

User Wallets

Per-user wallet management and user deposit history.

Operations