module
Click here for a complete list of operations.
Purchase
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /ws_cas_module.asmx HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://ca.tvinci.com/Purchase" <?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> <Purchase xmlns="http://ca.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <siteguid>string</siteguid> <householdId>long</householdId> <price>double</price> <currency>string</currency> <contentId>int</contentId> <productId>int</productId> <transactionType>PPV or Subscription or Collection or ProgramAssetGroupOffer</transactionType> <coupon>string</coupon> <userIp>string</userIp> <deviceName>string</deviceName> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <adapterData>string</adapterData> </Purchase> </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> <PurchaseResponse xmlns="http://ca.tvinci.com/"> <PurchaseResult> <Status> <Code>int</Code> <Message>string</Message> <Args> <KeyValuePair xsi:nil="true" /> <KeyValuePair xsi:nil="true" /> </Args> </Status> <TransactionID>string</TransactionID> <PGReferenceID>string</PGReferenceID> <PGResponseCode>string</PGResponseCode> <State>string</State> <FailReasonCode>int</FailReasonCode> <CreatedAt>long</CreatedAt> <StartDateSeconds>long</StartDateSeconds> <EndDateSeconds>long</EndDateSeconds> <AutoRenewing>boolean</AutoRenewing> </PurchaseResult> </PurchaseResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /ws_cas_module.asmx HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Purchase xmlns="http://ca.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <siteguid>string</siteguid> <householdId>long</householdId> <price>double</price> <currency>string</currency> <contentId>int</contentId> <productId>int</productId> <transactionType>PPV or Subscription or Collection or ProgramAssetGroupOffer</transactionType> <coupon>string</coupon> <userIp>string</userIp> <deviceName>string</deviceName> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <adapterData>string</adapterData> </Purchase> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <PurchaseResponse xmlns="http://ca.tvinci.com/"> <PurchaseResult> <Status> <Code>int</Code> <Message>string</Message> <Args> <KeyValuePair xsi:nil="true" /> <KeyValuePair xsi:nil="true" /> </Args> </Status> <TransactionID>string</TransactionID> <PGReferenceID>string</PGReferenceID> <PGResponseCode>string</PGResponseCode> <State>string</State> <FailReasonCode>int</FailReasonCode> <CreatedAt>long</CreatedAt> <StartDateSeconds>long</StartDateSeconds> <EndDateSeconds>long</EndDateSeconds> <AutoRenewing>boolean</AutoRenewing> </PurchaseResult> </PurchaseResponse> </soap12:Body> </soap12:Envelope>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /ws_cas_module.asmx/Purchase HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: application/x-www-form-urlencoded Content-Length: length sWSUserName=string&sWSPassword=string&siteguid=string&householdId=string&price=string¤cy=string&contentId=string&productId=string&transactionType=string&coupon=string&userIp=string&deviceName=string&paymentGatewayId=string&paymentMethodId=string&adapterData=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <TransactionResponse xmlns="http://ca.tvinci.com/"> <Status> <Code>int</Code> <Message>string</Message> <Args> <KeyValuePair> <key>string</key> <value>string</value> </KeyValuePair> <KeyValuePair> <key>string</key> <value>string</value> </KeyValuePair> </Args> </Status> <TransactionID>string</TransactionID> <PGReferenceID>string</PGReferenceID> <PGResponseCode>string</PGResponseCode> <State>string</State> <FailReasonCode>int</FailReasonCode> <CreatedAt>long</CreatedAt> <StartDateSeconds>long</StartDateSeconds> <EndDateSeconds>long</EndDateSeconds> <AutoRenewing>boolean</AutoRenewing> </TransactionResponse>