Error

A valid request URL is required to generate request examples

{
  "provider": "stripe",
  "enabled": true,
  "configured": true,
  "availableProviders": [
    "mock",
    "adyen",
    "stripe"
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Devices

Get the active card-terminal provider

Reports which payment-service provider the network resolves to right now and how ready it is. Read this BEFORE runPaymentTerminalTest — it is the safe way to answer ‘is the card terminal set up’ without commanding any hardware. provider is the operator’s selection (the psp.provider network setting) falling back to the deployment default and finally to mock. enabled is the psp.enabled toggle, which DEFAULTS to true for any non-mock selection — it is not proof an operator opted in. configured means only that the provider’s credentials are present in the server environment; it says nothing about a physical reader being reachable, and it is always true for mock. So provider: "mock", configured: true means ‘wired to an in-memory fake’, NOT ‘ready to take cards’. availableProviders is the full selectable menu. No secret is ever returned. Credentials live only in the server environment — there is no API to set them.

GET

payment-terminal

config

Error

A valid request URL is required to generate request examples

{
  "provider": "stripe",
  "enabled": true,
  "configured": true,
  "availableProviders": [
    "mock",
    "adyen",
    "stripe"
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Response

The resolved provider plus its enabled/configured flags and the full menu.

provider

enum<string>

required

Available options:

mock,

adyen,

stripe

enabled

boolean

required

configured

boolean

required

availableProviders

enum<string>[]

required

Available options:

mock,

adyen,

stripe

Record an age-verification attestation Run the card-terminal round-trip self-test

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

Get the active card-terminal provider

Authorizations

Response