Balance summary

Returns balance summary, optionally scoped by business.

Access tierbusiness_financeRate limit60/minIdempotencynoneAuthenticationBearerAuth

SourceLuxApi/app/Http/Controllers/Api/ReportApiController.php::summaryLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader

stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...

business_idquery

integerOptional

Code examples

The displayed sandbox host is a placeholder until an official host is provisioned. Never paste a production token into a public browser.

curl --request GET \
  --url 'https://sandbox-api.luxpay.example/v1/reports/summary' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

Responses

200Successful response.

status

boolean

Example: true

data

object

{
  "status": true,
  "data": {}
}

400

401

403

404

409

422

429

500

OpenAPI JSON OpenAPI YAML Postman collection