GetEbizWebFormURL
Description
This method creates a unique ePayment form URL that can be emailed to merchant's customer or host on the website so customers can pay their outstanding invoice amount.
Syntax
string GetEbizWebFormURL(SecurityToken securityToken, EbizWebForm ePaymentForm)
Arguments
| Type | Name | Description |
|---|---|---|
| SecurityToken | securityToken | Merchant security token: used to identify merchant and validate transaction. (required) |
| EbizWebForm | ePaymentForm | Includes ePayment form information, such as invoice number, amount, and email address. (required) |
Return Value
| Type | Description |
|---|---|
| string | Unique ePayment form URL. |
Examples
public function GetEbizWebFormURL()
{
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '******-454757-4567457-777',
'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 khalid',
'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;
}
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>********-b61b-4add-9c64-dabb3e0199df</ebiz:SecurityId>
<ebiz:UserId>Id1</ebiz:UserId>
<ebiz:Password>Tbse123!</ebiz:Password>
</ebiz:securityToken>
<ebiz:ePaymentForm>
<ebiz:FormType>Webform</ebiz:FormType>
<ebiz:FromEmail>[email protected]</ebiz:FromEmail>
<ebiz:FromName>EbizCharge Support Team</ebiz:FromName>
<ebiz:EmailAddress>[email protected]</ebiz:EmailAddress>
<ebiz:CcEmailAddress/>
<ebiz:BccEmailAddress/>
<ebiz:ReplyToEmailAddress>[email protected]</ebiz:ReplyToEmailAddress>
<ebiz:ReplyToDisplayName>Support</ebiz:ReplyToDisplayName>
<ebiz:EmailNotes>New Payment</ebiz:EmailNotes>
<ebiz:EmailSubject>New Payment</ebiz:EmailSubject>
<ebiz:EmailTemplateID/>
<ebiz:EmailTemplateName/>
<ebiz:SendEmailToCustomer>false</ebiz:SendEmailToCustomer>
<ebiz:CustomerId>Cbs0001</ebiz:CustomerId>
<ebiz:CustFullName>Tim Williams</ebiz:CustFullName>
<ebiz:TransId>x-001</ebiz:TransId>
<ebiz:TransDetail>New Payment</ebiz:TransDetail>
<ebiz:InvoiceNumber>Inv0001</ebiz:InvoiceNumber>
<ebiz:PoNum>Po12300</ebiz:PoNum>
<ebiz:SoNum>SO0001</ebiz:SoNum>
<ebiz:OrderId>O0001</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>Payment</ebiz:Description>
<ebiz:BillingAddress>
<ebiz:FirstName>Tim</ebiz:FirstName>
<ebiz:LastName>Rogers</ebiz:LastName>
<ebiz:CompanyName>CBS</ebiz:CompanyName>
<ebiz:Address1>20 Pacifica</ebiz:Address1>
<ebiz:Address2>Suite 1450</ebiz:Address2>
<ebiz:Address3/>
<ebiz:City>Irvine</ebiz:City>
<ebiz:State>CA</ebiz:State>
<ebiz:ZipCode>92618</ebiz:ZipCode>
<ebiz:Country>USA</ebiz:Country>
<ebiz:IsDefault>true</ebiz:IsDefault>
<ebiz:AddressId>001</ebiz:AddressId>
</ebiz:BillingAddress>
<ebiz:ShippingAddress>
<ebiz:FirstName>Tim</ebiz:FirstName>
<ebiz:LastName>Rogers</ebiz:LastName>
<ebiz:CompanyName>CBS</ebiz:CompanyName>
<ebiz:Address1>55 Golden</ebiz:Address1>
<ebiz:Address2>Suite 7777</ebiz:Address2>
<ebiz:Address3/>
<ebiz:City>Irvine</ebiz:City>
<ebiz:State>CA</ebiz:State>
<ebiz:ZipCode>92618</ebiz:ZipCode>
<ebiz:Country>USA</ebiz:Country>
<ebiz:IsDefault>true</ebiz:IsDefault>
<ebiz:AddressId>001</ebiz:AddressId>
</ebiz:ShippingAddress>
<ebiz:ApprovedURL></ebiz:ApprovedURL>
<ebiz:DeclinedURL></ebiz:DeclinedURL>
<ebiz:ErrorURL></ebiz:ErrorURL>
<ebiz:DisplayDefaultResultPage>1</ebiz:DisplayDefaultResultPage>
<ebiz:PayByType/>
<ebiz:AllowedPaymentMethods/>
<ebiz:SavePaymentMethod>false</ebiz:SavePaymentMethod>
<ebiz:ShowSavedPaymentMethods>false</ebiz:ShowSavedPaymentMethods>
<ebiz:CountryCode>USA</ebiz:CountryCode>
<ebiz:CurrencyCode>USD</ebiz:CurrencyCode>
<ebiz:ProcessingCommand>Sale</ebiz:ProcessingCommand>
<ebiz:SoftwareId>QuickBooks</ebiz:SoftwareId>
<ebiz:TransactionLookupKey>000029</ebiz:TransactionLookupKey>
<ebiz:LineItems>
<ebiz:TransactionLineItem>
<ebiz:ProductRefNum>ref001</ebiz:ProductRefNum>
<ebiz:SKU>S001</ebiz:SKU>
<ebiz:CommodityCode>1204587</ebiz:CommodityCode>
<ebiz:ProductName>Sony TV</ebiz:ProductName>
<ebiz:Description>Sony TV</ebiz:Description>
<ebiz:DiscountAmount>0.00</ebiz:DiscountAmount>
<ebiz:DiscountRate>0.00</ebiz:DiscountRate>
<ebiz:UnitOfMeasure>EA</ebiz:UnitOfMeasure>
<ebiz:UnitPrice>1000.00</ebiz:UnitPrice>
<ebiz:Qty>1</ebiz:Qty>
<ebiz:Taxable>true</ebiz:Taxable>
<ebiz:TaxAmount>0.00</ebiz:TaxAmount>
<ebiz:TaxRate>0.00</ebiz:TaxRate>
</ebiz:TransactionLineItem>
</ebiz:LineItems>
<ebiz:Clerk>User1</ebiz:Clerk>
<ebiz:Terminal>Terminal1</ebiz:Terminal>
</ebiz:ePaymentForm>
</ebiz:GetEbizWebFormURL>
</soapenv:Body>
</soapenv:Envelope>
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/ePaymentForm_CPaQlTeXkHuOl5KrS4m6qDYJk98AVwC.aspx?pid=21263110-f587-4c05-9bff-5c93a24ddae9</GetEbizWebFormURLResult>
</GetEbizWebFormURLResponse>
</s:Body>
</s:Envelope>
public void GetEbizWebFormURL()
{
eBizService apiClient = new eBizService();
SecurityToken securityToken = new SecurityToken
{
SecurityId = "*******-c870-41b8-aa5c-205e55b7a049",
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-df5a4c990512";
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();
}
Updated over 1 year ago