RPS Settings

Get RPS Settings

get

Retrieve the RPS configuration for a terminal, including whether recurring payments are enabled.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

Contains the response data for the terminal's RPS configuration.

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: rps-settings

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/settings/terminal/rps

HTTPcURLJavaScriptPython

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

{
  "rps-settings": {
    "enabled": true
  },
  "payloadType": "rps-settings"
}

Create RPS Settings

post

Create the Recurring Payment Service (RPS) configuration for a terminal by enabling or disabling recurring payments.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains Recurring Payment Service configuration for the terminal.

enabledboolean · enumOptional

Indicates whether the Recurring Payment Service (RPS) is enabled for the terminal.

Example: truePossible values:

Responses

200

ok

application/jsonapplication/xml

Contains the response data for the terminal's RPS configuration.

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: rps-settings

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/settings/terminal/rps

HTTPcURLJavaScriptPython

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

{
  "enabled": true
}

{
  "rps-settings": {
    "enabled": true
  },
  "payloadType": "rps-settings"
}

Update RPS Settings

put

Update the Recurring Payment Service (RPS) configuration for a terminal by enabling or disabling recurring payments.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains Recurring Payment Service configuration for the terminal.

enabledboolean · enumOptional

Indicates whether the Recurring Payment Service (RPS) is enabled for the terminal.

Example: truePossible values:

Responses

200

ok

application/jsonapplication/xml

Contains the response data for the terminal's RPS configuration.

payloadTypestringOptional

Indicates the type of payload returned in the response.

Example: rps-settings

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

put

/rest/v2/settings/terminal/rps

HTTPcURLJavaScriptPython

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

{
  "enabled": true
}

{
  "rps-settings": {
    "enabled": true
  },
  "payloadType": "rps-settings"
}