v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get Merchant Settings

Get just the settings of a merchant

get/v3/merchant/{merchantId}/setting

Path parameters

merchantIdstring required

Id of the merchant

Response

200

customobject[]

Example response

{
  "lossPrevention": {
    "emsPaymentAmountThreshold": "500",
    "declineEmsScoreThreshold": 500
  },
  "processing": {
    "cashAdvance": true,
    "incrementalAuth": true,
    "mastercardFraudScoring": true,
    "maxAmount": "9999999999.99",
    "partialReversal": true,
    "payment": true
  },
  "receipt": {
    "showPhone": true,
    "showWebsiteUrl": true,
    "returnPolicy": "ALL SALES ARE FINAL",
    "imageWidth": 150,
    "imageHeight": 93,
    "imageSize": 7946,
    "imageDataUrl": "{base64 encoded image}",
    "imageName": "cards3.jpg",
    "title": "Roswell",
    "name": "Judson Test TSYS Merchant",
    "phone": "7705625489",
    "receiptMessage": "Thanks for shopping with us!",
    "email": "test@pps.io",
    "websiteUrl": "api.mxmerchant.com",
    "showHistory": true,
    "address": {
      "address1": "1234 TEST ST",
      "city": "ALPHARETTA",
      "state": "GA",
      "zip": "30004"
    },
    "receiptType": "Modern"
  },
  "payment": {
    "promptForCustomData": true,
    "includeB2bFields": true,
    "enableAchPayments": true,
    "enableCashPayments": true,
    "enableCardPayments": true,
    "enableCheckPayments": true,
    "quickPayTransactionType": "Sale",
    "quickPayTender": "Card",
    "quickPayCardPresent": "CardNotPresent",
    "quickPayEndOfPayment": "CloseQuickPay",
    "autoCloseTime": "15:26",
    "enableAutoClose": true,
    "enableTip": true,
    "achIndicator": "WEB"
  },
  "invoice": {
    "defaultFulfillment": "0",
    "paymentTerms": "Net15",
    "enableClickToPay": true,
    "enableAch": true,
    "reminderDays": 3,
    "receiptDays": 3,
    "enableCardPayment": true,
    "interval": "Weekly",
    "frequency": 1,
    "dayNumber": 1,
    "dayType": "First",
    "day": "Sunday",
    "requireAuthorization": true,
    "sendDeclineEmail": true,
    "month": "January",
    "orderSourceType": "Web"
  },
  "general": {
    "defaultCatalogId": 2,
    "locationId": 2412,
    "package": [
      "Basic"
    ],
    "timezoneOffset": "-5:00",
    "daylightSaving": true
  }
}