GetEbizWebFormURL

Description

This method creates a unique ePayment form URL you can email to your customer or host on your 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

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>gadeedfb-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>true</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>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:ShippingAddress>
            <ebiz:ApprovedURL>https://webforms.ebizcharge.net/approved.aspx?oid=001</ebiz:ApprovedURL>
            <ebiz:DeclinedURL>https://webforms.ebizcharge.net/declined.aspx?oid=001</ebiz:DeclinedURL>
            <ebiz:ErrorURL>https://webforms.ebizcharge.net/error.aspx?oid=001</ebiz:ErrorURL>
            <ebiz:DisplayDefaultResultPage>3</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>