PaymentMethods Test
TXN/PaymentMethods?paymentTypeIds={paymentTypeIds}&maintenanceMode={maintenanceMode}
Get all payment methods. This resource looks similar to referenceData resources, but is functionally different. When maintenanceMode is false, control groups are considered when returning payment methods. The default for maintenanceMode is false. This endpoint should not generally be used for transaction based screens because it does not account for assigned payment methods based on user group security. For cart available payment methods, consider Security/PaymentMethods?amount={amount}.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/PaymentMethods?paymentTypeIds={paymentTypeIds}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
paymentTypeIds string N Optional comma delimited of payment type ids to filter the returned collection.
maintenanceMode boolean N Defaults to false. When false, control group security is enforced. Maintenance mode assumes that the consumer is in an administrative use.

Request Body

None.
No request body.

Response object type : Collection of PaymentMethod

Response object type Collection of PaymentMethod has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountType AccountTypeSummary N
FK: TR_ACCOUNT_TYPE.id   Resource: AccountTypes
AuthIndicator boolean N
BusinessUnitId integer N
FK: TR_BU.id   Resource: BusinessUnits
CanRefund boolean N
ControlGroup ControlGroupSummary N
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
CurrencyTypeId integer N
FK: TR_CURRENCY_TYPE.id
DefaultIndicator boolean N
Description string N
GiftAidIndicator boolean N
GlAccountId string N
FK: T_GL_ACCOUNT.gl_account_no
Id integer N
Inactive boolean N
Income boolean N
MerchantId string N
MerchantIdForSwipe string N
NoCopiesOnAuth integer N
NoCopiesOnSave integer N
OpenCashDrawer boolean N
PaymentMethodGroup PaymentMethodGroupSummary N
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodGroups
PaymentType PaymentTypeSummary N
FK: TR_PAYMENT_TYPE.id   Resource: PaymentTypes
ReceiptFormatId integer N
FK: T_DESIGN.design_no
RequireCheckIndicator boolean N
RequireCvv boolean N
RequirePostalCode string N
ShortDesc string N
StoreTenderedAmount boolean N
UpdatedBy string N
UpdatedDateTime date N
UseWithCardReader boolean N 
[
  {
    "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-24T05:03:15.8428465-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-24T05:03:15.8428465-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-24T05:03:15.8428465-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-24T05:03:15.8428465-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
    }
  }
]
<PaymentMethods xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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-24T05:03:15.8428465-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-24T05:03:15.8428465-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-24T05:03:15.8428465-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-24T05:03:15.8428465-07:00</UpdatedDateTime>
    <UseWithCardReader>true</UseWithCardReader>
  </PaymentMethod>
</PaymentMethods>

No entries in change log for this operation.