PaymentGatewayActivities Test
PaymentGateway/PaymentGatewayActivities/{paymentGatewayActivityId}
Update an existing Payment Gateway Activity
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/PaymentGatewayActivities/{paymentGatewayActivityId}

URI Parameters

Parameter Name Data Type Required Notes
paymentGatewayActivityId integer Y

Request Body

Request object type : PaymentGatewayActivity

Request object type PaymentGatewayActivity has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer N
FK: T_ACCOUNT_DATA.id   Resource: Accounts
AccountNumber string 24 N Masked account number.
ActivityData string N
Amount decimal number N
AuthCode string 30 N
AvsAddress string 64 N Address submitted for Address Verification System (AVS).
AvsPostalcode string 10 N Postal code submitted for Address Verification System (AVS).
AvsResultCode string 1 N Response from Address Verification System (AVS) query.
BalanceAmount decimal number N Customer balance after transaction - may be populated in Vantiv transactions with partial auth enabled. Vantiv requires that this field be an available option for receipts.
BalanceCurrencyCode string 3 N Currency code of customer balance - may be populated in Vantiv transactions with partial auth enabled. Vantiv requires that this field be an available option for receipts.
ConstituentId integer N
FK: T_CUSTOMER.customer_no   Resource: Constituents
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CvvResultCode string 1 N Result of checking the submitted CVV (Customer Verification Value) code against the CVV on the customer's account.
EcommerceIndicator string 1 N
EmvApplicationIdentifier string 32 N Required by Vantiv as an option for EMV receipts.
EmvApplicationName string 16 N Required by Vantiv as an option for EMV receipts.
EmvCryptogram string 25 N Required by Vantiv as an option for EMV receipts.
EmvHostResponseCode string 3 N Required by Vantiv as an option for EMV receipts.
EmvHostResponseMessage string 150 N Required by Vantiv as an option for EMV receipts.
EmvPinVerified string 1 N Required by Vantiv as an option for EMV receipts.
EntryMethod string 10 N Method by which card data was supplied for transaction (Keyed, Swiped, Stored, etc.).
ExpirationDate string 6 N Expiration date of payment card.
Id integer Y Non-updatable
MerchantId string 3 N Merchant id used to locate processor credentials and charge the payment card or create a token.
Name string 56 N Name on card.
NetworkTransactionId string 40 N Transaction identifier returned from credential-on-file transactions (Worldpay).
Origin string 20 N Area of Tessitura application (or user-supplied information) where the transaction originated.
PaymentGatewayTransactionType PaymentGatewayTransactionType Y Follow-up transactions (Reverse/Confirm) will have most fields set to null -- they refer to the original Authorization row.
FK: TR_PAYMENT_GATEWAY_TRANSACTION_TYPE.id   Resource: PaymentGatewayTransactionTypes
PaymentId integer N
FK: T_PAYMENT.payment_no   Resource: Payments
PaymentMethodGroupId integer N
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodUserGroups
PaymentMethodId integer N
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods
ProviderCommunicationDurationMs integer N The duration of time that it took for gateway provider to respond, start to finish, including network latency. Calculated from the start of the request to the receipt of the response.
ProviderTransactionDateTime date N Transaction date/time according to gateway provider (if available), otherwise calculated by Tessitura.
ReferenceNumber string 32 N Used in subsequent reversal or refund requests or inquiries.
ResponseCode string 20 N A "SUCCESS" value (MasterCard) or zero "0" value (other gateways) indicates a successful transaction. Use the Success field, rather than this field, to interpret the disposition of the request.
ResponseMessage string 4000 N Sometimes includes more detailed information about the response than the ResponseCode.
Success string 1 Y Success (Y) or failure (N) of the request. Use this value, rather than ResponseCode, to interpret the disposition of the request.
TerminalIdentifier string 16 N For EMV transactions - which machine handled the transaction.
FK: TR_MACHINE_SETTINGS.workstation_name   Resource: MachineSettings
TotalDurationMs integer N Total amount of time spent in the Authorization call.
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UserData string 4000 N User-generated free-form text stored in T_PAYMENT_GATEWAY_ACTIVITY.user_data. Tessitura-generated transactions write the invoice, order, or contribution number. 
{
  "AccountNumber": "sample string 1",
  "AccountId": 1,
  "Amount": 2.0,
  "AuthCode": "sample string 3",
  "AvsAddress": "sample string 4",
  "AvsPostalcode": "sample string 5",
  "AvsResultCode": "sample string 6",
  "BalanceAmount": 1.0,
  "BalanceCurrencyCode": "sample string 7",
  "CreatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "CreateLocation": "sample string 8",
  "CreatedBy": "sample string 9",
  "ConstituentId": 1,
  "CvvResultCode": "sample string 10",
  "EcommerceIndicator": "sample string 11",
  "EmvApplicationName": "sample string 12",
  "EmvApplicationIdentifier": "sample string 13",
  "EmvPinVerified": "sample string 14",
  "EmvHostResponseCode": "sample string 15",
  "EmvHostResponseMessage": "sample string 16",
  "EmvCryptogram": "sample string 17",
  "EntryMethod": "sample string 18",
  "ExpirationDate": "sample string 19",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "UpdatedBy": "sample string 20",
  "MerchantId": "sample string 21",
  "Name": "sample string 22",
  "Origin": "sample string 23",
  "PaymentGatewayTransactionType": {
    "CreatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Id": 1,
    "Inactive": true,
    "UpdatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
    "UpdatedBy": "sample string 5"
  },
  "PaymentMethodGroupId": 1,
  "PaymentMethodId": 1,
  "PaymentId": 1,
  "ProviderCommunicationDurationMs": 1,
  "ProviderTransactionDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "ReferenceNumber": "sample string 24",
  "ResponseCode": "sample string 25",
  "ResponseMessage": "sample string 26",
  "Success": "sample string 27",
  "TerminalIdentifier": "sample string 28",
  "TotalDurationMs": 1,
  "UserData": "sample string 29",
  "NetworkTransactionId": "sample string 30",
  "ActivityData": "sample string 31"
}
<PaymentGatewayActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountId>1</AccountId>
  <AccountNumber>sample string 1</AccountNumber>
  <ActivityData>sample string 31</ActivityData>
  <Amount>2</Amount>
  <AuthCode>sample string 3</AuthCode>
  <AvsAddress>sample string 4</AvsAddress>
  <AvsPostalcode>sample string 5</AvsPostalcode>
  <AvsResultCode>sample string 6</AvsResultCode>
  <BalanceAmount>1</BalanceAmount>
  <BalanceCurrencyCode>sample string 7</BalanceCurrencyCode>
  <ConstituentId>1</ConstituentId>
  <CreateLocation>sample string 8</CreateLocation>
  <CreatedBy>sample string 9</CreatedBy>
  <CreatedDateTime>2025-04-24T05:01:02.1751202-07:00</CreatedDateTime>
  <CvvResultCode>sample string 10</CvvResultCode>
  <EcommerceIndicator>sample string 11</EcommerceIndicator>
  <EmvApplicationIdentifier>sample string 13</EmvApplicationIdentifier>
  <EmvApplicationName>sample string 12</EmvApplicationName>
  <EmvCryptogram>sample string 17</EmvCryptogram>
  <EmvHostResponseCode>sample string 15</EmvHostResponseCode>
  <EmvHostResponseMessage>sample string 16</EmvHostResponseMessage>
  <EmvPinVerified>sample string 14</EmvPinVerified>
  <EntryMethod>sample string 18</EntryMethod>
  <ExpirationDate>sample string 19</ExpirationDate>
  <Id>1</Id>
  <MerchantId>sample string 21</MerchantId>
  <Name>sample string 22</Name>
  <NetworkTransactionId>sample string 30</NetworkTransactionId>
  <Origin>sample string 23</Origin>
  <PaymentGatewayTransactionType>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:02.1751202-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:02.1751202-07:00</UpdatedDateTime>
  </PaymentGatewayTransactionType>
  <PaymentId>1</PaymentId>
  <PaymentMethodGroupId>1</PaymentMethodGroupId>
  <PaymentMethodId>1</PaymentMethodId>
  <ProviderCommunicationDurationMs>1</ProviderCommunicationDurationMs>
  <ProviderTransactionDateTime>2025-04-24T05:01:02.1751202-07:00</ProviderTransactionDateTime>
  <ReferenceNumber>sample string 24</ReferenceNumber>
  <ResponseCode>sample string 25</ResponseCode>
  <ResponseMessage>sample string 26</ResponseMessage>
  <Success>sample string 27</Success>
  <TerminalIdentifier>sample string 28</TerminalIdentifier>
  <TotalDurationMs>1</TotalDurationMs>
  <UpdatedBy>sample string 20</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:01:02.1751202-07:00</UpdatedDateTime>
  <UserData>sample string 29</UserData>
