Cart Test
Web/Cart/{sessionKey}/Payments/EMV/Authorize
Authorize payment using a card reader in a web based transaction.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Payments/EMV/Authorize

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : WebEmvAuthorizationRequest

Request object type WebEmvAuthorizationRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount to authorize. Use a positive amount to indicate a purchase, and a negative amount to indicate a refund.
IsMoto boolean Y Set to true if the EMV device requires MOTO mode to be triggered via an API call.
MachineId integer Y The machine Id to use to look up EMV settings and configuration for this request.
FK: TR_MACHINE_SETTINGS.Id   Resource: MachineSettings
TransactionOrigin string 20 Y Text indicating the origin of the transaction. The text will be written to T_PAYMENT_GATEWAY_ACTIVITY.origin if payment card tokenization is enabled.
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. 
{
  "Amount": 1.0,
  "TransactionOrigin": "sample string 2",
  "UserData": "sample string 3",
  "MachineId": 4,
  "IsMoto": true
}
<WebEmvAuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <IsMoto>true</IsMoto>
  <MachineId>4</MachineId>
  <TransactionOrigin>sample string 2</TransactionOrigin>
  <UserData>sample string 3</UserData>
</WebEmvAuthorizationRequest>

Response object type : WebEmvAuthorizationResponse

Response object type WebEmvAuthorizationResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
AuthorizationResponse AuthorizationResponse
EmvStatus EMVStatus
PaymentId integer 
{
  "PaymentId": 1,
  "AuthorizationResponse": {
    "ResponseCode": "sample string 1",
    "ResponseMessage": "sample string 2",
    "AuthorizationCode": "sample string 3",
    "ReferenceNumber": "sample string 4",
    "AccountId": 5,
    "CVVResponseCode": "sample string 6",
    "AVSResponseCode": "sample string 7",
    "Succeeded": true,
    "IsPartialAuth": true,
    "AuthorizedAmount": 10.0,
    "BalanceAmount": 11.0,
    "BalanceCurrencyCode": "sample string 12",
    "PaymentMethod": {
      "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-24T08:48:37.9809807-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-24T08:48:37.9809807-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
      }
    },
    "TessituraMerchantServicesAction": "sample string 13",
    "ShopperIp": "sample string 14",
    "MaskedCardNumber": "sample string 15"
  },
  "EmvStatus": {
    "Status": "sample string 1",
    "CardMnemonic": "sample string 2",
    "SignatureRequired": true,
    "AccountNumber": "sample string 4",
    "CardHolderName": "sample string 5",
    "DpsTxnRef": "sample string 6",
    "AuthCode": "sample string 7",
    "Succeeded": true,
    "AccountId": 9,
    "PaymentId": 10
  }
}
<WebEmvAuthorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AuthorizationResponse>
    <AVSResponseCode>sample string 7</AVSResponseCode>
    <AccountId>5</AccountId>
    <AuthorizationCode>sample string 3</AuthorizationCode>
    <AuthorizedAmount>10</AuthorizedAmount>
    <BalanceAmount>11</BalanceAmount>
    <BalanceCurrencyCode>sample string 12</BalanceCurrencyCode>
    <CVVResponseCode>sample string 6</CVVResponseCode>
    <IsPartialAuth>true</IsPartialAuth>
    <MaskedCardNumber>sample string 15</MaskedCardNumber>
    <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-24T08:48:37.9809807-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-24T08:48:37.9809807-07:00</UpdatedDateTime>
      <UseWithCardReader>true</UseWithCardReader>
    </PaymentMethod>
    <ReferenceNumber>sample string 4</ReferenceNumber>
    <ResponseCode>sample string 1</ResponseCode>
    <ResponseMessage>sample string 2</ResponseMessage>
    <ShopperIp>sample string 14</ShopperIp>
    <Succeeded>true</Succeeded>
    <TessituraMerchantServicesAction>sample string 13</TessituraMerchantServicesAction>
  </AuthorizationResponse>
  <EmvStatus>
    <AccountId>9</AccountId>
    <AccountNumber>sample string 4</AccountNumber>
    <AuthCode>sample string 7</AuthCode>
    <CardHolderName>sample string 5</CardHolderName>
    <CardMnemonic>sample string 2</CardMnemonic>
    <DpsTxnRef>sample string 6</DpsTxnRef>
    <PaymentId>10</PaymentId>
    <SignatureRequired>true</SignatureRequired>
    <Status>sample string 1</Status>
    <Succeeded>true</Succeeded>
  </EmvStatus>
  <PaymentId>1</PaymentId>
</WebEmvAuthorizationResponse>
Change Version Description Contract Old New
Operation Added 15.2.33 Authorize has been added. Authorize