Skip to content

Get host URL settings

Request

This endpoint retrieves specific host URL settings for a point of sale device by URL type.

Path
pointOfSaleIdinteger, (int64)required

The unique system identifier for the point of sale device.

Example:123465789
urlTypestringrequired

The type of URL (e.g., Transaction, StoreAndForward, InStoreNotification).

Enum:"Transaction""StoreAndForward""InStoreNotification""DCC"
Example:Transaction
curl -i -X GET \
  https://api-services.pxp.io/api/v1/point-of-sales/123465789/Transaction/host-url-settings

Responses

Successfully retrieved the host URL settings.

Bodyapplication/json
urlstring or null
Example:"https://transaction.example.com"
urlTypestring

The type of URL.

Enum:"Transaction""StoreAndForward""InStoreNotification""DCC"
Example:"Transaction"
Response
{ "url": "https://transaction.example.com", "urlType": "Transaction" }