ListPaymentsWithdrawn

From The Contingency Market

Jump to: navigation, search

Contents

ListPaymentsWithdrawn(ulSessionID,uSequenceID,sIntegrity)

List the payments involved in withdrawals from the authenticated agent.

PARAMETERS

ulong ulSessionID 
ID of authenticated session.
uint uSequenceID 
Sequence number.
string sIntegrity 
md5("ipaddr(sid,seq)->ListPaymentsWithdrawn()/secret")

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.

TEST

ListPaymentsWithdrawn() according to the respective template currently returns .

Views
Personal tools