http://3.19.219.109/index.php?action=history&feed=atom&title=Payment_Gateway_Module_Parameters
Payment Gateway Module Parameters - Revision history
2026-04-04T14:55:09Z
Revision history for this page on the wiki
MediaWiki 1.29.1
http://3.19.219.109/index.php?title=Payment_Gateway_Module_Parameters&diff=26998&oldid=prev
John: Replaced content with "This page has moved to https://developers.whmcs.com/payment-gateways/third-party-gateway/"
2019-02-05T17:30:18Z
<p>Replaced content with "This page has moved to https://developers.whmcs.com/payment-gateways/third-party-gateway/"</p>
<table class="diff diff-contentalign-left" data-mw="interface">
<col class='diff-marker' />
<col class='diff-content' />
<col class='diff-marker' />
<col class='diff-content' />
<tr style='vertical-align: top;' lang='en'>
<td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td>
<td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 17:30, 5 February 2019</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td>
<td colspan="2" class="diff-lineno">Line 1:</td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">All gateway module function calls receive a standardised list of parameters.</del></div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins class="diffchange diffchange-inline">This page </ins>has <ins class="diffchange diffchange-inline">moved </ins>to <ins class="diffchange diffchange-inline">https</ins>://<ins class="diffchange diffchange-inline">developers</ins>.<ins class="diffchange diffchange-inline">whmcs</ins>.com/payment-<ins class="diffchange diffchange-inline">gateways</ins>/<ins class="diffchange diffchange-inline">third</ins>-<ins class="diffchange diffchange-inline">party</ins>-<ins class="diffchange diffchange-inline">gateway</ins>/</div></td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">These parameters provide data relating to the invoice the gateway module command is being invoked for along with the configuration setting values defined in for the given payment gateway.</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">Certain functions will receive additional data specific to the action that is being requested.  These are detailed below the standard list of variables.</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">===Standardised Parameters===</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table-striped"></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>whmcsVersion</td><td>The current version of WHMCS. eg: 6.0.1-release.1</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>invoiceid</td><td>The invoice ID for which the gateway function </del>has <del class="diffchange diffchange-inline">been invoked</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>invoicenum</td><td>The invoice number</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>amount</td><td>The amount due</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>description</td><td>A standardised payment descriptor - format: "[CompanyName] - Invoice #[InvoiceNum]"</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>clientsdetails</td><td>Provides an array of client profile data (see below)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>systemurl</td><td>The url </del>to <del class="diffchange diffchange-inline">the WHMCS installation eg. http</del>://<del class="diffchange diffchange-inline">www</del>.<del class="diffchange diffchange-inline">example</del>.com/<del class="diffchange diffchange-inline">whmcs</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>returnurl</td><td>The invoice url to be returned to following completion or cancellation of payment</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>companyname</td><td>The system configured company name</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>name</td><td>The display name of the </del>payment <del class="diffchange diffchange-inline">gateway that is being called</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>paymentmethod</td><td>The system name of the payment gateway that is being called</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>type</td><td>The type of payment gateway module</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>visible</td><td>Whether the payment gateway is visible</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>langpaynow</td><td>A localised text string for "Pay Now" based on the clients selected language</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"></table></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">===Clients Details===</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">The clients details parameter contains an array of client profile data for the client that owns the given product/service.  This array includes:</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table</del>-<del class="diffchange diffchange-inline">striped"></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>firstname</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>lastname</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>fullname</td><td>First Name + Last Name</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>companyname</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>email</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>address1</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>address2</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>city</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>state</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>statecode</td><td>2 Letter State Code (US & Canada Only)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>postcode</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>country</td><td>2 Letter ISO Country Code</td><</del>/<del class="diffchange diffchange-inline">tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>countryname</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>phonecc</td><td>Country Dialing Code Prefix (eg. 1 for US, 44 for UK, etc...)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>phonenumber</td><td></td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>phonenumberformatted</td><td>Phone Number in Format +X.XXXXXXX</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>twofaenabled</td><td>Two</del>-<del class="diffchange diffchange-inline">Factor Status </del>- <del class="diffchange diffchange-inline">Boolean true/false</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>currency<</del>/<del class="diffchange diffchange-inline">td><td>Currency ID (relates to tblcurrencies.id)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>groupid</td><td>Client Group ID</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>language</td><td>Client defined language (defaults to empty)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>customfields</td><td>Provides an array of all custom field names and values for the current client (see below)</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>status</td><td>Status of Client: Active, Inactive or Closed</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>notes</td><td>Admin only client notes</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"><tr bgcolor="#ffffff"><td>password</td><td>Hashed version of client area password - cannot be decrypted</td></tr></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline"></table></del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">===Capture===</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">The following additional parameters are made available for capture requests.</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">===Refunds===</del></div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr>
<tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del class="diffchange diffchange-inline">The following additional parameters are made available for refund requests.</del></div></td><td colspan="2"> </td></tr>
</table>
John
http://3.19.219.109/index.php?title=Payment_Gateway_Module_Parameters&diff=18455&oldid=prev
Matt: Created page with "All gateway module function calls receive a standardised list of parameters. These parameters provide data relating to the invoice the gateway module command is being invoked..."
2016-03-29T13:30:04Z
<p>Created page with "All gateway module function calls receive a standardised list of parameters. These parameters provide data relating to the invoice the gateway module command is being invoked..."</p>
<p><b>New page</b></p><div>All gateway module function calls receive a standardised list of parameters.<br />
<br />
These parameters provide data relating to the invoice the gateway module command is being invoked for along with the configuration setting values defined in for the given payment gateway.<br />
<br />
Certain functions will receive additional data specific to the action that is being requested. These are detailed below the standard list of variables.<br />
<br />
===Standardised Parameters===<br />
<br />
<table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table-striped"><br />
<tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr><br />
<tr bgcolor="#ffffff"><td>whmcsVersion</td><td>The current version of WHMCS. eg: 6.0.1-release.1</td></tr><br />
<tr bgcolor="#ffffff"><td>invoiceid</td><td>The invoice ID for which the gateway function has been invoked</td></tr><br />
<tr bgcolor="#ffffff"><td>invoicenum</td><td>The invoice number</td></tr><br />
<tr bgcolor="#ffffff"><td>amount</td><td>The amount due</td></tr><br />
<tr bgcolor="#ffffff"><td>description</td><td>A standardised payment descriptor - format: "[CompanyName] - Invoice #[InvoiceNum]"</td></tr><br />
<tr bgcolor="#ffffff"><td>clientsdetails</td><td>Provides an array of client profile data (see below)</td></tr><br />
<tr bgcolor="#ffffff"><td>systemurl</td><td>The url to the WHMCS installation eg. http://www.example.com/whmcs</td></tr><br />
<tr bgcolor="#ffffff"><td>returnurl</td><td>The invoice url to be returned to following completion or cancellation of payment</td></tr><br />
<tr bgcolor="#ffffff"><td>companyname</td><td>The system configured company name</td></tr><br />
<tr bgcolor="#ffffff"><td>name</td><td>The display name of the payment gateway that is being called</td></tr><br />
<tr bgcolor="#ffffff"><td>paymentmethod</td><td>The system name of the payment gateway that is being called</td></tr><br />
<tr bgcolor="#ffffff"><td>type</td><td>The type of payment gateway module</td></tr><br />
<tr bgcolor="#ffffff"><td>visible</td><td>Whether the payment gateway is visible</td></tr><br />
<tr bgcolor="#ffffff"><td>langpaynow</td><td>A localised text string for "Pay Now" based on the clients selected language</td></tr><br />
</table><br />
<br />
===Clients Details===<br />
<br />
The clients details parameter contains an array of client profile data for the client that owns the given product/service. This array includes:<br />
<br />
<table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table-striped"><br />
<tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr><br />
<tr bgcolor="#ffffff"><td>firstname</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>lastname</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>fullname</td><td>First Name + Last Name</td></tr><br />
<tr bgcolor="#ffffff"><td>companyname</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>email</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>address1</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>address2</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>city</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>state</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>statecode</td><td>2 Letter State Code (US & Canada Only)</td></tr><br />
<tr bgcolor="#ffffff"><td>postcode</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>country</td><td>2 Letter ISO Country Code</td></tr><br />
<tr bgcolor="#ffffff"><td>countryname</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>phonecc</td><td>Country Dialing Code Prefix (eg. 1 for US, 44 for UK, etc...)</td></tr><br />
<tr bgcolor="#ffffff"><td>phonenumber</td><td></td></tr><br />
<tr bgcolor="#ffffff"><td>phonenumberformatted</td><td>Phone Number in Format +X.XXXXXXX</td></tr><br />
<tr bgcolor="#ffffff"><td>twofaenabled</td><td>Two-Factor Status - Boolean true/false</td></tr><br />
<tr bgcolor="#ffffff"><td>currency</td><td>Currency ID (relates to tblcurrencies.id)</td></tr><br />
<tr bgcolor="#ffffff"><td>groupid</td><td>Client Group ID</td></tr><br />
<tr bgcolor="#ffffff"><td>language</td><td>Client defined language (defaults to empty)</td></tr><br />
<tr bgcolor="#ffffff"><td>customfields</td><td>Provides an array of all custom field names and values for the current client (see below)</td></tr><br />
<tr bgcolor="#ffffff"><td>status</td><td>Status of Client: Active, Inactive or Closed</td></tr><br />
<tr bgcolor="#ffffff"><td>notes</td><td>Admin only client notes</td></tr><br />
<tr bgcolor="#ffffff"><td>password</td><td>Hashed version of client area password - cannot be decrypted</td></tr><br />
</table><br />
<br />
===Capture===<br />
<br />
The following additional parameters are made available for capture requests.<br />
<br />
===Refunds===<br />
<br />
The following additional parameters are made available for refund requests.</div>
Matt