v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create Notification

put/v3/subscription

Query parameters

echoboolean

Request body

eventTypestring required

Values: Chargeback, Deposit, PaymentSuccess, PaymentFail, UpcomingSAQExpiration, RefundCreated, NewStatement, BatchClosed, ExpiredCard

merchantIdinteger required

Merchant Id

sendEmailboolean required

Send email notification

emailAddressstring

Email address to send email notification to

sendSMSboolean required

Send text message notification

phoneNumberstring

Phone number to send SMS notification to

sendWebhookboolean required

Send webhook notification

callbackUrlstring

URL to send webhook notification to

thresholdinteger

Thresholds are required for SAQ expiration and any notification related to dollar amounts.

sourcesstring

Comma separated list of sources from which to be notified for payments and refunds. This can be QuickPay, Invoice, Recurring, Order, MXExpress, MXRetail, API, and/or Link2Pay.

inviteUsersstring required

Comma separated list of roles from which to be notified by browser alerts. This can be Administrator, FullAccess, Supervisor, Clerk, ReadOnly. (Can be sent as an empty string)

Response

200

idinteger

eventTypestring

merchantIdinteger

createdstring

modifiedstring

phoneNumberstring

thresholdinteger

sendEmailboolean

sendSMSboolean

sendWebhookboolean

Sourcesstring

Example response

{
  "id": 411,
  "eventType": "PaymentSuccess",
  "merchantId": 110070419,
  "created": "2018-03-20T21:10:12.54Z",
  "modified": "2018-03-20T21:10:12.54Z",
  "phoneNumber": "8662102157",
  "threshold": 10,
  "sendSMS": true,
  "Sources": "API"
}