v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Get Merchant Details & Settings

Get all merchant details and settings

get/v3/merchant/{merchantId}

Path parameters

merchantIdstring required

Id of the merchant

Response

200

idinteger
dbastring
xmidinteger
applicationStatusstring
awaitingMerchantAcceptanceboolean
merchantAcceptedAgreementboolean
hasPayRightHealthEquipmentboolean
planstring
packagestring[]
taxRatestring
canProcessPaymentboolean

Example response

{
  "id": 110070419,
  "dba": "Demo Test TSYS Merchant",
  "xmid": 8739290300300001,
  "applicationStatus": "Approved",
  "plan": "Basic",
  "package": [
    "Basic"
  ],
  "taxRate": "0.3",
  "canProcessPayment": true,
  "address": {
    "name": "Location",
    "address1": "1234 TEST ST",
    "city": "ALPHARETTA",
    "state": "GA",
    "zip": "30004",
    "country": "USA"
  },
  "settings": {
    "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
    },
    "compliance": {
      "tin": {
        "current": {
          "expires": "2020-09-01T04:00:00Z",
          "created": "2019-09-01T04:00:00Z",
          "status": "TIN not currently used",
          "statusCode": "02",
          "description": "INVALID: TIN not used"
        },
        "history": [
          {
            "expires": "2020-09-01T04:00:00Z",
            "created": "2019-09-01T04:00:00Z",
            "status": "TIN not currently used",
            "statusCode": "02",
            "description": "INVALID: TIN not used"
          }
        ]
      },
      "saq": {
        "current": {
          "type": "SAQ A-EP",
          "passed": true,
          "expires": "2017-09-04T04:00:00Z",
          "created": "2016-02-04T16:41:14.843Z",
          "signer": "Allie"
        },
        "history": [
          {
            "type": "SAQ A-EP",
            "passed": true,
            "expires": "2017-09-04T04:00:00Z",
            "created": "2016-02-04T16:41:14.843Z",
            "signer": "Allie"
          }
        ]
      }
    }
  },
  "spendProfiles": [
    {
      "id": 153746,
      "name": "New",
      "spentMin": "0",
      "priority": 1,
      "icon": "glyphicon-butterfly",
      "isSystem": true,
      "dateCreated": "2015-04-17T03:44:54.993Z",
      "dateUpdated": "2017-07-25T23:43:19.427Z"
    }
  ]
}