SOAP API – GetPayments

GetPayments( username ) : ViewPayment[]

Since: EngageIP v25.2

Returns the list of a user's payments, or throws an exception if the user does not exist.

This method returns an array of ViewPayment objects which consists of the following properties:

ID (Integer) - The unique ID for the payment
Date (DateTime) - The date and time of the payment
Amount (Double) - The amount of the payment
UserID (Integer) - The ID of the user account on which the payment was made
Disbursed (Boolean) - Indicates if the payment was disbursed to an invoice
PamentTypeID(String) -The ID of the category for the payment type referring the base payment types of EngageIP: ACH, Check, Credit Card, Credit Card Token, ECheck Token, Other
Detail (String) - Notes about the payment
CardTypeID (Integer) - The ID of the card type configured in Setup under Card Types
PaymentType (String) - The string representation of payment type
PaidBy_UserID (Integer) - The ID of the user that made the payment
PaidBy_User (String) - The username that made the payment
User (String) - The username of the account that was paid
CheckNumber (String)- The check number if the payment was made by check
AutomaticDisburse (Boolean) - Indicates if the payment was automatically disbursed
Credit (Boolean) - Indicates if the payment represents a credit due to a reversal
Void (Boolean) - Indicates a payment that was voided
BatchNumber (String) - Reference to the batch the payment was part of
Deposit (Boolean) - Indicates if the payment is a deposit
AddedBy_UserID (Integer) - The ID of the user that added the payment
AddedBy_User (String) - The name of the user that added the payment
PostingDate (DateTime) - The date the payment was entered into the system
CardType (String) - The string representing the card type as configured in Setup under Card Types
ApprovalCode (String) - The approval code from a payment processor
TransactionNumber (String) - The transaction number from a payment processor

Parameters:

username (String) - The username for which to retrieve the payments. An exception will be thrown if the username does not exist.

Returns:

An array of ViewPayment Objects representing payments made on the account.

Possible Exceptions:

INVALID USERNAME

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 /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetPayments xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetPayments>
  </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>
    <GetPaymentsResponse xmlns="Logisense_EngageIP">
      <GetPaymentsResult>
        <ViewPayment>
          <ID>int</ID>
          <Date>dateTime</Date>
          <Amount>double</Amount>
          <UserID>int</UserID>
          <Disbursed>boolean</Disbursed>
          <InvoiceID>int</InvoiceID>
          <PaymentTypeID>int</PaymentTypeID>
          <Detail>string</Detail>
          <CardTypeID>int</CardTypeID>
          <PaymentType>string</PaymentType>
          <PaidBy_UserID>int</PaidBy_UserID>
          <PaidBy_User>string</PaidBy_User>
          <User>string</User>
          <CheckNumber>string</CheckNumber>
          <AutomaticDisburse>boolean</AutomaticDisburse>
          <Credit>boolean</Credit>
          <Void>boolean</Void>
          <BatchNumber>string</BatchNumber>
          <Deposit>boolean</Deposit>
          <AddedBy_UserID>int</AddedBy_UserID>
          <AddedBy_User>string</AddedBy_User>
          <PostingDate>dateTime</PostingDate>
          <CardType>string</CardType>
          <ApprovalCode>string</ApprovalCode>
          <TransactionNumber>string</TransactionNumber>
        </ViewPayment>
        <ViewPayment>
          <ID>int</ID>
          <Date>dateTime</Date>
          <Amount>double</Amount>
          <UserID>int</UserID>
          <Disbursed>boolean</Disbursed>
          <InvoiceID>int</InvoiceID>
          <PaymentTypeID>int</PaymentTypeID>
          <Detail>string</Detail>
          <CardTypeID>int</CardTypeID>
          <PaymentType>string</PaymentType>
          <PaidBy_UserID>int</PaidBy_UserID>
          <PaidBy_User>string</PaidBy_User>
          <User>string</User>
          <CheckNumber>string</CheckNumber>
          <AutomaticDisburse>boolean</AutomaticDisburse>
          <Credit>boolean</Credit>
          <Void>boolean</Void>
          <BatchNumber>string</BatchNumber>
          <Deposit>boolean</Deposit>
          <AddedBy_UserID>int</AddedBy_UserID>
          <AddedBy_User>string</AddedBy_User>
          <PostingDate>dateTime</PostingDate>
          <CardType>string</CardType>
          <ApprovalCode>string</ApprovalCode>
          <TransactionNumber>string</TransactionNumber>
        </ViewPayment>
      </GetPaymentsResult>
    </GetPaymentsResponse>
  </soap12:Body>
</soap12:Envelope>

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 /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetPayments"

<?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:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetPayments xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetPayments>
  </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>
    <GetPaymentsResponse xmlns="Logisense_EngageIP">
      <GetPaymentsResult>
        <ViewPayment>
          <ID>int</ID>
          <Date>dateTime</Date>
          <Amount>double</Amount>
          <UserID>int</UserID>
          <Disbursed>boolean</Disbursed>
          <InvoiceID>int</InvoiceID>
          <PaymentTypeID>int</PaymentTypeID>
          <Detail>string</Detail>
          <CardTypeID>int</CardTypeID>
          <PaymentType>string</PaymentType>
          <PaidBy_UserID>int</PaidBy_UserID>
          <PaidBy_User>string</PaidBy_User>
          <User>string</User>
          <CheckNumber>string</CheckNumber>
          <AutomaticDisburse>boolean</AutomaticDisburse>
          <Credit>boolean</Credit>
          <Void>boolean</Void>
          <BatchNumber>string</BatchNumber>
          <Deposit>boolean</Deposit>
          <AddedBy_UserID>int</AddedBy_UserID>
          <AddedBy_User>string</AddedBy_User>
          <PostingDate>dateTime</PostingDate>
          <CardType>string</CardType>
          <ApprovalCode>string</ApprovalCode>
          <TransactionNumber>string</TransactionNumber>
        </ViewPayment>
        <ViewPayment>
          <ID>int</ID>
          <Date>dateTime</Date>
          <Amount>double</Amount>
          <UserID>int</UserID>
          <Disbursed>boolean</Disbursed>
          <InvoiceID>int</InvoiceID>
          <PaymentTypeID>int</PaymentTypeID>
          <Detail>string</Detail>
          <CardTypeID>int</CardTypeID>
          <PaymentType>string</PaymentType>
          <PaidBy_UserID>int</PaidBy_UserID>
          <PaidBy_User>string</PaidBy_User>
          <User>string</User>
          <CheckNumber>string</CheckNumber>
          <AutomaticDisburse>boolean</AutomaticDisburse>
          <Credit>boolean</Credit>
          <Void>boolean</Void>
          <BatchNumber>string</BatchNumber>
          <Deposit>boolean</Deposit>
          <AddedBy_UserID>int</AddedBy_UserID>
          <AddedBy_User>string</AddedBy_User>
          <PostingDate>dateTime</PostingDate>
          <CardType>string</CardType>
          <ApprovalCode>string</ApprovalCode>
          <TransactionNumber>string</TransactionNumber>
        </ViewPayment>
      </GetPaymentsResult>
    </GetPaymentsResponse>
  </soap:Body>
</soap:Envelope>