CardStorService


Click here for a complete list of operations.

Submit

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /CardStor/CardStorService.asmx HTTP/1.1
Host: cs.uat.freedompay.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://cardstor.freedompay.com/Submit"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Submit xmlns="http://cardstor.freedompay.com/">
      <request>
        <cofComplianceData>string</cofComplianceData>
        <clientMetadata>
          <applicationName xmlns="http://freeway.freedompay.com/">string</applicationName>
          <applicationVersion xmlns="http://freeway.freedompay.com/">string</applicationVersion>
          <workstationId xmlns="http://freeway.freedompay.com/">string</workstationId>
          <applicationUser xmlns="http://freeway.freedompay.com/">string</applicationUser>
          <environment xmlns="http://freeway.freedompay.com/">string</environment>
          <library xmlns="http://freeway.freedompay.com/">string</library>
          <libraryVersion xmlns="http://freeway.freedompay.com/">string</libraryVersion>
          <securityLibrary xmlns="http://freeway.freedompay.com/">string</securityLibrary>
          <securityLibraryVersion xmlns="http://freeway.freedompay.com/">string</securityLibraryVersion>
          <testRun xmlns="http://freeway.freedompay.com/">string</testRun>
          <testCase xmlns="http://freeway.freedompay.com/">string</testCase>
          <poiDeviceIdentifier xmlns="http://freeway.freedompay.com/">string</poiDeviceIdentifier>
          <sellingSystemName xmlns="http://freeway.freedompay.com/">string</sellingSystemName>
          <sellingSystemVersion xmlns="http://freeway.freedompay.com/">string</sellingSystemVersion>
          <sellingMiddlewareName xmlns="http://freeway.freedompay.com/">string</sellingMiddlewareName>
          <sellingMiddlewareVersion xmlns="http://freeway.freedompay.com/">string</sellingMiddlewareVersion>
        </clientMetadata>
        <clientId>string</clientId>
        <storeId>string</storeId>
        <terminalId>string</terminalId>
        <partnerId>string</partnerId>
        <esKey>string</esKey>
        <dynExp>string</dynExp>
        <type>string</type>
        <operation>string</operation>
        <token>string</token>
        <card>
          <accountNumber xmlns="http://freeway.freedompay.com/">string</accountNumber>
          <accountType xmlns="http://freeway.freedompay.com/">string</accountType>
          <cardType xmlns="http://freeway.freedompay.com/">string</cardType>
          <tokenSubtype xmlns="http://freeway.freedompay.com/">string</tokenSubtype>
          <subtype xmlns="http://freeway.freedompay.com/">string</subtype>
          <issuer xmlns="http://freeway.freedompay.com/">string</issuer>
          <cvIndicator xmlns="http://freeway.freedompay.com/">string</cvIndicator>
          <cvNumber xmlns="http://freeway.freedompay.com/">string</cvNumber>
          <expirationMonth xmlns="http://freeway.freedompay.com/">integer</expirationMonth>
          <expirationYear xmlns="http://freeway.freedompay.com/">integer</expirationYear>
          <issueNumber xmlns="http://freeway.freedompay.com/">string</issueNumber>
          <nameOnCard xmlns="http://freeway.freedompay.com/">string</nameOnCard>
          <startMonth xmlns="http://freeway.freedompay.com/">integer</startMonth>
          <startYear xmlns="http://freeway.freedompay.com/">integer</startYear>
          <serviceRestrictionCode xmlns="http://freeway.freedompay.com/">string</serviceRestrictionCode>
          <pinKsn xmlns="http://freeway.freedompay.com/">string</pinKsn>
          <pinBlock xmlns="http://freeway.freedompay.com/">string</pinBlock>
          <voucherNumber xmlns="http://freeway.freedompay.com/">string</voucherNumber>
          <expectedBrand xmlns="http://freeway.freedompay.com/">string</expectedBrand>
          <plData1 xmlns="http://freeway.freedompay.com/">string</plData1>
          <plData2 xmlns="http://freeway.freedompay.com/">string</plData2>
          <par xmlns="http://freeway.freedompay.com/">string</par>
          <pass xmlns="http://freeway.freedompay.com/">string</pass>
        </card>
        <pos>
          <registerNumber xmlns="http://freeway.freedompay.com/">string</registerNumber>
          <entryMode xmlns="http://freeway.freedompay.com/">string</entryMode>
          <track1 xmlns="http://freeway.freedompay.com/">string</track1>
          <track2 xmlns="http://freeway.freedompay.com/">string</track2>
          <track3 xmlns="http://freeway.freedompay.com/">string</track3>
          <trackKsn xmlns="http://freeway.freedompay.com/">string</trackKsn>
          <sequenceNumber xmlns="http://freeway.freedompay.com/">string</sequenceNumber>
          <cardPresent xmlns="http://freeway.freedompay.com/">string</cardPresent>
          <track1e xmlns="http://freeway.freedompay.com/">string</track1e>
          <track2e xmlns="http://freeway.freedompay.com/">string</track2e>
          <track1len xmlns="http://freeway.freedompay.com/">string</track1len>
          <track2len xmlns="http://freeway.freedompay.com/">string</track2len>
          <tracke xmlns="http://freeway.freedompay.com/">string</tracke>
          <encMode xmlns="http://freeway.freedompay.com/">string</encMode>
          <msrType xmlns="http://freeway.freedompay.com/">string</msrType>
          <paymentDate xmlns="http://freeway.freedompay.com/">string</paymentDate>
          <chipData xmlns="http://freeway.freedompay.com/">string</chipData>
          <issuerScriptResults xmlns="http://freeway.freedompay.com/">string</issuerScriptResults>
          <caps xmlns="http://freeway.freedompay.com/">string</caps>
          <fallbackReason xmlns="http://freeway.freedompay.com/">string</fallbackReason>
          <sigData xmlns="http://freeway.freedompay.com/">string</sigData>
        </pos>
        <posData>string</posData>
        <referenceTokenType>string</referenceTokenType>
        <referenceToken>string</referenceToken>
      </request>
    </Submit>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SubmitResponse xmlns="http://cardstor.freedompay.com/">
      <SubmitResult>
        <requestId>string</requestId>
        <reasonCode>integer</reasonCode>
        <responseMessage>string</responseMessage>
        <decision>string</decision>
        <tokenInformation>
          <token xmlns="http://freeway.freedompay.com/">string</token>
          <accountNumberMasked xmlns="http://freeway.freedompay.com/">string</accountNumberMasked>
          <cardExpirationMonth xmlns="http://freeway.freedompay.com/">string</cardExpirationMonth>
          <cardExpirationYear xmlns="http://freeway.freedompay.com/">string</cardExpirationYear>
          <brand xmlns="http://freeway.freedompay.com/">string</brand>
          <posCardType xmlns="http://freeway.freedompay.com/">string</posCardType>
          <cardType xmlns="http://freeway.freedompay.com/">string</cardType>
          <tokenExpiration xmlns="http://freeway.freedompay.com/">string</tokenExpiration>
          <posData xmlns="http://freeway.freedompay.com/">string</posData>
          <newToken xmlns="http://freeway.freedompay.com/">string</newToken>
        </tokenInformation>
        <invalidFields>
          <invalidField>string</invalidField>
          <invalidField>string</invalidField>
        </invalidFields>
        <missingFields>
          <missingField>string</missingField>
          <missingField>string</missingField>
        </missingFields>
        <referenceToken>string</referenceToken>
      </SubmitResult>
    </SubmitResponse>
  </soap:Body>
</soap:Envelope>