Authorization Test
PaymentGateway/Authorization/Link
NOTE: THIS IS FOR TESSITURA USE ONLY. Custom implementations of this endpoint are not supported.

Create a payment link to a hosted payment form where shoppers can pay. For Tessitura Merchant Services only.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/Authorization/Link

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : PayByLinkRequest

Request object type PayByLinkRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowedPaymentMethods Collection of string N
Amount decimal number Y
ConstituentId integer Y
CountryCode string 2 N
Currency string N
Description string 280 N
IsECommerce boolean Y Set to true for online transactions. Defaults to false.
LinkExpiry date N
Locale string N
MerchantId string Y
PaymentId integer Y
FK: T_PAYMENT.payment_no   Resource: Payments
StoreAccount boolean N
TransactionOrigin string 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. 
{
  "PaymentId": 1,
  "ConstituentId": 1,
  "MerchantId": "sample string 2",
  "Amount": 3.0,
  "Currency": "sample string 4",
  "Description": "sample string 5",
  "CountryCode": "sample string 6",
  "Locale": "sample string 7",
  "AllowedPaymentMethods": [
    "sample string 1",
    "sample string 2"
  ],
  "LinkExpiry": "2025-10-28T18:48:58.861221-07:00",
  "StoreAccount": true,
  "TransactionOrigin": "sample string 8",
  "IsECommerce": true
}
<PayByLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AllowedPaymentMethods>
    <AllowPaymentMethod>sample string 1</AllowPaymentMethod>
    <AllowPaymentMethod>sample string 2</AllowPaymentMethod>
  </AllowedPaymentMethods>
  <Amount>3</Amount>
  <ConstituentId>1</ConstituentId>
  <CountryCode>sample string 6</CountryCode>
  <Currency>sample string 4</Currency>
  <Description>sample string 5</Description>
  <IsECommerce>true</IsECommerce>
  <LinkExpiry>2025-10-28T18:48:58.861221-07:00</LinkExpiry>
  <Locale>sample string 7</Locale>
  <MerchantId>sample string 2</MerchantId>
  <PaymentId>1</PaymentId>
  <StoreAccount>true</StoreAccount>
  <TransactionOrigin>sample string 8</TransactionOrigin>
</PayByLinkRequest>

Response object type : PayByLinkResponse

Response object type PayByLinkResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
AllowedPaymentMethods Collection of string
Amount decimal number
ConstituentId integer
CountryCode string
Description string
LinkExpiry date
LinkId string
MerchantId string
MerchantReference string
PaymentId integer
StoreAccount boolean
Url string 
{
  "PaymentId": 1,
  "ConstituentId": 1,
  "MerchantId": "sample string 2",
  "MerchantReference": "sample string 3",
  "Amount": 4.0,
  "Description": "sample string 5",
  "CountryCode": "sample string 6",
  "AllowedPaymentMethods": [
    "sample string 1",
    "sample string 2"
  ],
  "Url": "sample string 7",
  "LinkId": "sample string 8",
  "LinkExpiry": "2025-10-28T18:48:58.8768449-07:00",
  "StoreAccount": true
}
<PayByLinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AllowedPaymentMethods>
    <AllowPaymentMethod>sample string 1</AllowPaymentMethod>
    <AllowPaymentMethod>sample string 2</AllowPaymentMethod>
  </AllowedPaymentMethods>
  <Amount>4</Amount>
  <ConstituentId>1</ConstituentId>
  <CountryCode>sample string 6</CountryCode>
  <Description>sample string 5</Description>
  <LinkExpiry>2025-10-28T18:48:58.8768449-07:00</LinkExpiry>
  <LinkId>sample string 8</LinkId>
  <MerchantId>sample string 2</MerchantId>
  <MerchantReference>sample string 3</MerchantReference>
  <PaymentId>1</PaymentId>
  <StoreAccount>true</StoreAccount>
  <Url>sample string 7</Url>
</PayByLinkResponse>
Change Version Description Contract Old New
Operation Added 15.2.33 Link has been added. Link