Choose the Documentation MX Merchant MX Connect
MX-Merchant-Documentation
šŸŸ¢ MX Merchant MX Connect
Home Release Notes Documentation API Guide API Tryout
MX-Connect-Documentation
MX Merchant šŸŸ¢ MX Connect
Home Release Notes Documentation API Guide API Tryout
API Reference
  1. ACCEPT PAYMENTS
  2. Subscription

Register a Webhook Subscription

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

Register a webhook subscription to receive real-time event notifications at your specified callback URL.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Query Params
boolean
Defaults to false

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

Body Params

Event Subscription

string
enum
required

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

int32

Merchant identifier associated with this notification

string

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

string

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

string

Phone number that will receive SMS notifications

int64

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

boolean

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

boolean

Enables SMS notifications for this event

boolean

Enables webhook notifications for this event

boolean

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

string

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

string

Web push notification URL

boolean

Enables web push notifications

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

Updated 9 days ago

Language
Credentials
Header
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago