Back to reference
GET/payment-services
Payment services

List payment services

Lists enabled payment services, optionally filtered by currency and method.

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

Parameters

X-Request-IDheader
stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...
currencyquery
stringOptional

ISO 4217 currency code.

Example: YER
methodquery
stringOptional

Payment method filter.

Example: wallet

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/payment-services' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

Responses

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