API GuidesAPI ReferenceMXM SupportSystem StatusAPI Support
API Reference

Create Notification

put
https://sandbox.api.mxmerchant.com/checkout/v3/subscription
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦

šŸ“˜

Link2Pay

For notifications from Link2Pay sources, add a dash and the name of the payment link after Link2Pay in the sources field, i.e. Link2Pay - Example Payment Link.

šŸ“˜

Want to see some example responses?

Click here to go to the notifications documentation section where we have examples for each notification type.

Query Params
boolean
Defaults to false
Body Params
string
required

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

int32
required

Merchant Id

boolean
required

Send email notification

string

Email address to send email notification to

boolean
required

Send text message notification

string

Phone number to send SMS notification to

boolean
required

Send webhook notification

string

URL to send webhook notification to

int32

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

string

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.

string
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)

Responses

Updated about 7 years ago

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

Updated about 7 years ago