UpdatePendingEbizWebForm
Description
The UpdatePendingEbizWebform method updates pending EbizWebForm objects.
To ensure that all required fields and existing values are preserved, it is recommended to call the SearchEbizWebForm method to retrieve the complete existing object before applying any modifications.
Syntax
PaymentResponse UpdatePendingEbizWebForm(SecurityToken securityToken, string paymentInternalId, EbizWebForm ebizWebForm)
Arguments
Type | Name | Description | |
|---|---|---|---|
| SecurityToken | securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. |
string | paymentInternalId | R | Identifies the EbizWebForm object to update. |
| EbizWebForm | ebizWebForm | R | The updated EbizWebForm object that replaces the existing one. Editable Fields and Objects
Note: If the original request includes the LineItems object, it must also be included in any update request. If omitted from the update request, the existing line items will be removed. Omit the following fields if not used:
|
Return Value
| Type | Description |
|---|---|
| PaymentResponse | Indicates whether the EbizWebForm object was successfully updated. Otherwise, returns a fault. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:UpdatePendingEbizWebForm>
<ebiz:securityToken>
<ebiz:SecurityId>***********-4621-b899-***********</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:paymentInternalId>***********-409a-bf8c-***********</ebiz:paymentInternalId>
<ebiz:ebizWebForm>
<ebiz:FormType/>
<ebiz:FromEmail/>
<ebiz:FromName/>
<ebiz:EmailAddress/>
<ebiz:CcEmailAddress/>
<ebiz:BccEmailAddress/>
<ebiz:ReplyToEmailAddress/>
<ebiz:ReplyToDisplayName/>
<ebiz:EmailNotes/>
<ebiz:EmailNotesHTML/>
<ebiz:EmailSubject/>
<ebiz:EmailTemplateID/>
<ebiz:EmailTemplateName/>
<ebiz:SendEmailToCustomer>false</ebiz:SendEmailToCustomer>
<ebiz:CustomerId/>
<ebiz:CustFullName/>
<ebiz:TransId/>
<ebiz:TransDetail/>
<ebiz:InvoiceNumber>123</ebiz:InvoiceNumber>
<ebiz:PoNum>123</ebiz:PoNum>
<ebiz:SoNum>123</ebiz:SoNum>
<ebiz:OrderId>123</ebiz:OrderId>
<ebiz:Date>2026-06-19T07:38:57-07:00</ebiz:Date>
<ebiz:DueDate>2026-06-06T07:17:00-07:00</ebiz:DueDate>
<ebiz:TotalAmount>100.00</ebiz:TotalAmount>
<ebiz:AmountDue>100.0</ebiz:AmountDue>
<ebiz:TipAmount>0.00</ebiz:TipAmount>
<ebiz:ShippingAmount>100.00</ebiz:ShippingAmount>
<ebiz:DutyAmount>100.00</ebiz:DutyAmount>
<ebiz:TaxAmount>100.00</ebiz:TaxAmount>
<ebiz:Description>TESTT</ebiz:Description>
<ebiz:BillingAddress>
<ebiz:FirstName>Tester</ebiz:FirstName>
<ebiz:LastName>Mate</ebiz:LastName>
<ebiz:CompanyName>School</ebiz:CompanyName>
<ebiz:Address1>Sesame Street</ebiz:Address1>
<ebiz:City>Sesame</ebiz:City>
<ebiz:State>CA</ebiz:State>
<ebiz:ZipCode>123</ebiz:ZipCode>
<ebiz:Country>USA</ebiz:Country>
<ebiz:IsDefault>false</ebiz:IsDefault>
<ebiz:AddressId>12</ebiz:AddressId>
</ebiz:BillingAddress>
<ebiz:ShippingAddress>
<ebiz:FirstName>Tester</ebiz:FirstName>
<ebiz:LastName>Mate</ebiz:LastName>
<ebiz:CompanyName>School 2</ebiz:CompanyName>
<ebiz:Address1>3456 Sesame Street</ebiz:Address1>
<ebiz:City>Sesame</ebiz:City>
<ebiz:State>CA</ebiz:State>
<ebiz:ZipCode>123</ebiz:ZipCode>
<ebiz:Country>USA</ebiz:Country>
<ebiz:IsDefault>false</ebiz:IsDefault>
<ebiz:AddressId/>
</ebiz:ShippingAddress>
<ebiz:ApprovedURL/>
<ebiz:DeclinedURL/>
<ebiz:ErrorURL/>
<ebiz:DisplayDefaultResultPage>1</ebiz:DisplayDefaultResultPage>
<ebiz:PayByType/>
<ebiz:AllowedPaymentMethods/>
<ebiz:SavePaymentMethod>false</ebiz:SavePaymentMethod>
<ebiz:ShowSavedPaymentMethods>false</ebiz:ShowSavedPaymentMethods>
<ebiz:CountryCode/>
<ebiz:CurrencyCode/>
<ebiz:ProcessingCommand/>
<ebiz:SoftwareId/>
<ebiz:TransactionLookupKey/>
<ebiz:LineItems>
<!--Zero or more repetitions:-->
<ebiz:TransactionLineItem>
<ebiz:ProductRefNum>01011</ebiz:ProductRefNum>
<ebiz:SKU>0101011</ebiz:SKU>
<ebiz:CommodityCode>12311</ebiz:CommodityCode>
<ebiz:ProductName>12311</ebiz:ProductName>
<ebiz:Description>testing11</ebiz:Description>
<ebiz:DiscountAmount>0.11</ebiz:DiscountAmount>
<ebiz:DiscountRate>0.11</ebiz:DiscountRate>
<ebiz:UnitOfMeasure>EA</ebiz:UnitOfMeasure>
<ebiz:UnitPrice>10.11</ebiz:UnitPrice>
<ebiz:Qty>4</ebiz:Qty>
<ebiz:Taxable>false</ebiz:Taxable>
<ebiz:TaxAmount>0.00</ebiz:TaxAmount>
<ebiz:TaxRate>0.00</ebiz:TaxRate>
</ebiz:TransactionLineItem>
</ebiz:LineItems>
<ebiz:Clerk>Someone</ebiz:Clerk>
<ebiz:Terminal>123</ebiz:Terminal>
<ebiz:ShowViewInvoiceLink>false</ebiz:ShowViewInvoiceLink>
<ebiz:InvoiceInternalId/>
<ebiz:DeviceSettings>
<ebiz:ShowDeviceList>false</ebiz:ShowDeviceList>
<ebiz:DeviceKey/>
</ebiz:DeviceSettings>
<ebiz:DocumentTypeId/>
<ebiz:ShowViewSalesOrderLink>true</ebiz:ShowViewSalesOrderLink>
<ebiz:SalesOrderInternalId/>
</ebiz:ebizWebForm>
</ebiz:UpdatePendingEbizWebForm>
</soapenv:Body>
</soapenv:Envelope>public static void UpdatePendingEbizWebForm()
{
IeBizService apiClient = new IeBizServiceClient();
SecurityToken securityToken = new SecurityToken
{
SecurityId = TestSecurityId,
UserId = "",
Password = ""
};
// Replace with a real PaymentInternalId obtained from SearchEbizWebForm.
const string paymentInternalId = "********-dfcc-47da-a9c5-************";
EbizWebForm updatedForm = new EbizWebForm
{
InvoiceNumber = "UpdatedInvoice001",
PoNum = "UpdatedPO001",
SoNum = "UpdatedSO001",
OrderId = "UpdatedOrder001",
Description = "Updated via APITest",
Clerk = "TestClerk",
Terminal = "TestTerminal",
TotalAmount = 500.00M,
AmountDue = 500.00M,
ShippingAmount = 10.00M,
DutyAmount = 5.00M,
TaxAmount = 35.00M,
Date = DateTime.Now,
DueDate = DateTime.Now.AddDays(30),
LineItems = null,
BillingAddress = null,
ShippingAddress = null
};
PaymentResponse response = apiClient.UpdatePendingEbizWebForm(
securityToken,
paymentInternalId,
updatedForm
);
Console.WriteLine($"Status: {response.Status}");
Console.WriteLine($"Status Code: {response.StatusCode}");
Console.WriteLine($"Error: {response.Error}");
Console.WriteLine($"Error Code: {response.ErrorCode}");
}function updatePendingEbizWebForm($client, $securityToken): void
{
$client = new SoapClient('End Point URL');
$securityToken = array(
'SecurityId' => '********-1b21-421b-86ce-************',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
// Replace with a real PaymentInternalId obtained from searchEbizWebForm().
$paymentInternalId = '********-79db-4443-b238-************';
$now = (new DateTime())->format(DateTime::ATOM);
$nowPlus = (new DateTime('+30 days'))->format(DateTime::ATOM);
$updatedForm = [
'InvoiceNumber' => 'PHPUpdatedInvoice001',
'PoNum' => 'PHPUpdatedPO001',
'SoNum' => 'PHPUpdatedSO001',
'OrderId' => 'PHPUpdatedOrder001',
'Description' => 'PHPUpdated via APITest',
'Clerk' => 'PHPTestClerk',
'Terminal' => 'PHPTestTerminal',
'TotalAmount' => 500.00,
'AmountDue' => 500.00,
'ShippingAmount' => 10.00,
'DutyAmount' => 5.00,
'TaxAmount' => 35.00,
'Date' => $now,
'DueDate' => $nowPlus,
'LineItems' => null,
'BillingAddress' => null,
'ShippingAddress' => null,
];
$response = $client->UpdatePendingEbizWebForm([
'securityToken' => $securityToken,
'paymentInternalId' => $paymentInternalId,
'ebizWebForm' => $updatedForm,
]);
$result = $response->UpdatePendingEbizWebFormResult ?? null;
echo "Status: " . ($result->Status ?? '') . PHP_EOL;
echo "Status Code: " . ($result->StatusCode ?? '') . PHP_EOL;
echo "Error: " . ($result->Error ?? '') . PHP_EOL;
echo "Error Code: " . ($result->ErrorCode ?? '') . PHP_EOL;
}Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<UpdatePendingEbizWebFormResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<UpdatePendingEbizWebFormResult>
<PaymentInternalId>***********-409a-bf8c-***********</PaymentInternalId>
<Status>Success</Status>
<StatusCode>1</StatusCode>
<Error/>
<ErrorCode>0</ErrorCode>
</UpdatePendingEbizWebFormResult>
</UpdatePendingEbizWebFormResponse>
</s:Body>
</s:Envelope><s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<s:Fault>
<faultcode xmlns:a="http://schemas.microsoft.com/net/2005/12/windowscommunicationfoundation/dispatcher">a:InternalServiceFault</faultcode>
<faultstring xml:lang="en-US">The server was unable to process the request due to an internal error. For more information about the error, either turn on IncludeExceptionDetailInFaults (either from ServiceBehaviorAttribute or from the <serviceDebug> configuration behavior) on the server in order to send the exception information back to the client, or turn on tracing as per the Microsoft .NET Framework SDK documentation and inspect the server trace logs.</faultstring>
</s:Fault>
</s:Body>
</s:Envelope>Updated 7 days ago