Resource Details

PaymentGateway/Authorization/Link/{paymentId}/Confirm

NOTE: THIS IS FOR TESSITURA USE ONLY. Custom implementations of this endpoint are not supported.

Check to see if a Pay by Link has been authorized. For Tessitura Merchant Services only.

Http Verb	POST
Resource URL	https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/Authorization/Link/{paymentId}/Confirm

URI Parameters

Parameter Name	Data Type	Required	Notes
paymentId	integer	Y

Request Body

Request object type : PayByLinkAuthorizationRequest

Request object type PayByLinkAuthorizationRequest has the following properties.

Property Name	Data Type	Length	Required	Readonly	Notes
BypassNotificationEventCheck	boolean		Y

application/json, text/json
application/xml, text/xml

{
  "BypassNotificationEventCheck": true
}

<PayByLinkAuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BypassNotificationEventCheck>true</BypassNotificationEventCheck>
</PayByLinkAuthorizationRequest>

Response object type : PayByLinkAuthorizationResponse

Response object type PayByLinkAuthorizationResponse has the following properties.

Property Name	Data Type	Required	Notes
AccountId	integer	N	AccountId used in transaction. This could be set on the response, even if it were not set on the request, since, depending on settings, the card might be stored during the request.
AccountId	FK: T_ACCOUNT_DATA.id Resource: Accounts
AuthorizationCode	string		Generated by the cardholder's bank, or an echo of a manual/force auth code, if one was provided in the AuthorizationRequest.
AuthorizedAmount	decimal number		May be lower than requested amount if IsPartialAuth is set.
AVSResponseCode	string		The degree to which BillingAddress matches the one on the cardholder's account.
BalanceAmount	decimal number		Remaining card balance may be set for partially authorized transactions (Vantiv).
BalanceCurrencyCode	string		Currency of remaining card balance may be set for partially authorized transactions (Vantiv).
CardHolderName	string
CardNumber	string
CVVResponseCode	string		The status of whether the CVV matched the one on the cardholder's account.
IsPartialAuth	boolean		Authorized amount was less than the requested amount. (Vantiv).
IsPending	boolean		Indicates whether an authorization response has been received (false).
MaskedCardNumber	string		Masked number of the credit card used. Used for Tessitura Merchant Services only.
PaymentMethod	PaymentMethod		PaymentMethod used in transaction. Could have changed from request based on card mnemonic.
ReferenceNumber	string		Used in subsequent reversal or refund requests or inquiries.
ResponseCode	string		A "SUCCESS" value (MasterCard) or zero "0" value (other gateways) indicates a successful transaction.
ResponseMessage	string		Sometimes includes more detailed information about the response than the ResponseCode.
ShopperIp	string		Previously provided IP Address of the end-user. Formatting may have changed slightly (leading / trailing zeros in octects). Used for Tessitura Merchant Services only.
Succeeded	boolean		Success (true) or failure (false) of the authorization request. Use this value, rather than ResponseCode, to interpret the disposition of the request.
TessituraMerchantServicesAction	string		A base64 encoded payload containing a Tessitura Merchant Services Action to pass through to Payment Component. For more details, see the Payment Component documentation here: https://bitbucket.org/TN_WebShare/tessituramerchantservicesintegrationsample/.

application/json, text/json
application/xml, text/xml

{
  "IsPending": true,
  "CardNumber": "sample string 2",
  "CardHolderName": "sample string 3",
  "ResponseCode": "sample string 4",
  "ResponseMessage": "sample string 5",
  "AuthorizationCode": "sample string 6",
  "ReferenceNumber": "sample string 7",
  "AccountId": 8,
  "CVVResponseCode": "sample string 9",
  "AVSResponseCode": "sample string 10",
  "Succeeded": true,
  "IsPartialAuth": true,
  "AuthorizedAmount": 13.0,
  "BalanceAmount": 14.0,
  "BalanceCurrencyCode": "sample string 15",
  "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-24T09:17:32.8243091-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-24T09:17:32.8243091-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 16",
  "ShopperIp": "sample string 17",
  "MaskedCardNumber": "sample string 18"
}

<PayByLinkAuthorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AVSResponseCode>sample string 10</AVSResponseCode>
  <AccountId>8</AccountId>
  <AuthorizationCode>sample string 6</AuthorizationCode>
  <AuthorizedAmount>13</AuthorizedAmount>
  <BalanceAmount>14</BalanceAmount>
  <BalanceCurrencyCode>sample string 15</BalanceCurrencyCode>
  <CVVResponseCode>sample string 9</CVVResponseCode>
  <IsPartialAuth>true</IsPartialAuth>
  <MaskedCardNumber>sample string 18</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-24T09:17:32.8243091-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-24T09:17:32.8243091-07:00</UpdatedDateTime>
    <UseWithCardReader>true</UseWithCardReader>
  </PaymentMethod>
  <ReferenceNumber>sample string 7</ReferenceNumber>
  <ResponseCode>sample string 4</ResponseCode>
  <ResponseMessage>sample string 5</ResponseMessage>
  <ShopperIp>sample string 17</ShopperIp>
  <Succeeded>true</Succeeded>
  <TessituraMerchantServicesAction>sample string 16</TessituraMerchantServicesAction>
  <CardHolderName>sample string 3</CardHolderName>
  <CardNumber>sample string 2</CardNumber>
  <IsPending>true</IsPending>
</PayByLinkAuthorizationResponse>

Change	Version	Description	Contract	Old	New
Property Added	15.2.37	MaskedCardNumber has been added to PayByLinkAuthorizationResponse	PayByLinkAuthorizationResponse		PayByLinkAuthorizationResponse.MaskedCardNumber
Property Changed	15.2.36	PaymentMethod has changed from PaymentMethodSummary to PaymentMethod	PayByLinkAuthorizationResponse	PaymentMethodSummary	PaymentMethod
Property Added	15.2.36	ShopperIp has been added to PayByLinkAuthorizationResponse	PayByLinkAuthorizationResponse		PayByLinkAuthorizationResponse.ShopperIp
Operation Added	15.2.33	ConfirmPayByLink has been added.			ConfirmPayByLink