Authorization Test
PaymentGateway/Authorization/{referenceNumber}/Confirm
Confirm an authorization using its reference number. For all gateways, this results in a confirm transaction being written to T_PAYMENT_GATEWAY_ACTIVITY. For EPay gateway, the confirm endpoint also sends a capture transaction.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/Authorization/{referenceNumber}/Confirm

URI Parameters

Parameter Name Data Type Required Notes
referenceNumber string Y Obtained from ReferenceNumber in the Authorization endpoint.

Request Body

Request object type : ConfirmAuthorizationRequest

Request object type ConfirmAuthorizationRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount from original Authorization
IsECommerce boolean N True if online transaction
PaymentId integer Y PaymentId from original Authorization
FK: T_PAYMENT.payment_no   Resource: Payments
PaymentMethodId integer N Payment method from original authorization
FK: TR_PAYMENT_METHOD.id   Resource: PaymentMethods
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.
UserData string 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,
  "PaymentId": 2,
  "TransactionOrigin": "sample string 3",
  "PaymentMethodId": 4,
  "IsECommerce": true,
  "UserData": "sample string 6"
}
<ConfirmAuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <IsECommerce>true</IsECommerce>
  <PaymentId>2</PaymentId>
  <PaymentMethodId>4</PaymentMethodId>
  <TransactionOrigin>sample string 3</TransactionOrigin>
  <UserData>sample string 6</UserData>
</ConfirmAuthorizationRequest>

Response object type : ConfirmAuthorizationResponse

Response object type ConfirmAuthorizationResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
ResponseCode string Sometimes includes more detailed information about the response than the ResponseCode.
ResponseMessage string A "SUCCESS" value (MasterCard) or zero "0" value (other gateways) indicates a successful transaction.
Succeeded boolean Success (true) or failure (false) of the confirmation request. Use this value, rather than ResponseCode, to interpret the disposition of the request. 
{
  "ResponseMessage": "sample string 1",
  "ResponseCode": "sample string 2",
  "Succeeded": true
}
<ConfirmAuthorizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 1</ResponseMessage>
  <Succeeded>true</Succeeded>
</ConfirmAuthorizationResponse>

No entries in change log for this operation.