SOAP API - MakePayment

MakePayment( username, amount ) : Boolean

Since: EngageIP v25.2

Adds a new payment to a user using the default payment method, returns true if the payment is successful, returns false if it is not, or throws an exception if the user does not exist.

Parameters:

username (String) - The username for the account making the payment. An exception will be thrown if the username does not exist.
amount (Double) - The amount of the payment

Returns:

A Boolean indicating success or failure of payment.

Possible Exceptions:

INVALID USERNAME
PAYMENT OF NON-POSITIVE AMOUNT

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>
    <MakePayment xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
    </MakePayment>
  </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>
    <MakePaymentResponse xmlns="Logisense_EngageIP">
      <MakePaymentResult>boolean</MakePaymentResult>
    </MakePaymentResponse>
  </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/MakePayment"

<?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>
    <MakePayment xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
    </MakePayment>
  </soap:Body>
</soap:Envelope>