v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get Surcharge

post/v3/payment/enrich/mxadvantage

Request body

merchantIdstring required

tenderTypestring required

paymentTypestring

cardPresentTypestring

cardPresentboolean

authOnlyboolean

isAuthboolean

isSettleFundsboolean

isTicketstring

taxExemptboolean

shouldVaultCardboolean

mxAdvantageEnabledboolean

mxAdvantageFeeLabelstring

mxAdvantageFeeTypestring

mxAdvantageFeeAmountstring

sourceZipstring

achIndicatorstring

amountstring

Response

200

shouldVaultCardboolean

merchantIdinteger

tenderTypestring

amountstring

authOnlyboolean

settledAmountstring

cardPresentboolean

surchargeAmountstring

surchargeRatestring

surchargeLabelstring

taxExemptboolean

Example response

{
  "shouldVaultCard": true,
  "merchantId": 1000003628,
  "tenderType": "Card",
  "amount": "1248.48",
  "cardAccount": {
    "entryMode": "Keyed",
    "number": "4242424242424242",
    "expiryMonth": "12",
    "expiryYear": "33",
    "cvv": "123",
    "avsStreet": "1231",
    "avsZip": "12312"
  },
  "settledAmount": "0",
  "surchargeAmount": "36.36",
  "surchargeRate": "0.02999702999702999702999703",
  "surchargeLabel": "surcharge"
}