</PaymentGatewayActivity>

Response object type : PaymentGatewayActivity

Response object type PaymentGatewayActivity has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountId integer N
FK: T_ACCOUNT_DATA.id   Resource: Accounts
AccountNumber string 24 N Masked account number.
ActivityData string N
Amount decimal number N
AuthCode string 30 N
AvsAddress string 64 N Address submitted for Address Verification System (AVS).
AvsPostalcode string 10 N Postal code submitted for Address Verification System (AVS).
AvsResultCode string 1 N Response from Address Verification System (AVS) query.
BalanceAmount decimal number N Customer balance after transaction - may be populated in Vantiv transactions with partial auth enabled. Vantiv requires that this field be an available option for receipts.
BalanceCurrencyCode string 3 N Currency code of customer balance - may be populated in Vantiv transactions with partial auth enabled. Vantiv requires that this field be an available option for receipts.
ConstituentId integer N
FK: T_CUSTOMER.customer_no   Resource: Constituents
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
CvvResultCode string 1 N Result of checking the submitted CVV (Customer Verification Value) code against the CVV on the customer's account.
EcommerceIndicator string 1 N
EmvApplicationIdentifier string 32 N Required by Vantiv as an option for EMV receipts.
EmvApplicationName string 16 N Required by Vantiv as an option for EMV receipts.
EmvCryptogram string 25 N Required by Vantiv as an option for EMV receipts.
EmvHostResponseCode string 3 N Required by Vantiv as an option for EMV receipts.
EmvHostResponseMessage string 150 N Required by Vantiv as an option for EMV receipts.
EmvPinVerified string 1 N Required by Vantiv as an option for EMV receipts.
EntryMethod string 10 N Method by which card data was supplied for transaction (Keyed, Swiped, Stored, etc.).
ExpirationDate string 6 N Expiration date of payment card.
Id integer Y Non-updatable
MerchantId string 3 N Merchant id used to locate processor credentials and charge the payment card or create a token.
Name string 56 N Name on card.
NetworkTransactionId string 40 N Transaction identifier returned from credential-on-file transactions (Worldpay).
Origin string 20 N Area of Tessitura application (or user-supplied information) where the transaction originated.
PaymentGatewayTransactionType PaymentGatewayTransactionType Y Follow-up transactions (Reverse/Confirm) will have most fields set to null -- they refer to the original Authorization row.
FK: TR_PAYMENT_GATEWAY_TRANSACTION_TYPE.id   Resource: PaymentGatewayTransactionTypes
PaymentId integer N
FK: T_PAYMENT.payment_no   Resource: Payments
PaymentMethodGroupId integer N
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodUserGroups
PaymentMethodId integer N
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods
ProviderCommunicationDurationMs integer N The duration of time that it took for gateway provider to respond, start to finish, including network latency. Calculated from the start of the request to the receipt of the response.
ProviderTransactionDateTime date N Transaction date/time according to gateway provider (if available), otherwise calculated by Tessitura.
ReferenceNumber string 32 N Used in subsequent reversal or refund requests or inquiries.
ResponseCode string 20 N A "SUCCESS" value (MasterCard) or zero "0" value (other gateways) indicates a successful transaction. Use the Success field, rather than this field, to interpret the disposition of the request.
ResponseMessage string 4000 N Sometimes includes more detailed information about the response than the ResponseCode.
Success string 1 Y Success (Y) or failure (N) of the request. Use this value, rather than ResponseCode, to interpret the disposition of the request.
TerminalIdentifier string 16 N For EMV transactions - which machine handled the transaction.
FK: TR_MACHINE_SETTINGS.workstation_name   Resource: MachineSettings
TotalDurationMs integer N Total amount of time spent in the Authorization call.
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
UserData string 4000 N User-generated free-form text stored in T_PAYMENT_GATEWAY_ACTIVITY.user_data. Tessitura-generated transactions write the invoice, order, or contribution number. 
{
  "AccountNumber": "sample string 1",
  "AccountId": 1,
  "Amount": 2.0,
  "AuthCode": "sample string 3",
  "AvsAddress": "sample string 4",
  "AvsPostalcode": "sample string 5",
  "AvsResultCode": "sample string 6",
  "BalanceAmount": 1.0,
  "BalanceCurrencyCode": "sample string 7",
  "CreatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "CreateLocation": "sample string 8",
  "CreatedBy": "sample string 9",
  "ConstituentId": 1,
  "CvvResultCode": "sample string 10",
  "EcommerceIndicator": "sample string 11",
  "EmvApplicationName": "sample string 12",
  "EmvApplicationIdentifier": "sample string 13",
  "EmvPinVerified": "sample string 14",
  "EmvHostResponseCode": "sample string 15",
  "EmvHostResponseMessage": "sample string 16",
  "EmvCryptogram": "sample string 17",
  "EntryMethod": "sample string 18",
  "ExpirationDate": "sample string 19",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "UpdatedBy": "sample string 20",
  "MerchantId": "sample string 21",
  "Name": "sample string 22",
  "Origin": "sample string 23",
  "PaymentGatewayTransactionType": {
    "CreatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "Description": "sample string 3",
    "Id": 1,
    "Inactive": true,
    "UpdatedDateTime": "2025-04-24T05:01:02.1751202-07:00",
    "UpdatedBy": "sample string 5"
  },
  "PaymentMethodGroupId": 1,
  "PaymentMethodId": 1,
  "PaymentId": 1,
  "ProviderCommunicationDurationMs": 1,
  "ProviderTransactionDateTime": "2025-04-24T05:01:02.1751202-07:00",
  "ReferenceNumber": "sample string 24",
  "ResponseCode": "sample string 25",
  "ResponseMessage": "sample string 26",
  "Success": "sample string 27",
  "TerminalIdentifier": "sample string 28",
  "TotalDurationMs": 1,
  "UserData": "sample string 29",
  "NetworkTransactionId": "sample string 30",
  "ActivityData": "sample string 31"
}
<PaymentGatewayActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountId>1</AccountId>
  <AccountNumber>sample string 1</AccountNumber>
  <ActivityData>sample string 31</ActivityData>
  <Amount>2</Amount>
  <AuthCode>sample string 3</AuthCode>
  <AvsAddress>sample string 4</AvsAddress>
  <AvsPostalcode>sample string 5</AvsPostalcode>
  <AvsResultCode>sample string 6</AvsResultCode>
  <BalanceAmount>1</BalanceAmount>
  <BalanceCurrencyCode>sample string 7</BalanceCurrencyCode>
  <ConstituentId>1</ConstituentId>
  <CreateLocation>sample string 8</CreateLocation>
  <CreatedBy>sample string 9</CreatedBy>
  <CreatedDateTime>2025-04-24T05:01:02.1751202-07:00</CreatedDateTime>
  <CvvResultCode>sample string 10</CvvResultCode>
  <EcommerceIndicator>sample string 11</EcommerceIndicator>
  <EmvApplicationIdentifier>sample string 13</EmvApplicationIdentifier>
  <EmvApplicationName>sample string 12</EmvApplicationName>
  <EmvCryptogram>sample string 17</EmvCryptogram>
  <EmvHostResponseCode>sample string 15</EmvHostResponseCode>
  <EmvHostResponseMessage>sample string 16</EmvHostResponseMessage>
  <EmvPinVerified>sample string 14</EmvPinVerified>
  <EntryMethod>sample string 18</EntryMethod>
  <ExpirationDate>sample string 19</ExpirationDate>
  <Id>1</Id>
  <MerchantId>sample string 21</MerchantId>
  <Name>sample string 22</Name>
  <NetworkTransactionId>sample string 30</NetworkTransactionId>
  <Origin>sample string 23</Origin>
  <PaymentGatewayTransactionType>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T05:01:02.1751202-07:00</CreatedDateTime>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:01:02.1751202-07:00</UpdatedDateTime>
  </PaymentGatewayTransactionType>
  <PaymentId>1</PaymentId>
  <PaymentMethodGroupId>1</PaymentMethodGroupId>
  <PaymentMethodId>1</PaymentMethodId>
  <ProviderCommunicationDurationMs>1</ProviderCommunicationDurationMs>
  <ProviderTransactionDateTime>2025-04-24T05:01:02.1751202-07:00</ProviderTransactionDateTime>
  <ReferenceNumber>sample string 24</ReferenceNumber>
  <ResponseCode>sample string 25</ResponseCode>
  <ResponseMessage>sample string 26</ResponseMessage>
  <Success>sample string 27</Success>
  <TerminalIdentifier>sample string 28</TerminalIdentifier>
  <TotalDurationMs>1</TotalDurationMs>
  <UpdatedBy>sample string 20</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:01:02.1751202-07:00</UpdatedDateTime>
  <UserData>sample string 29</UserData>
