PaymentMethods Test
TXN/PaymentMethods/Check?cardReaderTypeId={cardReaderTypeId}
Check PaymentMethod setup for EMV or Hosted Payment charges.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/PaymentMethods/Check?cardReaderTypeId={cardReaderTypeId}

URI Parameters

Parameter Name Data Type Required Notes
cardReaderTypeId integer Y

Request Body

None.
No request body.

Response object type : CheckPaymentMethodResponse

Response object type CheckPaymentMethodResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
PaymentMethods Collection of PaymentMethod
SetupIsCorrect boolean 
{
  "SetupIsCorrect": true,
  "PaymentMethods": [
    {
      "AccountType": {
        "Id": 1,
        "Description": "sample string 1",
        "CardPrefix": "sample string 2",
        "CardtypeIndicator": "sample string 3",
        "EditMask": "sample string 4",
        "Inactive": true
      },
      "AuthIndicator": true,
      "BusinessUnitId": 2,
      "RequireCheckIndicator": true,
      "CreatedDateTime": "2025-04-24T09:07:06.9653596-07:00",
      "CreateLocation": "sample string 4",
      "CreatedBy": "sample string 5",
      "CurrencyTypeId": 1,
      "DefaultIndicator": true,
      "Description": "sample string 7",
      "GiftAidIndicator": true,
      "Id": 1,
      "Inactive": true,
      "Income": true,
      "CanRefund": true,
      "UpdatedDateTime": "2025-04-24T09:07:06.9653596-07:00",
      "UpdatedBy": "sample string 12",
      "NoCopiesOnAuth": 1,
      "NoCopiesOnSave": 1,
      "PaymentMethodGroup": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "MerchantId": "sample string 3"
      },
      "PaymentType": {
        "Id": 1,
        "Description": "sample string 1"
      },
      "ReceiptFormatId": 1,
      "RequirePostalCode": "sample string 13",
      "ShortDesc": "sample string 14",
      "StoreTenderedAmount": true,
      "OpenCashDrawer": true,
      "RequireCvv": true,
      "UseWithCardReader": true,
      "GlAccountId": "sample string 19",
      "MerchantId": "sample string 20",
      "MerchantIdForSwipe": "sample string 21",
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    },
    {
      "AccountType": {
        "Id": 1,
        "Description": "sample string 1",
        "CardPrefix": "sample string 2",
        "CardtypeIndicator": "sample string 3",
        "EditMask": "sample string 4",
        "Inactive": true
      },
      "AuthIndicator": true,
      "BusinessUnitId": 2,
      "RequireCheckIndicator": true,
      "CreatedDateTime": "2025-04-24T09:07:06.9653596-07:00",
      "CreateLocation": "sample string 4",
      "CreatedBy": "sample string 5",
      "CurrencyTypeId": 1,
      "DefaultIndicator": true,
      "Description": "sample string 7",
      "GiftAidIndicator": true,
      "Id": 1,
      "Inactive": true,
      "Income": true,
      "CanRefund": true,
      "UpdatedDateTime": "2025-04-24T09:07:06.9653596-07:00",
      "UpdatedBy": "sample string 12",
      "NoCopiesOnAuth": 1,
      "NoCopiesOnSave": 1,
      "PaymentMethodGroup": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "MerchantId": "sample string 3"
      },
      "PaymentType": {
        "Id": 1,
        "Description": "sample string 1"
      },
      "ReceiptFormatId": 1,
      "RequirePostalCode": "sample string 13",
      "ShortDesc": "sample string 14",
      "StoreTenderedAmount": true,
      "OpenCashDrawer": true,
      "RequireCvv": true,
      "UseWithCardReader": true,
      "GlAccountId": "sample string 19",
      "MerchantId": "sample string 20",
      "MerchantIdForSwipe": "sample string 21",
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    }
  ]
}
<CheckPaymentMethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentMethods>
    <PaymentMethod>
      <AccountType>
        <CardPrefix>sample string 2</CardPrefix>
        <CardtypeIndicator>sample string 3</CardtypeIndicator>
        <Description>sample string 1</Description>
        <EditMask>sample string 4</EditMask>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </AccountType>
      <AuthIndicator>true</AuthIndicator>
      <BusinessUnitId>2</BusinessUnitId>
      <CanRefund>true</CanRefund>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <CreateLocation>sample string 4</CreateLocation>
      <CreatedBy>sample string 5</CreatedBy>
      <CreatedDateTime>2025-04-24T09:07:06.9653596-07:00</CreatedDateTime>
      <CurrencyTypeId>1</CurrencyTypeId>
      <DefaultIndicator>true</DefaultIndicator>
      <Description>sample string 7</Description>
      <GiftAidIndicator>true</GiftAidIndicator>
      <GlAccountId>sample string 19</GlAccountId>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <Income>true</Income>
      <MerchantId>sample string 20</MerchantId>
      <MerchantIdForSwipe>sample string 21</MerchantIdForSwipe>
      <NoCopiesOnAuth>1</NoCopiesOnAuth>
      <NoCopiesOnSave>1</NoCopiesOnSave>
      <OpenCashDrawer>true</OpenCashDrawer>
      <PaymentMethodGroup>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <MerchantId>sample string 3</MerchantId>
      </PaymentMethodGroup>
      <PaymentType>
        <Description>sample string 1</Description>
        <Id>1</Id>
      </PaymentType>
      <ReceiptFormatId>1</ReceiptFormatId>
      <RequireCheckIndicator>true</RequireCheckIndicator>
      <RequireCvv>true</RequireCvv>
      <RequirePostalCode>sample string 13</RequirePostalCode>
      <ShortDesc>sample string 14</ShortDesc>
      <StoreTenderedAmount>true</StoreTenderedAmount>
      <UpdatedBy>sample string 12</UpdatedBy>
      <UpdatedDateTime>2025-04-24T09:07:06.9653596-07:00</UpdatedDateTime>
      <UseWithCardReader>true</UseWithCardReader>
    </PaymentMethod>
    <PaymentMethod>
      <AccountType>
        <CardPrefix>sample string 2</CardPrefix>
        <CardtypeIndicator>sample string 3</CardtypeIndicator>
        <Description>sample string 1</Description>
        <EditMask>sample string 4</EditMask>
        <Id>1</Id>
        <Inactive>true</Inactive>
      </AccountType>
      <AuthIndicator>true</AuthIndicator>
      <BusinessUnitId>2</BusinessUnitId>
      <CanRefund>true</CanRefund>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <CreateLocation>sample string 4</CreateLocation>
      <CreatedBy>sample string 5</CreatedBy>
      <CreatedDateTime>2025-04-24T09:07:06.9653596-07:00</CreatedDateTime>
      <CurrencyTypeId>1</CurrencyTypeId>
      <DefaultIndicator>true</DefaultIndicator>
      <Description>sample string 7</Description>
      <GiftAidIndicator>true</GiftAidIndicator>
      <GlAccountId>sample string 19</GlAccountId>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <Income>true</Income>
      <MerchantId>sample string 20</MerchantId>
      <MerchantIdForSwipe>sample string 21</MerchantIdForSwipe>
      <NoCopiesOnAuth>1</NoCopiesOnAuth>
      <NoCopiesOnSave>1</NoCopiesOnSave>
      <OpenCashDrawer>true</OpenCashDrawer>
      <PaymentMethodGroup>
        <Description>sample string 1</Description>
        <Id>1</Id>
        <Inactive>true</Inactive>
        <MerchantId>sample string 3</MerchantId>
      </PaymentMethodGroup>
      <PaymentType>
        <Description>sample string 1</Description>
        <Id>1</Id>
      </PaymentType>
      <ReceiptFormatId>1</ReceiptFormatId>
      <RequireCheckIndicator>true</RequireCheckIndicator>
      <RequireCvv>true</RequireCvv>
      <RequirePostalCode>sample string 13</RequirePostalCode>
      <ShortDesc>sample string 14</ShortDesc>
      <StoreTenderedAmount>true</StoreTenderedAmount>
      <UpdatedBy>sample string 12</UpdatedBy>
      <UpdatedDateTime>2025-04-24T09:07:06.9653596-07:00</UpdatedDateTime>
      <UseWithCardReader>true</UseWithCardReader>
    </PaymentMethod>
  </PaymentMethods>
  <SetupIsCorrect>true</SetupIsCorrect>
</CheckPaymentMethodResponse>
Change Version Description Contract Old New
Operation Added 15.1.7 Check has been added. Check