Jump to Content
MX™ MerchantAPI GuidesAPI ReferenceMXM SupportSystem StatusAPI Support
HomeAPI GuidesAPI ReferenceChangelog
API GuidesAPI ReferenceMXM SupportSystem StatusAPI SupportMX™ Merchant
API Reference
HomeAPI GuidesAPI ReferenceChangelog

Checkout API

  • Checkout API Overview
  • Authentication
    • Basic
    • OAuth 1.0a
  • XML | JSON
  • Validation
  • Payments
    • Payment Overview
    • Make a Paymentpost
    • Get Paymentsget
    • Get a Paymentget
    • Void a Paymentdelete
    • Send a Payment Receiptpost
  • Recurring Payments
    • Recurring Payment Overview
    • Create Contractpost
    • Update Contractput
    • Get a Contractget
    • Cancel a Contractdelete
    • Get a Contract's Paymentsget
    • Get a Contract Subscriptionget
    • Get a Contract's Historyget
  • Batches
    • Batches Overview
    • Get Batchesget
    • Get a Batchget
    • Get a Batch's transactionsget
    • Close a Batchput
  • Customers
    • Customers Overview
    • Create customerpost
    • Get customersget
    • Get a customerget
    • Update customerput
    • Create a customer's addresspost
    • Get a customer's addressget
    • Update a customer's addressput
    • Add a Customer Photopost
    • Add a Customer Notepost
    • Get a Customer Noteget
    • Get Customer Paymentsget
    • Create Custom Fields for Customerspost
    • Get Custom Fields for a Customersget
    • Delete custom fields for customersdelete
  • Vaulted Accounts
    • Vaulted Accounts Overview
    • Create vaulted card accountpost
    • Update a vaulted card accountput
    • Get a customer's vaulted card account(s)get
    • Delete a customer's vaulted card account(s)delete
    • Create vaulted bank accountpost
    • Update a vaulted bank accountput
    • Get a vaulted bank accountget
    • Delete a vaulted bank accountdelete
  • MX Merchant Reports
    • MX Merchant Reports Overview
    • Get Deposits Reportget
    • Get Settlement Reportget
    • Get Settlement Transaction Detail Reportget
    • Get Chargebacks Reportget
    • Get Expired Cards Reportget
    • Get User Sales Reportget
    • Get User Sales Summary Reportget
    • Get ACH Activity Reportget
    • Get ACH Returns Reportget
    • Get Statement Reportget
    • Get API Traffic Reportget
  • Notifications
    • Notifications Overview
    • Get Notificationsget
    • Create Notificationput
    • Get Event Types and Threshold Valuesget
  • Limited Use Tokens
    • Limit Use Tokens Overview
    • Get a tokenpost
    • Make a payment with tokenpost
    • Create customer/vaulted card with tokenpost
    • Create vaulted card on existing customer with tokenpost
  • Merchant Account
    • Merchant Account Overview
    • Get List of Merchantsget
    • Get Merchant Details & Settingsget
    • Get Merchant Settingsget
    • Update Merchant Settingsput
    • Get Accounts (Team Members)get
    • Create Account (Team Member)post
    • Update Account (Team Member)put
    • Delete Account (Team Member)delete
    • Add a Account Photo (Team Member)post
    • Create API Keyspost
    • Get API Keysget

Report API

  • Report API Overview
  • FirstData Reports
    • FirstData ACH Reportget
    • FirstData Batch Reportget
    • FirstData Batch Transactions Reportget
    • FirstData Disputes Reportget
    • FirstData Transactions Reportget
  • TSYS Reports
    • TSYS ACH Reportget
    • TSYS Batch Reportget
    • TSYS Batch Transaction Reportget
    • TSYS Disputes Reportget
    • TSYS Transactions Reportget

Merchant API

  • Merchant API Overview
  • BIN
    • Get BIN (Bank Identification Number) Informationget

Security API

  • Security API Overview
  • Authentication using JWT
    • Getting JWT using Username/Passwordget
    • Getting JWT using Consumer/Secret Keysget

Terminal API

  • Terminal Overview
  • Terminal
    • Get List of Terminalsget
    • Create Terminalpost
    • Create Terminal - AnywhereCommercepost
    • Create Terminal - Dejavoopost
    • Delete Terminaldelete
  • Transaction
    • Terminal Transaction - Createpost
    • Terminal Transaction - Updatepost
    • Terminal Transaction - Getget
    • Terminal Transaction - Delete Queued by Terminaldelete

MX Merchant Retail Apps

  • MX Advantage
    • Get Surchargepost
    • Make a Payment with Surchargepost
  • MX Invoice
    • Create Invoicepost
    • Get Invoicesget
    • Get an Invoiceget
    • Update Invoiceput
    • Send Invoice Receiptpost
    • Get Invoice Receiptget
    • Add Invoice Paymentpost
    • Get Invoice Paymentget
    • Create an Invoice Returnpost
    • Get Invoice Returnsget
    • Get Invoice Returns by IDget
    • Get Invoice Historyget
    • Create a Notepost
    • Get Invoice Notesget
    • Get an Invoice Noteget
    • Invoice Exportget
    • Get Discountget
    • Get an Discountget
  • MX Retail
    • Get Catalog IDget
    • MX Retail - Products
    • Create a Productpost
    • Get Productsget
    • Get a Productget
    • Delete a Productdelete
    • Add Product Imagepost
    • Get Product Imageget
    • MX Retail - Variants
    • Create Variantpost
    • Get Variantsget
    • Get a Variantget
    • Update Variantput
    • Delete Variantdelete
    • Add Variant Imagepost
    • Get Variant Imageget
    • MX Retail - Collections
    • Create Collectionpost
    • Get Collectionsget
    • Get a Collectionget
    • Update Collectionput
    • Delete Collectiondelete
    • MX Retail - Suppliers
    • Create Supplierpost
    • Get Suppliersget
    • Get Supplierget
    • Update Supplierput
    • Delete Supplierdelete
    • Add Supplier Photopost
    • Get Supplier Photoget
    • Create a Supplier Addresspost
    • Get Supplier Addressesget
    • Get Supplier Addressget
    • Update Supplier Addressput
    • Add a Supplier Contactpost
    • Get Supplier Contactsget
    • Get a Supplier Contactget
    • Update a Supplier Contactput
    • Delete a Supplier Contactdelete
    • Add Product to Supplierput
    • Get Supplier Produtsget
    • Get a Supplier Productget
    • Delete Supplier Productdelete
    • Add a Supplier Notepost
    • Get Supplier Notesget
    • Get a Supplier Noteget
    • Update Supplier Noteput
    • Delete Supplier Notedelete
  • MX Orders
    • Get Ordersget
    • Get an Orderget
    • Create Orderpost
    • Update Orderput
    • Delete Orderdelete
    • Send Order Receiptpost
    • Get Order Receiptget
    • Create a Fulfillmentpost
    • Update Fulfillmentput
    • Get Fulfillmentget
    • Delete Fulfillmentdelete
    • Get Order Fulfillmentget
    • Get Order Historyget
    • Create Order Returnpost
    • Update Order Returnput
    • Get Order Returnget
    • Get Return by Idget
    • Get All Returns for an Orderget
    • Get Invoices from Orderget

Merchant API Overview

In order to use the merchant APIs, you will need to utilize authentication through a JWT token. You can find documentation on getting and using JWT tokens here.

Environment
SandboxAPI: https://sandbox-api2.mxmerchant.com/merchant/v1/
Portal: https://sandbox.mxmerchant.com/
ProductionAPI: https://api2.mxmerchant.com/merchant/v1/
Portal: https://mxmerchant.com/