PaymentMethods Test
TXN/PaymentMethods/{paymentMethodId}
Update an existing payment method.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/PaymentMethods/{paymentMethodId}

URI Parameters

Parameter Name Data Type Required Notes
paymentMethodId integer Y

Request Body

Request object type : PaymentMethod

Request object type 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 Y
BusinessUnitId integer Y
FK: TR_BU.id   Resource: BusinessUnits
CanRefund boolean Y
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CurrencyTypeId integer N
FK: TR_CURRENCY_TYPE.id
DefaultIndicator boolean Y
Description string 30 Y
GiftAidIndicator boolean Y
GlAccountId string 30 N
FK: T_GL_ACCOUNT.gl_account_no
Id integer Y Non-updatable
Inactive boolean Y
Income boolean Y
MerchantId string N
MerchantIdForSwipe string N
NoCopiesOnAuth integer N
NoCopiesOnSave integer N
OpenCashDrawer boolean Y
PaymentMethodGroup PaymentMethodGroupSummary Y
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodGroups
PaymentType PaymentTypeSummary Y
FK: TR_PAYMENT_TYPE.id   Resource: PaymentTypes
ReceiptFormatId integer N
FK: T_DESIGN.design_no
RequireCheckIndicator boolean Y
RequireCvv boolean Y
RequirePostalCode string Y
ShortDesc string 10 Y
StoreTenderedAmount boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseWithCardReader boolean Y 
{
  "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-24T04:54:32.4104481-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-24T04:54:32.4104481-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
  }
}
<PaymentMethod xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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-24T04:54:32.4104481-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-24T04:54:32.4104481-07:00</UpdatedDateTime>
  <UseWithCardReader>true</UseWithCardReader>
</PaymentMethod>

Response object type : PaymentMethod

Response object type 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 Y
BusinessUnitId integer Y
FK: TR_BU.id   Resource: BusinessUnits
CanRefund boolean Y
ControlGroup ControlGroupSummary Y
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CurrencyTypeId integer N
FK: TR_CURRENCY_TYPE.id
DefaultIndicator boolean Y
Description string 30 Y
GiftAidIndicator boolean Y
GlAccountId string 30 N
FK: T_GL_ACCOUNT.gl_account_no
Id integer Y Non-updatable
Inactive boolean Y
Income boolean Y
MerchantId string N
MerchantIdForSwipe string N
NoCopiesOnAuth integer N
NoCopiesOnSave integer N
OpenCashDrawer boolean Y
PaymentMethodGroup PaymentMethodGroupSummary Y
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodGroups
PaymentType PaymentTypeSummary Y
FK: TR_PAYMENT_TYPE.id   Resource: PaymentTypes
ReceiptFormatId integer N
FK: T_DESIGN.design_no
RequireCheckIndicator boolean Y
RequireCvv boolean Y
RequirePostalCode string Y
ShortDesc string 10 Y
StoreTenderedAmount boolean Y
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UseWithCardReader boolean Y 
{
  "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-24T04:54:32.4104481-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-24T04:54:32.4104481-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
  }
}
<PaymentMethod xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <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-24T04:54:32.4104481-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-24T04:54:32.4104481-07:00</UpdatedDateTime>
  <UseWithCardReader>true</UseWithCardReader>
</PaymentMethod>
Change Version Description Contract Old New
Parameter Changed 15.0.0 paymentMethodId has been marked as required. Required