Service Web Service

Service

Click here for a complete list of operations.

ListPaymentsWithdrawn

ListPaymentsWithdrawn(ulSessionID,uSequenceID,sIntegrity,sAgentID). ulong ulSessionID:- ID of authenticated session. uint uSequenceID:- Sequence number. string sIntegrity:- md5("ipaddr(sid,seq)->ListPaymentsWithdrawn(sAgentID)/secret"). string sAgentID:- ID of agent (or null for authenticated agent). RETURNS: [ SPaymentData {sID,sAgentIDFrom,sAgentIDTo,sDealID,dAmount,dOverhead,sTimeOccurred,bWithdrawn,bWithdrawnInFull,bDueOnDeal,bDueOnSuccess,bDueOnFailure,sTag} ]. string sID:- 32 digit hex representing Payment's globally unique id. string sAgentIDFrom:- ID of agent from which funds are taken (or null if deposit) string sAgentIDTo: ID of agent to receive funds (or null if withdrawal) string sDealID; ID of deal giving rise to this payment (or null if deposit/withdrawal) double dAmount: Amount of money transferred (positive) double dOverhead: Positive if cost of deposit (dAmount+dOverhead = funds required to deposit dAmount), or negative if refund on withdrawal. string sTimeOccurred: yyyy-mm-dd HH:mm:ss (time payment was raised in the contingency market). bool bWithdrawn: false=This payment is due. true=This is an actual movement of funds. bool bWithdrawnInFull: false=Partial, true=Final and completing payment. bool bDueOnDeal: This payment has been caused by the joint acceptance of a deal. bool bDueOnSuccess; This payment has been caused by the successful outcome of the contingency bool bDueOnFailure; This payment has been caused by the failure of the contingency string sTag: Tag originally associated with payment FAULTS: Session. DESCRIPTION: List the payments involved in withdrawals from the specified agent.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
ulSessionID:
uSequenceID:
sIntegrity:
sAgentID:

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 /api/Service.asmx HTTP/1.1
Host: contingencymarket.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.contingencymarket.com/api/Service.asmx/ListPaymentsWithdrawn"

<?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>
    <ListPaymentsWithdrawn xmlns="http://www.contingencymarket.com/api/Service.asmx">
      <ulSessionID>unsignedLong</ulSessionID>
      <uSequenceID>unsignedInt</uSequenceID>
      <sIntegrity>string</sIntegrity>
      <sAgentID>string</sAgentID>
    </ListPaymentsWithdrawn>
  </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>
    <ListPaymentsWithdrawnResponse xmlns="http://www.contingencymarket.com/api/Service.asmx">
      <ListPaymentsWithdrawnResult>
        <SPaymentData>
          <sID>string</sID>
          <sAgentIDFrom>string</sAgentIDFrom>
          <sAgentIDTo>string</sAgentIDTo>
          <sDealID>string</sDealID>
          <dAmount>double</dAmount>
          <dOverhead>double</dOverhead>
          <sTimeOccurred>string</sTimeOccurred>
          <bPaid>boolean</bPaid>
          <bPaidInFull>boolean</bPaidInFull>
          <bDueOnDeal>boolean</bDueOnDeal>
          <bDueOnSuccess>boolean</bDueOnSuccess>
          <bDueOnFailure>boolean</bDueOnFailure>
          <sTag>string</sTag>
        </SPaymentData>
        <SPaymentData>
          <sID>string</sID>
          <sAgentIDFrom>string</sAgentIDFrom>
          <sAgentIDTo>string</sAgentIDTo>
          <sDealID>string</sDealID>
          <dAmount>double</dAmount>
          <dOverhead>double</dOverhead>
          <sTimeOccurred>string</sTimeOccurred>
          <bPaid>boolean</bPaid>
          <bPaidInFull>boolean</bPaidInFull>
          <bDueOnDeal>boolean</bDueOnDeal>
          <bDueOnSuccess>boolean</bDueOnSuccess>
          <bDueOnFailure>boolean</bDueOnFailure>
          <sTag>string</sTag>
        </SPaymentData>
      </ListPaymentsWithdrawnResult>
    </ListPaymentsWithdrawnResponse>
  </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 /api/Service.asmx HTTP/1.1
