Report Settings

Get Report Settings

get

Retrieve the report settings for the terminal's last closed batch.

Query parameters

typestring · enumOptional

The type of report settings. Available value is LAST_CLOSED_BATCH.

Possible values:

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: report-settings

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

get

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

GET /rest/v2/settings/terminal/report HTTP/1.1
api-key: text
Accept: */*

{
  "report-settings": {
    "report-time": "09:51:00",
    "enabled": true,
    "type": "LAST_CLOSED_BATCH",
    "emails": {
      "email": [
        {
          "address": "[email protected]"
        }
      ]
    }
  },
  "payloadType": "report-settings"
}

Create Report Settings

post

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

report settings

report-timestringRequired

Time of day when the report should be generated and sent in the HH:mm:ss format

Example: 09:51:00

enabledboolean · enumRequired

Indicates whether the report setting is active.

Example: truePossible values:

typestring · enumRequired

Type of report to be generated.

Example: LAST_CLOSED_BATCHPossible values:

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: report-settings

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

post

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

POST /rest/v2/settings/terminal/report HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "report-time": "09:51:00",
  "enabled": true,
  "type": "LAST_CLOSED_BATCH",
  "emails": {
    "email": [
      {
        "address": "[email protected]"
      }
    ]
  }
}

{
  "report-settings": {
    "report-time": "09:51:00",
    "enabled": true,
    "type": "LAST_CLOSED_BATCH",
    "emails": {
      "email": [
        {
          "address": "[email protected]"
        }
      ]
    }
  },
  "payloadType": "report-settings"
}

Update Report Settings

put

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

report settings

report-timestringRequired

Time of day when the report should be generated and sent in the HH:mm:ss format

Example: 09:51:00

enabledboolean · enumRequired

Indicates whether the report setting is active.

Example: truePossible values:

typestring · enumRequired

Type of report to be generated.

Example: LAST_CLOSED_BATCHPossible values:

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: report-settings

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

put

/rest/v2/settings/terminal/report

HTTPcURLJavaScriptPython

PUT /rest/v2/settings/terminal/report HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "report-time": "09:51:00",
  "enabled": true,
  "type": "LAST_CLOSED_BATCH",
  "emails": {
    "email": [
      {
        "address": "[email protected]"
      }
    ]
  }
}

{
  "report-settings": {
    "report-time": "09:51:00",
    "enabled": true,
    "type": "LAST_CLOSED_BATCH",
    "emails": {
      "email": [
        {
          "address": "[email protected]"
        }
      ]
    }
  },
  "payloadType": "report-settings"
}