Authorization Test
PaymentGateway/Authorization/{referenceNumber}/Reverse
Reverse a payment authorization using its reference number.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/PaymentGateway/Authorization/{referenceNumber}/Reverse

URI Parameters

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

Request Body

Request object type : ReversalRequest

Request object type ReversalRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y Amount from original Authorization
Card CardData N Card details are only required when using SecureCXL
ConstituentId integer N
FK: T_CUSTOMER.customer_no   Resource: Constituents
IsECommerce boolean N True if online transaction
IsElementDebit boolean N True if debit transaction processed by Vantiv ip320/350 Encrypted Reader
IsSwiped boolean N True if transaction was swiped
PaymentId integer Y PaymentId from original Authorization
FK: T_PAYMENT.payment_no   Resource: Payments
PaymentMethodId integer Y 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. 
{
  "PaymentId": 1,
  "Amount": 2.0,
  "PaymentMethodId": 3,
  "ConstituentId": 1,
  "TransactionOrigin": "sample string 4",
  "Card": {
    "CardHolderName": "sample string 1",
    "CardNumber": "sample string 2",
    "Cvv2": "sample string 3",
    "ExpirationDate": "sample string 4",
    "Track1": "sample string 5",
    "Track2": "sample string 6",
    "VantivEncryptedCard": {
      "Version": "sample string 1",
      "vantivDevice": {
        "DvcType": "sample string 1",
        "DvcSN": "sample string 2",
        "Entry": "sample string 3"
      },
      "vantivCard": {
        "ECData": "sample string 1",
        "ETrk1": "sample string 2",
        "ETrk2": "sample string 3",
        "CDataKSN": "sample string 4",
        "DbtKSN": "sample string 5",
        "DbtPINB": "sample string 6",
        "Exp": "sample string 7",
        "MskPAN": "sample string 8",
        "CHolder": "sample string 9",
        "EFormat": "sample string 10"
      },
      "vantivAddr": {
        "AvsAddr": "sample string 1",
        "AvsZip": "sample string 2"
      },
      "vantivTran": {
        "TranType": "sample string 1"
      }
    },
    "AccountId": 1,
    "TessituraMerchantServicesData": "sample string 7"
  },
  "IsECommerce": true,
  "IsSwiped": true,
  "IsElementDebit": true,
  "UserData": "sample string 8"
}
<ReversalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>2</Amount>
  <Card>
    <AccountId>1</AccountId>
    <CardHolderName>sample string 1</CardHolderName>
    <CardNumber>sample string 2</CardNumber>
    <Cvv2>sample string 3</Cvv2>
    <ExpirationDate>sample string 4</ExpirationDate>
    <TessituraMerchantServicesData>sample string 7</TessituraMerchantServicesData>
    <Track1>sample string 5</Track1>
    <Track2>sample string 6</Track2>
    <VantivEncryptedCard>
      <Version>sample string 1</Version>
      <vantivAddr>
        <AvsAddr>sample string 1</AvsAddr>
        <AvsZip>sample string 2</AvsZip>
      </vantivAddr>
      <vantivCard>
        <CDataKSN>sample string 4</CDataKSN>
        <CHolder>sample string 9</CHolder>
        <DbtKSN>sample string 5</DbtKSN>
        <DbtPINB>sample string 6</DbtPINB>
        <ECData>sample string 1</ECData>
        <EFormat>sample string 10</EFormat>
        <ETrk1>sample string 2</ETrk1>
        <ETrk2>sample string 3</ETrk2>
        <Exp>sample string 7</Exp>
        <MskPAN>sample string 8</MskPAN>
      </vantivCard>
      <vantivDevice>
        <DvcSN>sample string 2</DvcSN>
        <DvcType>sample string 1</DvcType>
        <Entry>sample string 3</Entry>
      </vantivDevice>
      <vantivTran>
        <TranType>sample string 1</TranType>
      </vantivTran>
    </VantivEncryptedCard>
  </Card>
  <ConstituentId>1</ConstituentId>
  <IsECommerce>true</IsECommerce>
  <IsElementDebit>true</IsElementDebit>
  <IsSwiped>true</IsSwiped>
  <PaymentId>1</PaymentId>
  <PaymentMethodId>3</PaymentMethodId>
  <TransactionOrigin>sample string 4</TransactionOrigin>
  <UserData>sample string 8</UserData>
</ReversalRequest>

Response object type : ReversalResponse

Response object type ReversalResponse 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 reversal request. Use this value, rather than ResponseCode, to interpret the disposition of the request. 
{
  "ResponseMessage": "sample string 1",
  "ResponseCode": "sample string 2",
  "Succeeded": true
}
<ReversalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseMessage>sample string 1</ResponseMessage>
  <Succeeded>true</Succeeded>
</ReversalResponse>

No entries in change log for this operation.