SmartPayService
Click here for a complete list of operations.
ListPayments
Gets a list of payments and optionally filters the payment list for payments created between the specified dates. This method will not mark payments as exported.
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 /SmartPayService.asmx HTTP/1.1
Host: apipayments.infinitytms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://payments.onsharp.com/ListPayments"
<?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>
<ListPayments xmlns="http://payments.onsharp.com/">
<sessionId>string</sessionId>
<start>dateTime</start>
<end>dateTime</end>
</ListPayments>
</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>
<ListPaymentsResponse xmlns="http://payments.onsharp.com/">
<ListPaymentsResult>
<Payments>
<Payment>
<Id>string</Id>
<BatchId>string</BatchId>
<MethodTypeId>int</MethodTypeId>
<MethodTypeName>string</MethodTypeName>
<CheckNumber>int</CheckNumber>
<AccountId>guid</AccountId>
<AccountName>string</AccountName>
<AccountLast4>string</AccountLast4>
<InvoiceNumber>string</InvoiceNumber>
<DatePaid>dateTime</DatePaid>
<AmountPaid>decimal</AmountPaid>
<ConfirmationNumber>string</ConfirmationNumber>
<Description>string</Description>
<ProcessDate>dateTime</ProcessDate>
<CustomerId>string</CustomerId>
<CustomerName>string</CustomerName>
<CustomerEmail>string</CustomerEmail>
<CustomerPhone>string</CustomerPhone>
<CustomerData xsi:nil="true" />
<NoCustomerEmail>boolean</NoCustomerEmail>
</Payment>
<Payment>
<Id>string</Id>
<BatchId>string</BatchId>
<MethodTypeId>int</MethodTypeId>
<MethodTypeName>string</MethodTypeName>
<CheckNumber>int</CheckNumber>
<AccountId>guid</AccountId>
<AccountName>string</AccountName>
<AccountLast4>string</AccountLast4>
<InvoiceNumber>string</InvoiceNumber>
<DatePaid>dateTime</DatePaid>
<AmountPaid>decimal</AmountPaid>
<ConfirmationNumber>string</ConfirmationNumber>
<Description>string</Description>
<ProcessDate>dateTime</ProcessDate>
<CustomerId>string</CustomerId>
<CustomerName>string</CustomerName>
<CustomerEmail>string</CustomerEmail>
<CustomerPhone>string</CustomerPhone>
<CustomerData xsi:nil="true" />
<NoCustomerEmail>boolean</NoCustomerEmail>
</Payment>
</Payments>
<Surcharges>
<Surcharge>
<GatewayReferenceId>string</GatewayReferenceId>
<Amount>decimal</Amount>
</Surcharge>
<Surcharge>
<GatewayReferenceId>string</GatewayReferenceId>
<Amount>decimal</Amount>
</Surcharge>
</Surcharges>
</ListPaymentsResult>
</ListPaymentsResponse>
</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 /SmartPayService.asmx HTTP/1.1
Host: apipayments.infinitytms.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>
<ListPayments xmlns="http://payments.onsharp.com/">
<sessionId>string</sessionId>
<start>dateTime</start>
<end>dateTime</end>
</ListPayments>
</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>
<ListPaymentsResponse xmlns="http://payments.onsharp.com/">
<ListPaymentsResult>
<Payments>
<Payment>
<Id>string</Id>
<BatchId>string</BatchId>
<MethodTypeId>int</MethodTypeId>
<MethodTypeName>string</MethodTypeName>
<CheckNumber>int</CheckNumber>
<AccountId>guid</AccountId>
<AccountName>string</AccountName>
<AccountLast4>string</AccountLast4>
<InvoiceNumber>string</InvoiceNumber>
<DatePaid>dateTime</DatePaid>
<AmountPaid>decimal</AmountPaid>
<ConfirmationNumber>string</ConfirmationNumber>
<Description>string</Description>
<ProcessDate>dateTime</ProcessDate>
<CustomerId>string</CustomerId>
<CustomerName>string</CustomerName>
<CustomerEmail>string</CustomerEmail>
<CustomerPhone>string</CustomerPhone>
<CustomerData xsi:nil="true" />
<NoCustomerEmail>boolean</NoCustomerEmail>
</Payment>
<Payment>
<Id>string</Id>
<BatchId>string</BatchId>
<MethodTypeId>int</MethodTypeId>
<MethodTypeName>string</MethodTypeName>
<CheckNumber>int</CheckNumber>
<AccountId>guid</AccountId>
<AccountName>string</AccountName>
<AccountLast4>string</AccountLast4>
<InvoiceNumber>string</InvoiceNumber>
<DatePaid>dateTime</DatePaid>
<AmountPaid>decimal</AmountPaid>
<ConfirmationNumber>string</ConfirmationNumber>
<Description>string</Description>
<ProcessDate>dateTime</ProcessDate>
<CustomerId>string</CustomerId>
<CustomerName>string</CustomerName>
<CustomerEmail>string</CustomerEmail>
<CustomerPhone>string</CustomerPhone>
<CustomerData xsi:nil="true" />
<NoCustomerEmail>boolean</NoCustomerEmail>
</Payment>
</Payments>
<Surcharges>
<Surcharge>
<GatewayReferenceId>string</GatewayReferenceId>
<Amount>decimal</Amount>
</Surcharge>
<Surcharge>
<GatewayReferenceId>string</GatewayReferenceId>
<Amount>decimal</Amount>
</Surcharge>
</Surcharges>
</ListPaymentsResult>
</ListPaymentsResponse>
</soap12:Body>
</soap12:Envelope>