|
|
| Line 1: |
Line 1: |
| − | All gateway module function calls receive a standardised list of parameters.
| + | This page has moved to https://developers.whmcs.com/payment-gateways/third-party-gateway/ |
| − | | |
| − | 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.
| |
| − | | |
| − | Certain functions will receive additional data specific to the action that is being requested. These are detailed below the standard list of variables.
| |
| − | | |
| − | ===Standardised Parameters===
| |
| − | | |
| − | <table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table-striped">
| |
| − | <tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr>
| |
| − | <tr bgcolor="#ffffff"><td>whmcsVersion</td><td>The current version of WHMCS. eg: 6.0.1-release.1</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>invoiceid</td><td>The invoice ID for which the gateway function has been invoked</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>invoicenum</td><td>The invoice number</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>amount</td><td>The amount due</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>description</td><td>A standardised payment descriptor - format: "[CompanyName] - Invoice #[InvoiceNum]"</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>clientsdetails</td><td>Provides an array of client profile data (see below)</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>systemurl</td><td>The url to the WHMCS installation eg. http://www.example.com/whmcs</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>returnurl</td><td>The invoice url to be returned to following completion or cancellation of payment</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>companyname</td><td>The system configured company name</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>name</td><td>The display name of the payment gateway that is being called</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>paymentmethod</td><td>The system name of the payment gateway that is being called</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>type</td><td>The type of payment gateway module</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>visible</td><td>Whether the payment gateway is visible</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>langpaynow</td><td>A localised text string for "Pay Now" based on the clients selected language</td></tr>
| |
| − | </table>
| |
| − | | |
| − | ===Clients Details===
| |
| − | | |
| − | The clients details parameter contains an array of client profile data for the client that owns the given product/service. This array includes:
| |
| − | | |
| − | <table width="100%" cellspacing="1" bgcolor="#cccccc" class="table table-striped">
| |
| − | <tr bgcolor="#efefef"><th>Parameter</th><th>Description</th></tr>
| |
| − | <tr bgcolor="#ffffff"><td>firstname</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>lastname</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>fullname</td><td>First Name + Last Name</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>companyname</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>email</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>address1</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>address2</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>city</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>state</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>statecode</td><td>2 Letter State Code (US & Canada Only)</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>postcode</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>country</td><td>2 Letter ISO Country Code</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>countryname</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>phonecc</td><td>Country Dialing Code Prefix (eg. 1 for US, 44 for UK, etc...)</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>phonenumber</td><td></td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>phonenumberformatted</td><td>Phone Number in Format +X.XXXXXXX</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>twofaenabled</td><td>Two-Factor Status - Boolean true/false</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>currency</td><td>Currency ID (relates to tblcurrencies.id)</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>groupid</td><td>Client Group ID</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>language</td><td>Client defined language (defaults to empty)</td></tr>
| |
| − | <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>
| |
| − | <tr bgcolor="#ffffff"><td>status</td><td>Status of Client: Active, Inactive or Closed</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>notes</td><td>Admin only client notes</td></tr>
| |
| − | <tr bgcolor="#ffffff"><td>password</td><td>Hashed version of client area password - cannot be decrypted</td></tr>
| |
| − | </table>
| |
| − | | |
| − | ===Capture===
| |
| − | | |
| − | The following additional parameters are made available for capture requests.
| |
| − | | |
| − | ===Refunds===
| |
| − | | |
| − | The following additional parameters are made available for refund requests.
| |