GetEbizWebFormURL
Description
The GetEbizWebFormURL method generates hosted payment forms, payment links, or email payment requests based on the FormType value sent in the EbizWebForm object. Sales orders or pre-authorizations can be processed, depending on the ProcessingCommand value. For pre-authorizations applying to a sales order rather than an invoice, set DocumentTypeId to SalesOrder.
For details on supported FormType and ProcessingCommand options, refer to the EbizWebForm object.
Syntax
string GetEbizWebFormURL(SecurityToken securityToken, EbizWebForm ePaymentForm)
Arguments
Type | Name | Description | |
|---|---|---|---|
securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. | |
ePaymentForm | R | Details for the ePayment form to generate. Required Fields
If using the objects below, the following fields are required. Unused objects must be removed from the request.
Recommended Fields
|
Return Value
| Type | Description |
|---|---|
| string | A unique URL for the generated form. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:GetEbizWebFormURL>
<ebiz:securityToken>
<ebiz:SecurityId>*************-4621-b899-************</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:ePaymentForm>
<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>Cbs0001</ebiz:CustomerId>
<ebiz:CustFullName/>
<ebiz:TransId />
<ebiz:TransDetail/>
<ebiz:InvoiceNumber>Inv0001</ebiz:InvoiceNumber>
<ebiz:PoNum/>
<ebiz:SoNum/>
<ebiz:OrderId/>
<ebiz:Date>2017-04-19T07:38:57-07:00</ebiz:Date>
<ebiz:DueDate>2017-10-06T07:17:00-07:00</ebiz:DueDate>
<ebiz:TotalAmount>1000.00</ebiz:TotalAmount>
<ebiz:AmountDue>100.25</ebiz:AmountDue>
<ebiz:TipAmount>10.00</ebiz:TipAmount>
<ebiz:ShippingAmount>10.25</ebiz:ShippingAmount>
<ebiz:DutyAmount>0</ebiz:DutyAmount>
<ebiz:TaxAmount>0</ebiz:TaxAmount>
<ebiz:Description/>
<ebiz:BillingAddress>
<ebiz:FirstName/>
<ebiz:LastName/>
<ebiz:CompanyName/>
<ebiz:Address1/>
<ebiz:City/>
<ebiz:State/>
<ebiz:ZipCode/>
<ebiz:Country/>
</ebiz:BillingAddress>
<ebiz:ShippingAddress>
<ebiz:FirstName/>
<ebiz:LastName/>
<ebiz:CompanyName/>
<ebiz:Address1/>
<ebiz:City/>
<ebiz:State/>
<ebiz:ZipCode/>
<ebiz:Country/>
</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>
<ebiz:ProductRefNum/>
<ebiz:SKU/>
<ebiz:CommodityCode/>
<ebiz:ProductName/>
<ebiz:Description/>
<ebiz:DiscountAmount/>
<ebiz:DiscountRate/>
<ebiz:UnitOfMeasure/>
<ebiz:UnitPrice/>
<ebiz:Qty/>
<ebiz:Taxable/>
<ebiz:TaxAmount/>
<ebiz:TaxRate/>
</ebiz:LineItems>
<ebiz:Clerk/>
<ebiz:Terminal/>
<ebiz:ShowViewInvoiceLink>false</ebiz:ShowViewInvoiceLink>
<ebiz:InvoiceInternalId/>
<ebiz:DeviceSettings>
<ebiz:ShowDeviceList>false</ebiz:ShowDeviceList>
<ebiz:DeviceKey/>
</ebiz:DeviceSettings>
<ebiz:DocumentTypeId/>
<ebiz:ShowViewSalesOrderLink>false</ebiz:ShowViewSalesOrderLink>
<ebiz:SalesOrderInternalId/>
</ebiz:ePaymentForm>
</ebiz:GetEbizWebFormURL>
</soapenv:Body>
</soapenv:Envelope>public void GetEbizWebFormURL()
{
eBizService apiClient = new eBizService();
SecurityToken securityToken = new SecurityToken
{
SecurityId = "*******-c870-41b8-aa5c-************",
UserId = "",
Password = ""
};
EbizWebForm ebizWebForm = new EbizWebForm();
ebizWebForm.FromEmail = "[email protected]";
ebizWebForm.EmailAddress = "[email protected]";
ebizWebForm.FormType = "EmailForm";
ebizWebForm.EmailNotes = "Test Notes";
ebizWebForm.EmailSubject = "Take a Payment";
ebizWebForm.EmailTemplateID = "*******-f123-4723-a8fd-************";
ebizWebForm.SendEmailToCustomer = true;
ebizWebForm.CustomerId = "APIcust13";
ebizWebForm.CustFullName = "Test Customer";
ebizWebForm.InvoiceNumber = "00001532";
ebizWebForm.PoNum = "";
ebizWebForm.OrderId = "8015w0000047prmAAA";
ebizWebForm.Date = DateTime.Now;
ebizWebForm.TotalAmount = 500;
ebizWebForm.AmountDue = 20;
ebizWebForm.PayByType = "CC,ACH";
ebizWebForm.SavePaymentMethod = true;
ebizWebForm.ShowSavedPaymentMethods = false;
ebizWebForm.SoftwareId = "TEST";
var response = apiClient.GetEbizWebFormURL(securityToken, ebizWebForm);
Console.WriteLine(response);
Console.ReadLine();
}public function GetEbizWebFormURL()
{
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '******-454757-45*********',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$lineItems[] = array(
'ProductRefNum' => '123',
'SKU' => 'sku-123',
'ProductName' => 'Product-blue-123',
'Description' => 'Product-blue-123 description',
'UnitPrice' => 550.00,
'Qty' => 2,
);
$ePaymentForm = array(
'FormType' => '?',
'PayByType' => '?',
'EmailAddress' => '[email protected]',
'CustomerId' => '123',
'CustFullName' => 'Frank Hernandez',
'PoNum' => 'order123',
'SoNum' => 'order123',
'OrderId' => '123',
'Date' => date('Y-m-d'),
'DueDate' => date('Y-m-d'),
'TotalAmount' => 100.00,
'AmountDue' => 100.00,
'ShippingAmount' => 5.00,
'TaxAmount' => 5.00,
'Description' => 'Order ID: 123 description',
'BillingAddress' => array(),
'ShippingAddress' => array(),
'ApprovedURL' => '',
'DeclinedURL' => '',
'ErrorURL' => '',
'ShowSavedPaymentMethods' => false,
'ProcessingCommand' => 'sale',
'SoftwareId' => 'PHP',
'LineItems' = > $lineItems,
);
$response = $client->GetEbizWebFormURL(
array(
'securityToken' => $securityToken,
'ePaymentForm' => $ePaymentForm,
)
);
$result = $response->GetEbizWebFormURLResult;
}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">
<GetEbizWebFormURLResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
<GetEbizWebFormURLResult>https://webforms.ebizcharge.net/EBizSecureForm.aspx?pid=*************-4e31-aa05-************</GetEbizWebFormURLResult>
</GetEbizWebFormURLResponse>
</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 6 months ago