Reply
All Star
Posts: 1,072
Registered: ‎08-17-2009

New XML API for Transaction Processing

[ Edited ]

Hi again,

 

Today, we're also pleased to announce that we now have an XML API for Transaction Processing. The API, createTransactionRequest, is available now. The guide is still being finalized, but you can review the XSD at https://api.authorize.net/xml/v1/schema/AnetApiSchema.xsd.

And of course, for your convenience, here are the XML examples for the request and response:
---------------------------------------------------------------------
The following is the XML sent for transactions.
---------------------------------------------------------------------

 

<?xml version="1.0" encoding="utf-8"?>
<createTransactionRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd">
  <merchantAuthentication>
    <name>hcwt42</name>
    <transactionKey>123abc</transactionKey>
  </merchantAuthentication>
  <refId>123456</refId>
  <transactionRequest>
    <transactionType>authOnlyTransaction</transactionType>
    <amount>5</amount>
    <payment>
      <creditCard>
        <cardNumber>5424000000000015</cardNumber>
        <expirationDate>1102</expirationDate>
        <cardCode>999</cardCode>
      </creditCard>
    </payment>
    <lineItems>
      <lineItem>
        <itemId>1</itemId>
        <name>vase</name>
        <description>Cannes logo </description>
        <quantity>18</quantity>
        <unitPrice>45.00</unitPrice>
      </lineItem>
    </lineItems>
    <tax>
      <amount>4.26</amount>
      <name>level2 tax name</name>
      <description>level2 tax</description>
    </tax>
    <duty>
      <amount>8.55</amount>
      <name>duty name</name>
      <description>duty description</description>
    </duty>
    <shipping>
      <amount>4.26</amount>
      <name>level2 tax name</name>
      <description>level2 tax</description>
    </shipping>
    <poNumber>456654</poNumber>
    <customer>
      <id>18</id>
      <email>someone@blackhole.tv</email>
    </customer>
    <billTo>
      <firstName>Ellen</firstName>
      <lastName>Johnson</lastName>
      <company>Souveniropolis</company>
      <address>14 Main Street</address>
      <city>Pecan Springs</city>
      <state>TX</state>
      <zip>44628</zip>
      <country>USA</country>
    </billTo>
    <shipTo>
      <firstName>China</firstName>
      <lastName>Bayles</lastName>
      <company>Thyme for Tea</company>
      <address>12 Main Street</address>
      <city>Pecan Springs</city>
      <state>TX</state>
      <zip>44628</zip>
      <country>USA</country>
    </shipTo>
    <customerIP>192.168.1.1</customerIP>
    <transactionSettings>
      <setting>
        <settingName>allowPartialAuth</settingName>
        <settingValue>false</settingValue>
      </setting>
      <setting>
        <settingName>duplicateWindow</settingName>
        <settingValue>0</settingValue>
      </setting>
      <setting>
        <settingName>emailCustomer</settingName>
        <settingValue>false</settingValue>
      </setting>
      <setting>
        <settingName>recurringBilling</settingName>
        <settingValue>false</settingValue>
      </setting>
      <setting>
        <settingName>testRequest</settingName>
        <settingValue>false</settingValue>
      </setting>
    </transactionSettings>
    <userFields>
      <userField>
        <name>MerchantDefinedFieldName1</name>
        <value>MerchantDefinedFieldValue1</value>
      </userField>
      <userField>
        <name>favorite_color</name>
        <value>blue</value>
      </userField>
    </userFields>
  </transactionRequest>
</createTransactionRequest>

 

 ---------------------------------------------------------------------------
The following is the XML response for transactions.
----------------------------------------------------------------------------

 

<?xml version="1.0" encoding="utf-8"?>
<createTransactionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetA
piSchema.xsd">
  <refId>123456</refId>
  <messages>
    <resultCode>Ok</resultCode>
    <message>
      <code>I00001</code>
      <text>Successful.</text>
    </message>
  </messages>
  <transactionResponse>
    <responseCode>1</responseCode>
    <authCode>UGELQC</authCode>
    <avsResultCode>E</avsResultCode>
    <cavvResultCode />
    <transId>2148061808</transId>
    <refTransID />
    <transHash>0B428D8A928AAC61121AF2F6EAC5FF3F</transHash>
    <testRequest>0</testRequest>
    <accountNumber>XXXX0015</accountNumber>
    <accountType>MasterCard</accountType>
    <message>
      <code>1</code>
      <description>This transaction has been approved.</description>
    </message>
    <userFields>
      <userField>
        <name>MerchantDefinedFieldName1</name>
        <value>MerchantDefinedFieldValue1</value>
      </userField>
      <userField>
        <name>favorite_color</name>
        <value>lavender</value>
      </userField>
    </userFields>
  </transactionResponse>
</createTransactionResponse>

 

We hope this new method of submitting transactions is useful.

Thanks,

Michelle
Developer Community Manager

All Star
Posts: 1,072
Registered: ‎08-17-2009

Re: New XML API for Transaction Processing

Don't think I ever updated this post with the final guide. My bad. Here it is!

 

http://www.authorize.net/support/AIM_guide_XML.pdf

 

Thanks,

 

Michelle

Developer Community Manager