SOAP API – MakePaymentOneTimeCreditCard

MakePayment( username, amount, AccountHolder, Address, CardType, CCExpiryMonth, CCExpiryYear, City, Country, Email, Number, Phone, State, ZipCode ) : Boolean

Since: EngageIP v25.2

Adds a one time credit card payment to a user, returns true if the payment is successful, returns false if it is not, or throws an exception if the user does not exist.

username (String) - The username of the account for which the payment
amount (Double) - The amount of the payment
AccountHolder (String) - The name on the credit card
Address (String) - The address of the card holder
CardType (String) - The name of the card type as defined in your configuration
CreditCardNumber (String) - The credit card number
CCExpiryMonth(String) - The two digit representation of the month of expiry
CCExpiryYear(String) - The two digit representation of the year of expiry
City (String) - The city of the card holder
Country (String) - The country of the card holder
Email (String) - The email address of the card holder
Number (String) - The credit card number
Phone (String) - The phone number of the card holder
State (String) - The state of the card holder
Zipcode (String) - The zip code of the card holder

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 /BOSS/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>
    <MakePaymentOneTimeCreditCard xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
      <AccountHolder>string</AccountHolder>
      <Address>string</Address>
      <CardType>string</CardType>
      <CCExpiryMonth>string</CCExpiryMonth>
      <CCExpiryYear>string</CCExpiryYear>
      <City>string</City>
      <Country>string</Country>
      <Email>string</Email>
      <Number>string</Number>
      <Phone>string</Phone>
      <State>string</State>
      <ZipCode>string</ZipCode>
    </MakePaymentOneTimeCreditCard>
  </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>
    <MakePaymentOneTimeCreditCardResponse xmlns="Logisense_EngageIP">
      <MakePaymentOneTimeCreditCardResult>boolean</MakePaymentOneTimeCreditCardResult>
    </MakePaymentOneTimeCreditCardResponse>
  </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 /BOSS/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/MakePaymentOneTimeCreditCard"

<?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>
    <MakePaymentOneTimeCreditCard xmlns="Logisense_EngageIP">
      <username>string</username>
      <amount>double</amount>
      <AccountHolder>string</AccountHolder>
      <Address>string</Address>
      <CardType>string</CardType>
      <CCExpiryMonth>string</CCExpiryMonth>
      <CCExpiryYear>string</CCExpiryYear>
      <City>string</City>
      <Country>string</Country>
      <Email>string</Email>
      <Number>string</Number>
      <Phone>string</Phone>
      <State>string</State>
      <ZipCode>string</ZipCode>
    </MakePaymentOneTimeCreditCard>
  </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>
    <MakePaymentOneTimeCreditCardResponse xmlns="Logisense_EngageIP">
      <MakePaymentOneTimeCreditCardResult>boolean</MakePaymentOneTimeCreditCardResult>
    </MakePaymentOneTimeCreditCardResponse>
  </soap:Body>
</soap:Envelope>