Transaction Alert Settings

Get transaction alert settings

get

Retrieve the current transaction alert settings configured for a merchant.

Responses

200

ok

application/jsonapplication/xml

Transaction alert configuration details.

payloadTypestringOptional

Type of payload returned.

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

get/rest/v2/settings/merchant/transaction-alert

HTTPcURLJavaScriptPython

GET /rest/v2/settings/merchant/transaction-alert HTTP/1.1
Accept: */*

{
  "alert-settings": {
    "merchantId": "text",
    "terminalId": "text",
    "emails": "text",
    "callbackUrl": "text"
  },
  "payloadType": "text"
}

Create transaction alert settings

post

Create a transaction alert controller settings for a merchant.

Body

application/json

merchantIdstringOptional

Merchant identifier associated with the alert settings.

terminalIdstringOptional

Terminal identifier associated with the alert settings.

emailsstringOptional

Email address to receive transaction alerts.

callbackUrlstringOptional

URL to which transaction result notifications are sent.

Responses

200

ok

application/jsonapplication/xml

Transaction alert configuration details.

payloadTypestringOptional

Type of payload returned.

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

post/rest/v2/settings/merchant/transaction-alert

HTTPcURLJavaScriptPython

POST /rest/v2/settings/merchant/transaction-alert HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "merchantId": "text",
  "terminalId": "text",
  "emails": "text",
  "callbackUrl": "text"
}

{
  "alert-settings": {
    "merchantId": "text",
    "terminalId": "text",
    "emails": "text",
    "callbackUrl": "text"
  },
  "payloadType": "text"
}

Delete transaction alert settings

delete

Delete the current transaction alert settings configured for a merchant.

Responses

200

ok

application/jsonapplication/xml

Transaction alert configuration details.

payloadTypestringOptional

Type of payload returned.

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

500

Server error

application/jsonapplication/xml

delete/rest/v2/settings/merchant/transaction-alert

HTTPcURLJavaScriptPython

DELETE /rest/v2/settings/merchant/transaction-alert HTTP/1.1
Accept: */*

{
  "alert-settings": {
    "merchantId": "text",
    "terminalId": "text",
    "emails": "text",
    "callbackUrl": "text"
  },
  "payloadType": "text"
}