</PaymentGatewayActivity>
Change Version Description Contract Old New
Property Removed 15.2.34 PaymentGatewayTransactionTypeId has been removed from PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayTransactionTypeId
Property Added 15.2.34 PaymentGatewayTransactionType has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.PaymentGatewayTransactionType
Property Removed 15.2.34 PaymentGatewayTransactionTypeId has been removed from PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayTransactionTypeId
Property Added 15.2.34 PaymentGatewayTransactionType has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.PaymentGatewayTransactionType
Property Added 15.2.33 ActivityData has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.ActivityData
Property Added 15.2.33 ActivityData has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.ActivityData
Property Added 15.1.13 NetworkTransactionId has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.NetworkTransactionId
Property Added 15.1.13 NetworkTransactionId has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.NetworkTransactionId
Property Removed 15.1.12 NetworkTransactionId has been removed from PaymentGatewayActivity PaymentGatewayActivity NetworkTransactionId
Property Removed 15.1.12 NetworkTransactionId has been removed from PaymentGatewayActivity PaymentGatewayActivity NetworkTransactionId
Property Added 15.1.10 NetworkTransactionId has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.NetworkTransactionId
Property Added 15.1.10 NetworkTransactionId has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.NetworkTransactionId
Property Added 15.1.1 TotalDurationMs has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.TotalDurationMs
Property Added 15.1.1 TotalDurationMs has been added to PaymentGatewayActivity PaymentGatewayActivity PaymentGatewayActivity.TotalDurationMs
Parameter Changed 15.0.0 paymentGatewayActivityId has been marked as required. Required