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. MX Advantage

Make a Payment with Surcharge

post
https://sandbox-api.prioritycommerce.com/v1/checkout/payment

Process a payment with an automatically calculated surcharge applied, compliant with card brand surcharging programs.

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

Return customers that have this card vaulted in their account

Body Params
string
required

Id of the merchant

float
required

The payment amount. Must not be 0.

string
Defaults to Sale

Type of transaction Values: Sale, Refund, CashAdvance, Prepaid, Adjustment, Void, Reversal, Authorization, SaleCompletion, PaymentTransaction, Withdrawal, Balance

boolean
Defaults to false

Indicates that this payment should NOT be added to current batch. AuthOnly payment won't be settled.

boolean
Defaults to false

Should this card be authorized?

string

Values: Card, Check, Cash, Multiple, Loyalty, ACH

boolean

Is the credit card is present at the time of payment?

cardAccount
object

Card Account Object (Required if tenderType is Card)

bankAccount
object

Bank Account Object (Required if tenderType is Check or ACH)

string
Defaults to WEB

Gets or sets the ACH entry class Values: CCD, PPD, TEL, WEB

boolean
Defaults to false

Should this transaction be settled?

customer
object

Associate the payment to an existing customer in your customer database.

string

Customer Name (256 char) (Does NOT associate payment to customer)

string

Client provided customer reference number (Associates with Customer Number). Cannot be combined with invoiceId and clientReference if B2B is on

string

Memo field

int32

A merchant-supplied identifier to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique. If supplied, we will check for a payment that matches this identifier. If found will return an identical response of the original request. Represents a bigInt value.

string
Defaults to API

Values: API, QuickPay, Recurring, Link2Pay, Terminal

string

Client provided payment reference number; can be associated with multiple payments (17 char max)

string

Client provided invoice number (Generated by server if not provided,16 char max)

invoiceIds
array of strings

If there are multiple invoices, you can send in an array of existing invoice ids (Note: they must already exist in MX Merchant)

invoiceIds
orderIds
array of strings

If there are multiple orders, you can send in an array of existing order ids (Note: they must already exist in MX Merchant)

orderIds
float

Tax Amount (included in amount)

boolean
Defaults to false

If true, tax amount must be 0

string

Values: CardPresentKeyed, CardPresentSwiped, CardNotPresent

string

Gets/Sets the device identifier, this is the terminal id.

purchases
array

Gets/Sets the list of purchases. Used by level 3 data during settlement

purchases
float

Gets/Sets the ship amount, used by level 3 data during settlement

string

Gets/Sets the 3-digit alphanumeric ship-to country code, i.e. USA, used by level 3 data during settlement

string

Gets/Sets the ship-to zip code, used by level 3 data during settlement

boolean

Use this param to vault a new card to a new or existing customer. Send in customer.id to vault to an existing customer, and at a minimum, customer.firstName or customer.lastName to vault the card to a new customer.

float

Gets/Sets the amount of the gratuity (included in amount).

float

Gets/Sets the vat amount, used by level 3 data during settlement

float

Gets/Sets the VAT rate, used by level 3 data during settlement

tags
array of strings

Associate a tag with the payment (You must set up the tag first in MX Merchant)

tags
string

Dollar amount for the surcharge.

string
Defaults to surcharge

Labels for the surcharge: surcharge, convenience fee, non-cash adjustment

string

Rate for surcharge on the merchant account.

boolean
Defaults to true

If true, MX Advantage is enabled.

string
Defaults to surcharge

Label for surcharge.

string
Defaults to percentage

Type of surcharge.

string

The amount of the MX Advantage surcharge.

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