MX™ Merchant

The MX Merchant Developer Hub

Welcome to the MX Merchant developer hub. You'll find comprehensive API reference and documentation to help you start working with the MX Merchant Checkout API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started with MX Merchant

Step One: Obtain an MXMerchant Sandbox Account.

Request a Sandbox Account via the [email protected] Make sure to include the main point of contact, name, and reason you would like to integrate with Priority.

Step Two: Authenticating with MXMerchant

The best way to authenticate is to use our Basic Authentication. Follow the guide below for the basic authorization.

  1. Launch an API development tool that will assist you in making calls. We like to use postman for our API testing.
  2. Navigate to where you can select your type of authentication. We will be choosing Basic Auth.
  3. If you are presented with a Username and Password. It will be the same username and password that you use to log into to the respective environment.
  4. Send the request with the appropriate parameters, and when you receive a status 200 ok response, you have successfully authenticated!

Step Three: Making a Payment Transaction.

  1. Launch an API development tool that will assist you in making calls. We like to use POSTMAN for our API examples.
  2. Make a POST to this endpoint: https://sandbox.api.mxmerchant.com/checkout/v3/payment
  3. Input a basic code that look siimilar to below:
          
            "merchantId": "MerchantID#Here",
            "tenderType": "Card",
          	"amount": 1.00,
            "cardAccount": {"token":"String"}
          
  4. Send the request with the body above. You will receive a 200ok response back. Awesome, you now know how to make a payment transaction!

Step Four: Creating a customer

  1. Launch an API development tool that will assist you in making calls. We like to use POSTMAN for our API examples.
  2. Make a POST to this endpoint: https://sandbox.api.mxmerchant.com/checkout/v3/customer
  3. Input a basic code that look siimilar to below:
          
           "merchantId": "Merchant_ID_Here",
    	"name": "Joe Smith",
    	"firstName": "Joe",
    	"lastName": "Smith",
    	"address1": "2001 Westside Parkway",
    	"city": "Alpharetta",
    	"state": "Georgia",
    	"zip": "30004"
          
  4. Send the request with the body above. You will receive a 200ok response back. Awesome, you now know how to create a customer

Step Five: Vaulting Cards

  1. Launch an API development tool that will assist you in making calls. We like to use POSTMAN for our API examples.
  2. Make a POST to this endpoint: https://sandbox.api.mxmerchant.com/checkout/v3/customercardaccountr
  3. Input a basic code that look siimilar to below:
          
           	"code": "card",
    	"number": "4242424242424242",
    	"expiryMonth": "12",
    	"expiryYear": "2022",
    	"avsZip": "30004",
    	"avsStreet": "2001 Westside Parkway",
    	"cvv": "211",
    	"name": "Jane Doe"
          
  4. Send the request with the body above. You will receive a 200ok response back. Awesome, you now know how to vault a card.

Updated 2 months ago


Get Started with MX Merchant


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.