PayLink Settings

Get PayLink Settings

get

Retrieve the paylink configuration settings for a terminal, including enablement status and redirect URLs.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: paylink

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

get

/rest/v2/settings/terminal/paylink

HTTPcURLJavaScriptPython

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

{
  "paylink": {
    "terminalId": 10018001,
    "enabled": true,
    "metadata": {
      "additionalProp1": "String",
      "additionalProp2": "String",
      "additionalProp3": "String"
    },
    "success-url": "https://example.com/paylink/success",
    "cancel-url": "https://example.com/paylink/cancel"
  },
  "payloadType": "paylink"
}

Create PayLink Settings

post

Create a paylink settings for a terminal by enabling or configuring paylink payment options.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains the paylink configuration settings for the terminal.

terminalIdinteger · int64Required

Identifier for the terminal associated with the Paylink settings.

Example: 10018001

enabledboolean · enumRequired

Indicates whether Paylink settings are enabled (true) or disabled (false).

Example: truePossible values:

success-urlstringRequired

URL to redirect the user after a successful payment.

Example: https://example.com/paylink/success

cancel-urlstringRequired

URL to redirect the user if the payment is canceled.

Example: https://example.com/paylink/cancel

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: paylink

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

post

/rest/v2/settings/terminal/paylink

HTTPcURLJavaScriptPython

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

{
  "terminalId": 10018001,
  "enabled": true,
  "metadata": {
    "additionalProp1": "String",
    "additionalProp2": "String",
    "additionalProp3": "String"
  },
  "success-url": "https://example.com/paylink/success",
  "cancel-url": "https://example.com/paylink/cancel"
}

{
  "paylink": {
    "terminalId": 10018001,
    "enabled": true,
    "metadata": {
      "additionalProp1": "String",
      "additionalProp2": "String",
      "additionalProp3": "String"
    },
    "success-url": "https://example.com/paylink/success",
    "cancel-url": "https://example.com/paylink/cancel"
  },
  "payloadType": "paylink"
}

Update PayLink Settings

put

Update the Paylink settings for a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Body

application/json

Contains the paylink configuration settings for the terminal.

terminalIdinteger · int64Required

Identifier for the terminal associated with the Paylink settings.

Example: 10018001

enabledboolean · enumRequired

Indicates whether Paylink settings are enabled (true) or disabled (false).

Example: truePossible values:

success-urlstringRequired

URL to redirect the user after a successful payment.

Example: https://example.com/paylink/success

cancel-urlstringRequired

URL to redirect the user if the payment is canceled.

Example: https://example.com/paylink/cancel

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: paylink

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not Found

application/jsonapplication/xml

put

/rest/v2/settings/terminal/paylink

HTTPcURLJavaScriptPython

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

{
  "terminalId": 10018001,
  "enabled": true,
  "metadata": {
    "additionalProp1": "String",
    "additionalProp2": "String",
    "additionalProp3": "String"
  },
  "success-url": "https://example.com/paylink/success",
  "cancel-url": "https://example.com/paylink/cancel"
}

{
  "paylink": {
    "terminalId": 10018001,
    "enabled": true,
    "metadata": {
      "additionalProp1": "String",
      "additionalProp2": "String",
      "additionalProp3": "String"
    },
    "success-url": "https://example.com/paylink/success",
    "cancel-url": "https://example.com/paylink/cancel"
  },
  "payloadType": "paylink"
}

Delete PayLink Settings

delete

Delete the paylink settings configured for a terminal.

Header parameters

api-keystringRequired

An access API key issued to you by Xplor Pay.

Responses

200

ok

application/jsonapplication/xml

payload

payloadTypestringOptional

Type of payload returned in the response.

Example: paylink

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

delete

/rest/v2/settings/terminal/paylink

HTTPcURLJavaScriptPython

DELETE /rest/v2/settings/terminal/paylink HTTP/1.1
api-key: text
Accept: */*

{
  "paylink": {
    "terminalId": 10018001,
    "enabled": true,
    "metadata": {
      "additionalProp1": "String",
      "additionalProp2": "String",
      "additionalProp3": "String"
    },
    "success-url": "https://example.com/paylink/success",
    "cancel-url": "https://example.com/paylink/cancel"
  },
  "payloadType": "paylink"
}