Customer login

Authenticates a wallet customer by phone and password and returns a bearer token.

Access tierpublicRate limitpay_apiIdempotencynoneAuthenticationPublic

SourceLuxApi/Modules/LuxPayIdentity/Http/Controllers/Api/UserAuthController.php::customerLoginLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader

stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...

Request body

CustomerLoginRequestRequired

phone

string

Example: +9677XXXXXXX

password

string

JSON example

{
  "phone": "+9677XXXXXXX",
  "password": "string"
}

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 POST \
  --url 'https://sandbox-api.luxpay.example/v1/auth/customer/login' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "+9677XXXXXXX",
  "password": "string"
}'

Responses

200Successful response.

success

boolean

Example: true

message

string | null

token

string

customer

Customer

{
  "success": true,
  "message": "string",
  "token": "string",
  "customer": {
    "id": 1,
    "full_name": "string",
    "phone": "string"
  }
}

400

401

403

404

409

422

429

500

OpenAPI JSON OpenAPI YAML Postman collection