Register a Webhook Subscription

put

https://sandbox-api.prioritycommerce.com/v1/checkout/v3/subscription

Update an existing subscription record.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

echo

boolean

Defaults to false

If true, the API will echo the full payment resource in the response body

Body Params

Event Subscription

eventType

string

enum

required

Type of event that triggers the notification
Values: DeclineThresholdExceeded, DeclineThresholdWarning, PaymentFail, PaymentSuccess, RefundCreated, Chargeback, Deposit, BatchClosed, OpenBatchAlert, NewStatement, ExpiredCard, UpcomingSAQExpiration

merchantId

int32

Merchant identifier associated with this notification

callbackUrl

string

The secure HTTPS URL where the event payload will be sent. Required if sendWebhook is true.

emailAddress

string

The email address where you want to receive the email notification if sendEmail is set as true

phoneNumber

string

Phone number that will receive SMS notifications

threshold

int64

The numeric threshold that triggers the event. Thresholds are required for SAQ expiration and any notification related to dollar amounts.

sendEmail

boolean

Must be set as true to enable email notifications.Default is false

sendSMS

boolean

Enables SMS notifications for this event

sendWebhook

boolean

Enables webhook notifications for this event

sendToFeed

boolean

Must be set as true to post the alert in the merchant's activity feed within Mx Merchant Portal. Default is false

Sources

string

Comma-separated list of sources from which notifications are allowed
Values: QuickPay ,Customer ,Invoice ,Recurring ,Order ,MXExpress ,MXRetail ,API ,Terminal ,Rekey

webPush

string

Web push notification URL

sendToWebPush

boolean

Enables web push notifications

inviteUsers

string

A comma-separated list of roles from which to be notified by browser alerts.
Can be an empty string ("") if other notification types except sendWebhook are disabled. This field acts as a safeguard, ensuring future notifications are not sent to unintended recipients.
Values: Administrator ,FullAccess ,Supervisor ,Clerk ,ReadOnly

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The entity has been created successfully.

400The request could not be accepted by the MXM server due to a malformed syntax, which may be a missing required parameter or other syntactical error.

401The request could not be authenticated. The API key or access token may be missing, invalid, or expired.

403The authenticated user does not have permission to perform this action on the requested resource.

422The MXM server understood the request but was unable to process it due to semantic errors or invalid field values in the request body.

500An unexpected error occurred on the MXM server. If the issue persists, please contact support.

503The MXM server is temporarily unable to handle the request. Please retry after a short delay.