For AI agents: visit https://developer.mxmerchant.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

API Guides API Reference MXM Support System Status API Support

Home API Guides API Reference Changelog

API Guides API Reference MXM Support System Status API Support

API Guides

Home API Guides API Reference Changelog

Getting Started

Welcome to the Checkout API
Get Started with MX Merchant
Create a Merchant Account
Transitioning to Production
Credentials
WooCommerce Plugin
Supported Hardware
Glossary
Code Samples
Quick Pay
Dashboard
Settings
- Invoices

Checkout

General
- Supported Tender Types
- Test Cards
Customers
Vaulted Cards
- Saving Cards on File
Payments
Authorizations and Tips
Refunds
- Making a Partial Refund
- Making a Full Refund or Void a Transaction
Receipts
- Sending Receipts
Batches
- How to Settle a Batch
BIN Lookup
- BIN Information

MX Merchant Marketplace Apps

MX Retail
MX Merchant Marketplace Apps

MX Merchant Account

Notifications
Notification Examples
Custom Payment Pages

MX Merchant Videos

Checkout
Customer
Terminal
Invoice
- MX™ Merchant API Tutorial - Create, Get, and Send an Invoice

Responses

API Rate Limits
API Error Messages
HTTP Response Codes
API Authorization Code Messages

Powered by

Customer Addresses

The customer address can be used to store billing and shipping addresses. Each customer can have multiple addresses associated with them.