Skip to content

Update host URL settings

Request

This endpoint updates 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:123456789
urlTypestringrequired

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

Enum:"Transaction""StoreAndForward""InStoreNotification""DCC"
Example:Transaction
Bodyapplication/jsonrequired

The updated host URL settings.

urlstring or null
Example:"https://transaction.example.com"
curl -i -X PUT \
  https://api-services.pxp.io/api/v1/point-of-sales/123456789/Transaction/host-url-settings \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://transaction.example.com"
  }'

Responses

Successfully updated the host URL settings.