Soap API v1.6


Update customer data in selected fields only.


This method allows you to update only specified data for a customer record, rather than replacing all existing data. Fields that can be changed using this method include a customer's contact information, as well as customized notes on their account and information regarding any recurring billing cycle that they have been enabled for, such as the amount to be billed, and the number of transactions remaining.

This method requires the use of the CustNum, a unique customer number assigned by the gateway. If you have lost or cannot remember the customer's CustNum, use the searchCustomers method to find the correct CustNum.

This method uses the UpdateData array containing the fields that you would like to update. The “key” of each element is the name of the field you wish to change and the “value” of the element is the new value that you would like to assign.

The following fields may be updated using this method:

  • FirstName
  • LastName
  • CustomerID
  • Company
  • Address
  • Address2
  • City
  • State
  • Zip
  • Country
  • Phone
  • Fax
  • Email
  • URL
  • ReceiptNote
  • SendReceipt
  • Notes
  • Description
  • OrderID
  • Enabled
  • Schedule
  • Next
  • NumLeft
  • Amount
  • CustomData
  • Source
  • User
  • Card Number
  • CardExp
  • Account
  • Routing
  • CheckFormat or RecordType

See also runCustomerTransaction, enableCustomer, disableCustomer, deleteCustomer, searchCustomerID, getCustomer, searchCustomers, getCustomerHistory, addCustomer, addCustomerPaymentMethod, deleteCustomerPaymentMethod, updateCustomer


boolean quickUpdateCustomer ( ueSecurityToken Token, integer CustNum, FieldValue UpdateData )


Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
integer CustNum A unique customer number assigned by the gateway.
FieldValue UpdateData Array of fields to be updated.

Return Value

boolean Returns confirmation of request only if successful. If request fails, an exception will be thrown.



For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

try { 
    array('Field'=>'CardExp'   , 'Value'=>'0913'), 
    array('Field'=>'CardNumber', 'Value'=>'4444555566667779'), 
    array('Field'=>'Amount'    , 'Value'=>'1.34'), 
    array('Field'=>'Address'   , 'Value'=>'Time: ' . mktime()), 
    array('Field'=>'CustomData', 'Value'=> serialize(array("MyField" => "myval"))),      
  print_r($client->quickUpdateCustomer($token,$custnum, $update)); 
catch(SoapFault $e) { 
  echo "Error: " . $e->faultstring; 
  echo "\n\nRequest: " . $client->__getLastRequest(); 
  echo "\n\nResponse: " . $client->__getLastResponse(); 
catch(Exception $e) { 
  echo 'Error: ' . $e->getMessage(); 


This example uses the USAePay Java library. For directions on how to install the library and create the token/client objects, go to either the Java JAX-RPC Howto or the Java JAX-WS Howto.

try {
	BigInteger custnum = new BigInteger("1235");
	// Create array of fields to update
	FieldValueArray updateData = new FieldValueArray();
	updateData.add(new FieldValue("Schedule", "daily"));
	updateData.add(new FieldValue("Amount", "5.00"));
	// run quick update
	boolean response = client.quickUpdateCustomer(token, custnum, updateData);
} catch (Exception e) {
	System.out.println("Soap Exception: " + e.getMessage());


Dim custNum As String
        custNum = "103125"
        Dim fields(0 To 1) As usaepay.FieldValue
        For i As Integer = 0 To 1
            fields(i) = New usaepay.FieldValue
        Next i
        fields(0).Field = "Schedule"
        fields(0).Value = "monthly"
        fields(1).Field = "Amount"
        fields(1).Value = "5.00"
        Dim response As Boolean
        response = client.quickUpdateCustomer(token, custNum, fields)


For directions on how to set up the WSDL link and create the “token” and “client” variables, go to the C Sharp .Net Soap How-to.

            string custNum = "89147";
            usaepay.FieldValue[] fields = new usaepay.FieldValue[2];
            for (int i = 0; i < 2; i++) {
                fields[i] = new usaepay.FieldValue();
            fields[0].Field = "Schedule";   fields[0].Value = "monthly";
            fields[1].Field = "Amount";     fields[1].Value = "5.00";
            Boolean response;
                response = client.quickUpdateCustomer(token, custNum, fields);
                catch (Exception err)


<?xml version="1.0" encoding="UTF-8"?> 
   <SOAP-ENV:Envelope xmlns:SOAP-ENV=""xmlns:ns1="urn:usaepay"
            <Token xsi:type="ns1:ueSecurityToken">
               <ClientIP xsi:type="xsd:string"></ClientIP>
               <PinHash xsi:type="ns1:ueHash">
                  <HashValue xsi:type="xsd:string">aad4e875fdc4ff508e7b426e0bd5f2f322946b75</HashValue>
                  <Seed xsi:type="xsd:string">1425719194-test</Seed>
                  <Type xsi:type="xsd:string">sha1</Type>
               <SourceKey xsi:type="xsd:string">_B4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
            <CustNum xsi:type="xsd:integer">4610866</CustNum>
            <UpdateData SOAP-ENC:arrayType="ns1:FieldValue[4]" xsi:type="ns1:FieldValueArray">
               <item xsi:type="ns1:FieldValue">
                  <Field xsi:type="xsd:string">CustomerID</Field>
                  <Value xsi:type="xsd:string">55555</Value>
               <item xsi:type="ns1:FieldValue">
                  <Field xsi:type="xsd:string">CardExp</Field>
                  <Value xsi:type="xsd:string">0919</Value>
               <item xsi:type="ns1:FieldValue">
                  <Field xsi:type="xsd:string">CardNumber</Field>
                  <Value xsi:type="xsd:string">4000100911112225</Value>
               <item xsi:type="ns1:FieldValue">
                  <Field xsi:type="xsd:string">Amount</Field>
                  <Value xsi:type="xsd:string">80.50</Value>


<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV=""xmlns:ns1="urn:usaepay"
 xmlns:xsd="" xmlns:xsi=""
      <quickUpdateCustomerReturn xsi:type="xsd:boolean">true</quickUpdateCustomerReturn>

Change Log

Version Change
1.1 Method added prior to v1.1
developer/soap-1.6/methods/quickupdatecustomer.txt · Last modified: 2015/12/09 16:22 by yaya

Page Tools