POST api/ReverseAuthorization

Reverses a payment authorization

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ReferenceNumber		string	Required
ReversalData		ReversalRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "ReferenceNumber": "sample string 1",
  "ReversalData": {
    "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"
  }
}

application/xml, text/xml

Sample:

<ReverseAuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Payment">
  <ReferenceNumber>sample string 1</ReferenceNumber>
  <ReversalData xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
    <d2p1:Amount>2</d2p1:Amount>
    <d2p1:Card>
      <d2p1:AccountId>1</d2p1:AccountId>
      <d2p1:CardHolderName>sample string 1</d2p1:CardHolderName>
      <d2p1:CardNumber>sample string 2</d2p1:CardNumber>
      <d2p1:Cvv2>sample string 3</d2p1:Cvv2>
      <d2p1:ExpirationDate>sample string 4</d2p1:ExpirationDate>
      <d2p1:TessituraMerchantServicesData>sample string 7</d2p1:TessituraMerchantServicesData>
      <d2p1:Track1>sample string 5</d2p1:Track1>
      <d2p1:Track2>sample string 6</d2p1:Track2>
      <d2p1:VantivEncryptedCard>
        <d2p1:Version>sample string 1</d2p1:Version>
        <d2p1:vantivAddr>
          <d2p1:AvsAddr>sample string 1</d2p1:AvsAddr>
          <d2p1:AvsZip>sample string 2</d2p1:AvsZip>
        </d2p1:vantivAddr>
        <d2p1:vantivCard>
          <d2p1:CDataKSN>sample string 4</d2p1:CDataKSN>
          <d2p1:CHolder>sample string 9</d2p1:CHolder>
          <d2p1:DbtKSN>sample string 5</d2p1:DbtKSN>
          <d2p1:DbtPINB>sample string 6</d2p1:DbtPINB>
          <d2p1:ECData>sample string 1</d2p1:ECData>
          <d2p1:EFormat>sample string 10</d2p1:EFormat>
          <d2p1:ETrk1>sample string 2</d2p1:ETrk1>
          <d2p1:ETrk2>sample string 3</d2p1:ETrk2>
          <d2p1:Exp>sample string 7</d2p1:Exp>
          <d2p1:MskPAN>sample string 8</d2p1:MskPAN>
        </d2p1:vantivCard>
        <d2p1:vantivDevice>
          <d2p1:DvcSN>sample string 2</d2p1:DvcSN>
          <d2p1:DvcType>sample string 1</d2p1:DvcType>
          <d2p1:Entry>sample string 3</d2p1:Entry>
        </d2p1:vantivDevice>
        <d2p1:vantivTran>
          <d2p1:TranType>sample string 1</d2p1:TranType>
        </d2p1:vantivTran>
      </d2p1:VantivEncryptedCard>
    </d2p1:Card>
    <d2p1:ConstituentId>1</d2p1:ConstituentId>
    <d2p1:IsECommerce>true</d2p1:IsECommerce>
    <d2p1:IsElementDebit>true</d2p1:IsElementDebit>
    <d2p1:IsSwiped>true</d2p1:IsSwiped>
    <d2p1:PaymentId>1</d2p1:PaymentId>
    <d2p1:PaymentMethodId>3</d2p1:PaymentMethodId>
    <d2p1:TransactionOrigin>sample string 4</d2p1:TransactionOrigin>
    <d2p1:UserData>sample string 8</d2p1:UserData>
  </ReversalData>
</ReverseAuthorizationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ReverseAuthorizationRequest'.

Response Information

Resource Description

ReversalResponse object

ApiSuccessOfReversalResponse

Name	Description	Type	Additional information
Success		boolean
Data		ReversalResponse

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ResponseMessage": "sample string 1",
    "ResponseCode": "sample string 2",
    "Succeeded": true
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfReversalResponseuXxnEBFU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
    <d2p1:ResponseCode>sample string 2</d2p1:ResponseCode>
    <d2p1:ResponseMessage>sample string 1</d2p1:ResponseMessage>
    <d2p1:Succeeded>true</d2p1:Succeeded>
  </Data>
</ApiSuccessOfReversalResponseuXxnEBFU>