Host: contingencymarket.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>
    <ListPaymentsWithdrawn xmlns="http://www.contingencymarket.com/api/Service.asmx">
      <ulSessionID>unsignedLong</ulSessionID>
      <uSequenceID>unsignedInt</uSequenceID>
      <sIntegrity>string</sIntegrity>
      <sAgentID>string</sAgentID>
    </ListPaymentsWithdrawn>
  </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>
    <ListPaymentsWithdrawnResponse xmlns="http://www.contingencymarket.com/api/Service.asmx">
      <ListPaymentsWithdrawnResult>
        <SPaymentData>
          <sID>string</sID>
          <sAgentIDFrom>string</sAgentIDFrom>
          <sAgentIDTo>string</sAgentIDTo>
          <sDealID>string</sDealID>
          <dAmount>double</dAmount>
          <dOverhead>double</dOverhead>
          <sTimeOccurred>string</sTimeOccurred>
          <bPaid>boolean</bPaid>
          <bPaidInFull>boolean</bPaidInFull>
          <bDueOnDeal>boolean</bDueOnDeal>
          <bDueOnSuccess>boolean</bDueOnSuccess>
          <bDueOnFailure>boolean</bDueOnFailure>
          <sTag>string</sTag>
        </SPaymentData>
        <SPaymentData>
          <sID>string</sID>
          <sAgentIDFrom>string</sAgentIDFrom>
          <sAgentIDTo>string</sAgentIDTo>
          <sDealID>string</sDealID>
          <dAmount>double</dAmount>
          <dOverhead>double</dOverhead>
          <sTimeOccurred>string</sTimeOccurred>
          <bPaid>boolean</bPaid>
          <bPaidInFull>boolean</bPaidInFull>
          <bDueOnDeal>boolean</bDueOnDeal>
          <bDueOnSuccess>boolean</bDueOnSuccess>
          <bDueOnFailure>boolean</bDueOnFailure>
          <sTag>string</sTag>
        </SPaymentData>
      </ListPaymentsWithdrawnResult>
    </ListPaymentsWithdrawnResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /api/Service.asmx/ListPaymentsWithdrawn?ulSessionID=string&uSequenceID=string&sIntegrity=string&sAgentID=string HTTP/1.1
Host: contingencymarket.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSPaymentData xmlns="http://www.contingencymarket.com/api/Service.asmx">
  <SPaymentData>
    <sID>string</sID>
    <sAgentIDFrom>string</sAgentIDFrom>
    <sAgentIDTo>string</sAgentIDTo>
    <sDealID>string</sDealID>
    <dAmount>double</dAmount>
    <dOverhead>double</dOverhead>
    <sTimeOccurred>string</sTimeOccurred>
    <bPaid>boolean</bPaid>
    <bPaidInFull>boolean</bPaidInFull>
    <bDueOnDeal>boolean</bDueOnDeal>
    <bDueOnSuccess>boolean</bDueOnSuccess>
    <bDueOnFailure>boolean</bDueOnFailure>
    <sTag>string</sTag>
  </SPaymentData>
  <SPaymentData>
    <sID>string</sID>
    <sAgentIDFrom>string</sAgentIDFrom>
    <sAgentIDTo>string</sAgentIDTo>
    <sDealID>string</sDealID>
    <dAmount>double</dAmount>
    <dOverhead>double</dOverhead>
    <sTimeOccurred>string</sTimeOccurred>
    <bPaid>boolean</bPaid>
    <bPaidInFull>boolean</bPaidInFull>
    <bDueOnDeal>boolean</bDueOnDeal>
    <bDueOnSuccess>boolean</bDueOnSuccess>
    <bDueOnFailure>boolean</bDueOnFailure>
    <sTag>string</sTag>
  </SPaymentData>
</ArrayOfSPaymentData>

HTTP POST

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

POST /api/Service.asmx/ListPaymentsWithdrawn HTTP/1.1
Host: contingencymarket.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ulSessionID=string&uSequenceID=string&sIntegrity=string&sAgentID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSPaymentData xmlns="http://www.contingencymarket.com/api/Service.asmx">
  <SPaymentData>
    <sID>string</sID>
    <sAgentIDFrom>string</sAgentIDFrom>
    <sAgentIDTo>string</sAgentIDTo>
    <sDealID>string</sDealID>
    <dAmount>double</dAmount>
    <dOverhead>double</dOverhead>
    <sTimeOccurred>string</sTimeOccurred>
    <bPaid>boolean</bPaid>
    <bPaidInFull>boolean</bPaidInFull>
    <bDueOnDeal>boolean</bDueOnDeal>
    <bDueOnSuccess>boolean</bDueOnSuccess>
    <bDueOnFailure>boolean</bDueOnFailure>
    <sTag>string</sTag>
  </SPaymentData>
  <SPaymentData>
    <sID>string</sID>
    <sAgentIDFrom>string</sAgentIDFrom>
    <sAgentIDTo>string</sAgentIDTo>
    <sDealID>string</sDealID>
    <dAmount>double</dAmount>
    <dOverhead>double</dOverhead>
    <sTimeOccurred>string</sTimeOccurred>
    <bPaid>boolean</bPaid>
    <bPaidInFull>boolean</bPaidInFull>
    <bDueOnDeal>boolean</bDueOnDeal>
    <bDueOnSuccess>boolean</bDueOnSuccess>
    <bDueOnFailure>boolean</bDueOnFailure>
    <sTag>string</sTag>
  </SPaymentData>
</ArrayOfSPaymentData>