Back to reference
POST/payment-services/{provider}/select
Payment services

Select payment service

Evaluates provider selection and returns the next action for the client.

Access tierauthenticatedRate limitpay_apiIdempotencynoneAuthenticationBearerAuth
SourceLuxApi/Modules/PayAPI/Controllers/PaymentServiceController.php::selectLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader
stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...
providerpath
stringRequired

Provider code registered by LuxPay.

Example: wallet

Request body

PaymentServiceSelectionRequestRequired
amount
number | null
currency
string | null
payment_method
string | null
payment_channel
string | null
customer
object | null
metadata
object | null

JSON example

{
  "amount": 1,
  "currency": "string",
  "payment_method": "string",
  "payment_channel": "string",
  "customer": {},
  "metadata": {}
}

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/payment-services/wallet/select' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 1,
  "currency": "string",
  "payment_method": "string",
  "payment_channel": "string",
  "customer": {},
  "metadata": {}
}'

Responses

200Successful response.
success
boolean
Example: true
data
object
{
  "success": true,
  "data": {
    "service": {
      "provider": "wallet",
      "display_name": "LuxPay Wallet",
      "enabled": true,
      "can_select": true,
      "currencies": [
        "string"
      ],
      "methods": [
        "string"
      ],
      "channels": [
        "string"
      ]
    },
    "next_action": {},
    "trace_id": "string"
  }
}
400
401
403
404
409
422
429
500
OpenAPI JSONOpenAPI YAMLPostman collection