Hold wallet funds

Creates a temporary hold against wallet funds.

Access tierbusiness_operatorRate limit20/minIdempotencynoneAuthenticationBearerAuth

SourceLuxApi/app/Http/Controllers/Api/WalletApiController.php::holdLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader

stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...

Request body

CreateHoldRequestRequired

wallet_id

integer

amount

number

currency_code

string

reason

string | null

expiry_minutes

integer | null

JSON example

{
  "wallet_id": 1,
  "amount": 1,
  "currency_code": "string",
  "reason": "string",
  "expiry_minutes": 1
}

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/wallets/hold' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "wallet_id": 1,
  "amount": 1,
  "currency_code": "string",
  "reason": "string",
  "expiry_minutes": 1
}'

Responses

200Successful response.

status

boolean

Example: true

message

string | null

data

Hold

{
  "status": true,
  "message": "string",
  "data": {
    "uuid": "00000000-0000-4000-8000-000000000001",
    "wallet_id": 1,
    "amount": 1,
    "currency_code": "string",
    "status": "active",
    "reason": "string",
    "expires_at": "2026-07-16T12:00:00Z"
  }
}

400

401

403

404

409

422

429

500

OpenAPI JSON OpenAPI YAML Postman collection