POST api/AuthorizePayment

Returns authorization response for use with TMS.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Amount		decimal number
PaymentId		integer
ConstituentId		integer
Card		CardData
ThreeDSecureData		ThreeDSecureData
BillingAddress		BillingAddress
AuthorizationCode		string
ReferenceNumber		string
TransactionOrigin		string
PaymentMethodId		integer
IsECommerce		boolean
IsRecurring		boolean
AllowPartialAuth		boolean
UserData		string
StoreAccount		boolean
ReturnUrl		string
ShopperIp		string
DeliveryDate		date
ShopperEmail		string
ShopperName		ShopperName

Request Formats

application/json, text/json

Sample:

{
  "Amount": 1.0,
  "PaymentId": 2,
  "ConstituentId": 1,
  "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"
  },
  "ThreeDSecureData": {
    "EciIndicatorType": "sample string 1",
    "SecureTransactionId": "sample string 2",
    "SecureTransactionSecurity": "sample string 3",
    "VerAuthValue": "sample string 4",
    "VerCertificateSerialCardHolder": "sample string 5",
    "VerCertificateSerialCardAcceptor": "sample string 6",
    "VerHashResult": "sample string 7",
    "MpiSessionId": "sample string 8"
  },
  "BillingAddress": {
    "PostalCode": "sample string 1",
    "Street1": "sample string 2",
    "AddressId": 1,
    "Country": "sample string 3"
  },
  "AuthorizationCode": "sample string 3",
  "ReferenceNumber": "sample string 4",
  "TransactionOrigin": "sample string 5",
  "PaymentMethodId": 6,
  "IsECommerce": true,
  "IsRecurring": true,
  "AllowPartialAuth": true,
  "UserData": "sample string 10",
  "StoreAccount": true,
  "ReturnUrl": "sample string 11",
  "ShopperIp": "sample string 12",
  "DeliveryDate": "2024-12-05T03:25:43.9878941+00:00",
  "ShopperEmail": "sample string 13",
  "ShopperName": {
    "<FirstName>k__BackingField": "sample string 1",
    "<LastName>k__BackingField": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<AuthorizationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tessitura.Service.Contract">
  <AllowPartialAuth>true</AllowPartialAuth>
  <Amount>1</Amount>
  <AuthorizationCode>sample string 3</AuthorizationCode>
  <BillingAddress>
    <AddressId>1</AddressId>
    <Country>sample string 3</Country>
    <PostalCode>sample string 1</PostalCode>
    <Street1>sample string 2</Street1>
  </BillingAddress>
  <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>
  <DeliveryDate>2024-12-05T03:25:43.9878941+00:00</DeliveryDate>
  <IsECommerce>true</IsECommerce>
  <IsRecurring>true</IsRecurring>
  <PaymentId>2</PaymentId>
  <PaymentMethodId>6</PaymentMethodId>
  <ReferenceNumber>sample string 4</ReferenceNumber>
  <ReturnUrl>sample string 11</ReturnUrl>
  <ShopperEmail>sample string 13</ShopperEmail>
  <ShopperIp>sample string 12</ShopperIp>
  <ShopperName>
    <_x003C_FirstName_x003E_k__BackingField>sample string 1</_x003C_FirstName_x003E_k__BackingField>
    <_x003C_LastName_x003E_k__BackingField>sample string 2</_x003C_LastName_x003E_k__BackingField>
  </ShopperName>
  <StoreAccount>true</StoreAccount>
  <ThreeDSecureData>
    <EciIndicatorType>sample string 1</EciIndicatorType>
    <MpiSessionId>sample string 8</MpiSessionId>
    <SecureTransactionId>sample string 2</SecureTransactionId>
    <SecureTransactionSecurity>sample string 3</SecureTransactionSecurity>
    <VerAuthValue>sample string 4</VerAuthValue>
    <VerCertificateSerialCardAcceptor>sample string 6</VerCertificateSerialCardAcceptor>
    <VerCertificateSerialCardHolder>sample string 5</VerCertificateSerialCardHolder>
    <VerHashResult>sample string 7</VerHashResult>
  </ThreeDSecureData>
  <TransactionOrigin>sample string 5</TransactionOrigin>
  <UserData>sample string 10</UserData>
</AuthorizationRequest>

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 'AuthorizationRequest'.

Response Information

Resource Description

PaymentComponentResponse object

ApiSuccessOfAuthorizationResponse

Name	Description	Type	Additional information
Success		boolean
Data		AuthorizationResponse

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "ResponseCode": "sample string 1",
    "ResponseMessage": "sample string 2",
    "AuthorizationCode": "sample string 3",
    "ReferenceNumber": "sample string 4",
    "AccountId": 5,
    "CVVResponseCode": "sample string 6",
    "AVSResponseCode": "sample string 7",
    "Succeeded": true,
    "IsPartialAuth": true,
    "AuthorizedAmount": 10.0,
    "BalanceAmount": 11.0,
    "BalanceCurrencyCode": "sample string 12",
    "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": "2024-12-05T03:25:44.0035177+00: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": "2024-12-05T03:25:44.0035177+00: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>k__BackingField": "sample string 1",
        "<Id>k__BackingField": 2,
        "<Inactive>k__BackingField": true
      }
    },
    "TessituraMerchantServicesAction": "sample string 13",
    "ShopperIp": "sample string 14",
    "MaskedCardNumber": "sample string 15"
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfAuthorizationResponseuXxnEBFU 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:AVSResponseCode>sample string 7</d2p1:AVSResponseCode>
    <d2p1:AccountId>5</d2p1:AccountId>
    <d2p1:AuthorizationCode>sample string 3</d2p1:AuthorizationCode>
    <d2p1:AuthorizedAmount>10</d2p1:AuthorizedAmount>
    <d2p1:BalanceAmount>11</d2p1:BalanceAmount>
    <d2p1:BalanceCurrencyCode>sample string 12</d2p1:BalanceCurrencyCode>
    <d2p1:CVVResponseCode>sample string 6</d2p1:CVVResponseCode>
    <d2p1:IsPartialAuth>true</d2p1:IsPartialAuth>
    <d2p1:MaskedCardNumber>sample string 15</d2p1:MaskedCardNumber>
    <d2p1:PaymentMethod>
      <d2p1:AccountType>
        <d2p1:CardPrefix>sample string 2</d2p1:CardPrefix>
        <d2p1:CardtypeIndicator>sample string 3</d2p1:CardtypeIndicator>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:EditMask>sample string 4</d2p1:EditMask>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
      </d2p1:AccountType>
      <d2p1:AuthIndicator>true</d2p1:AuthIndicator>
      <d2p1:BusinessUnitId>2</d2p1:BusinessUnitId>
      <d2p1:CanRefund>true</d2p1:CanRefund>
      <d2p1:ControlGroup>
        <d2p1:_x003C_Description_x003E_k__BackingField>sample string 1</d2p1:_x003C_Description_x003E_k__BackingField>
        <d2p1:_x003C_Id_x003E_k__BackingField>2</d2p1:_x003C_Id_x003E_k__BackingField>
        <d2p1:_x003C_Inactive_x003E_k__BackingField>true</d2p1:_x003C_Inactive_x003E_k__BackingField>
      </d2p1:ControlGroup>
      <d2p1:CreateLocation>sample string 4</d2p1:CreateLocation>
      <d2p1:CreatedBy>sample string 5</d2p1:CreatedBy>
      <d2p1:CreatedDateTime>2024-12-05T03:25:44.0035177+00:00</d2p1:CreatedDateTime>
      <d2p1:CurrencyTypeId>1</d2p1:CurrencyTypeId>
      <d2p1:DefaultIndicator>true</d2p1:DefaultIndicator>
      <d2p1:Description>sample string 7</d2p1:Description>
      <d2p1:GiftAidIndicator>true</d2p1:GiftAidIndicator>
      <d2p1:GlAccountId>sample string 19</d2p1:GlAccountId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:Income>true</d2p1:Income>
      <d2p1:MerchantId>sample string 20</d2p1:MerchantId>
      <d2p1:MerchantIdForSwipe>sample string 21</d2p1:MerchantIdForSwipe>
      <d2p1:NoCopiesOnAuth>1</d2p1:NoCopiesOnAuth>
      <d2p1:NoCopiesOnSave>1</d2p1:NoCopiesOnSave>
      <d2p1:OpenCashDrawer>true</d2p1:OpenCashDrawer>
      <d2p1:PaymentMethodGroup>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Inactive>true</d2p1:Inactive>
        <d2p1:MerchantId>sample string 3</d2p1:MerchantId>
      </d2p1:PaymentMethodGroup>
      <d2p1:PaymentType>
        <d2p1:Description>sample string 1</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
      </d2p1:PaymentType>
      <d2p1:ReceiptFormatId>1</d2p1:ReceiptFormatId>
      <d2p1:RequireCheckIndicator>true</d2p1:RequireCheckIndicator>
      <d2p1:RequireCvv>true</d2p1:RequireCvv>
      <d2p1:RequirePostalCode>sample string 13</d2p1:RequirePostalCode>
      <d2p1:ShortDesc>sample string 14</d2p1:ShortDesc>
      <d2p1:StoreTenderedAmount>true</d2p1:StoreTenderedAmount>
      <d2p1:UpdatedBy>sample string 12</d2p1:UpdatedBy>
      <d2p1:UpdatedDateTime>2024-12-05T03:25:44.0035177+00:00</d2p1:UpdatedDateTime>
      <d2p1:UseWithCardReader>true</d2p1:UseWithCardReader>
    </d2p1:PaymentMethod>
    <d2p1:ReferenceNumber>sample string 4</d2p1:ReferenceNumber>
    <d2p1:ResponseCode>sample string 1</d2p1:ResponseCode>
    <d2p1:ResponseMessage>sample string 2</d2p1:ResponseMessage>
    <d2p1:ShopperIp>sample string 14</d2p1:ShopperIp>
    <d2p1:Succeeded>true</d2p1:Succeeded>
    <d2p1:TessituraMerchantServicesAction>sample string 13</d2p1:TessituraMerchantServicesAction>
  </Data>
</ApiSuccessOfAuthorizationResponseuXxnEBFU>