PaymentMethodUserGroups Test
TXN/PaymentMethodUserGroups?userGroup={userGroup}&amount={amount}&maintenanceMode={maintenanceMode}
Get all payment method/user group mappings. Optional filter on UserGroup, Amount and MaintenanceMode (which overrides the filter on UserGroup)
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/PaymentMethodUserGroups?userGroup={userGroup}&amount={amount}&maintenanceMode={maintenanceMode}

URI Parameters

Parameter Name Data Type Required Notes
userGroup string N Only return mappings for the specified UserGroup.
amount decimal number N If a negative amount is specified, return mappings where the PaymentMethod allows refunds and has a MaxRefund >= the absolute value of amount. If a positive amount is specified, return mappings where the IncomeIndicator is true and the PaymentMethod is of type Income. Amount is not allowed if maintenanceMode="true".
maintenanceMode boolean N If "true", all mappings will be returned. Effectively the same as not specifying a UserGroup.

Request Body

None.
No request body.

Response object type : Collection of PaymentMethodUserGroup

Response object type Collection of PaymentMethodUserGroup has the following properties.
Property Name Data Type Length Required Readonly Notes
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
Id integer N
IncomeIndicator boolean N
MaxRefund decimal number N
PaymentMethod PaymentMethodSummary N
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods
UpdatedBy string N
UpdatedDateTime date N
UserGroupId string N 
[
  {
    "CreatedDateTime": "2025-04-24T04:46:25.4368359-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Id": 1,
    "IncomeIndicator": true,
    "UpdatedDateTime": "2025-04-24T04:46:25.4368359-07:00",
    "UpdatedBy": "sample string 4",
    "MaxRefund": 5.0,
    "PaymentMethod": {
      "Id": 1,
      "Description": "sample string 2",
      "Inactive": true,
      "PaymentType": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    },
    "UserGroupId": "sample string 6"
  },
  {
    "CreatedDateTime": "2025-04-24T04:46:25.4368359-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Id": 1,
    "IncomeIndicator": true,
    "UpdatedDateTime": "2025-04-24T04:46:25.4368359-07:00",
    "UpdatedBy": "sample string 4",
    "MaxRefund": 5.0,
    "PaymentMethod": {
      "Id": 1,
      "Description": "sample string 2",
      "Inactive": true,
      "PaymentType": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    },
    "UserGroupId": "sample string 6"
  }
]
<PaymentMethodUserGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentMethodUserGroup>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T04:46:25.4368359-07:00</CreatedDateTime>
    <Id>1</Id>
    <IncomeIndicator>true</IncomeIndicator>
    <MaxRefund>5</MaxRefund>
    <PaymentMethod>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <PaymentType>
        <Description>sample string 2</Description>
        <Id>1</Id>
      </PaymentType>
    </PaymentMethod>
    <UpdatedBy>sample string 4</UpdatedBy>
    <UpdatedDateTime>2025-04-24T04:46:25.4368359-07:00</UpdatedDateTime>
    <UserGroupId>sample string 6</UserGroupId>
  </PaymentMethodUserGroup>
  <PaymentMethodUserGroup>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T04:46:25.4368359-07:00</CreatedDateTime>
    <Id>1</Id>
    <IncomeIndicator>true</IncomeIndicator>
    <MaxRefund>5</MaxRefund>
    <PaymentMethod>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 2</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <PaymentType>
        <Description>sample string 2</Description>
        <Id>1</Id>
      </PaymentType>
    </PaymentMethod>
    <UpdatedBy>sample string 4</UpdatedBy>
    <UpdatedDateTime>2025-04-24T04:46:25.4368359-07:00</UpdatedDateTime>
    <UserGroupId>sample string 6</UserGroupId>
  </PaymentMethodUserGroup>
</PaymentMethodUserGroups>

No entries in change log for this operation.