SearchUserList
Description
This method is used to search user list.
Syntax
public UserListSearchResult SearchUserList(SecurityToken securityToken, string applicationKey, SearchFilter[] filters, int start, int limit, string sort, bool countOnly)
Arguments
Type | Name | Description |
---|---|---|
SecurityToken | securityToken | Merchant security token: used to identify merchant and validate transaction. (required) |
string | applicationKey | Application Key. |
SearchFilter | filters | To filter returned results. (required) |
DateTime | toDateTime | To pending payment date. (required) |
int | start | Start position, defaults to 0 (first payment found). (required) |
int | limit | Maximum number of payments to return in result. (required) |
string | sort | Field name to sort the results by. (optional) |
Bool | countOnly | Count Only. |
Return Value
Type | Description |
---|---|
Payment[] | This object contains all payment information, including payment, invoice, and customer information. |
Examples
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:SearchPaymentFormReceivedPayments>
<ebiz:securityToken>
<ebiz:SecurityId>********-90B4-4A38-AD78-28A795AF78E9</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:customerId/>
<ebiz:fromDateTime>2017-01-15T08:52:58</ebiz:fromDateTime>
<ebiz:toDateTime>2017-05-14T23:41:13</ebiz:toDateTime>
<ebiz:start>1</ebiz:start>
<ebiz:limit>2</ebiz:limit>
<ebiz:sort/>
</ebiz:SearchPaymentFormReceivedPayments>
</soapenv:Body>
</soapenv:Envelope>
Response:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchPaymentFormReceivedPaymentsResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<SearchPaymentFormReceivedPaymentsResult>
<Payment>
<CustomerId>Barb Tran</CustomerId>
<SubCustomerId/>
<DivisionId/>
<InvoiceNumber>Inv0001</InvoiceNumber>
<InvoiceInternalId/>
<InvoiceDate/>
<InvoiceDueDate/>
<PoNum/>
<InvoiceAmount>12.45</InvoiceAmount>
<AmountDue>10.25</AmountDue>
<AuthCode/>
<RefNum>124017112</RefNum>
<Last4>1111</Last4>
<PaymentMethod>Visa</PaymentMethod>
<DatePaid>2017-06-13T00:59:34</DatePaid>
<PaidAmount>10.25</PaidAmount>
<PaymentInternalId>********fab4c45bd596d9c447a9d2f</PaymentInternalId>
<PaymentSourceId>Email</PaymentSourceId>
<PaymentRequestDateTime>2017-03-13T21:23:03</PaymentRequestDateTime>
</Payment>
<Payment>
<CustomerId>LA (123456)</CustomerId>
<SubCustomerId/>
<DivisionId/>
<InvoiceNumber>Inv0001</InvoiceNumber>
<InvoiceInternalId/>
<InvoiceDate/>
<InvoiceDueDate/>
<PoNum/>
<InvoiceAmount>12.45</InvoiceAmount>
<AmountDue>10.25</AmountDue>
<AuthCode/>
<RefNum>124017223</RefNum>
<Last4>1111</Last4>
<PaymentMethod>Visa</PaymentMethod>
<DatePaid>2017-06-13T01:14:53</DatePaid>
<PaidAmount>10.25</PaidAmount>
<PaymentInternalId>*******5c0440a4be57853cf4601a55</PaymentInternalId>
<PaymentSourceId>Email</PaymentSourceId>
<PaymentRequestDateTime>2017-03-10T20:38:11</PaymentRequestDateTime>
</Payment>
</SearchPaymentFormReceivedPaymentsResult>
</SearchPaymentFormReceivedPaymentsResponse>
</s:Body>
</s:Envelope>
Updated 12 months ago