API Enhancement Help Center

Cayan is constantly offering new products and features for you and your customers by keeping our APIs flexible and future-proof. To do this, we need you to help by designing your software to be similarly flexible and prepared for any changes we may introduce. 

To make sure your solution is ready for any new fields in our APIs we’re making some changes to the responses you receive to your transaction requests. 

What's Changing?

Starting in January 2019, all responses from MerchantWARE, Genius, and TransportWeb will include an additional, randomly-generated element that is not in the WSDL for that API. 

Below is an example of a MerchantWARE 4.5 Sale response with the additional field highlighted. Keep in mind the value and placement of this field will vary with each transaction.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema";>
 <Soap:Body>
  <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">>
   <SaleResult>
    <ApprovalStatus>APPROVED</ApprovalStatus>
    <Token>123456789</Token>
    <AuthorizationCode>OK9999</AuthorizationCode>
    <TransactionDate>1/1/2018 9:41:06 AM</TransactionDate>
    <Amount>1.00</Amount>
    <RemainingCardBalance/>
    <CardNumber>************0026</CardNumber>
    <Cardholder>John Doe</Cardholder>
    <CardType>4</CardType>
    <FsaCard/>
    <ReaderEntryMode>1</ReaderEntryMode>
    <AvsResponse/>
    <CvResponse/>
    <ErrorMessage/>
    <ExtraData/>
    <Rfmiq>10000003WM</Rfmiq>
    <DebitTraceNumber/>
    <qznisg>qznisg</qznisg>
   </SaleResult>
  </SaleResponse>
 </Soap:Body>
</soap:Envelope>

Why?

These changes are meant to emulate the addition of new elements to the API that are not available at the time of integration. By ensuring that new elements and data in our responses does not cause issues with your software we are able to continue to introduce new features to our customers, even if you have not yet incorporated them into your offering.

How to Prepare

You can test out the new responses right now by using our sandbox environment. Just direct your solution to the endpoints listed below for the product you’re using and process a transaction like you normally would. The response will include a random field just like our production endpoints will in January, allowing you to test your software and make sure it’s able to handle the new information without any issues.
  • Sandbox Endpoint: certeng-test.getsandbox.com
  • Transport Endpoint: http://certeng-test.getsandbox.com/v4/transportService.asmx
  • Genius Endpoint: http://certeng-test.getsandbox.com/pos?
  • Genius v2 Endpoint: http://certeng-test.getsandbox.com/v2/pos?
  • MerchantWare 4.5 Endpoint: http://certeng-test.getsandbox.com/Merchantware/ws/RetailTransaction/v45/Credit.asmx
  • MerchantWare 4.0 Reporting Endpoint: http://certeng-test.getsandbox.com/Merchantware/ws/TransactionHistory/v4/Reporting.asmx

Contact Information

If you experience any issues during testing, or if you have any questions about the new fields, don’t hesitate to contact our certification engineering team at developer@cayan.com. You can also consult our API Versioning Best Practices page for more information.
Put the Genius of Cayan to work for your business.
1-844-278-7115