Difference between revisions of "Payment Gateway Module Parameters"
From WHMCS Documentation
(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...") |
(No difference)
|
Revision as of 13:30, 29 March 2016
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 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
| Parameter | Description |
|---|---|
| whmcsVersion | The current version of WHMCS. eg: 6.0.1-release.1 |
| invoiceid | The invoice ID for which the gateway function has been invoked |
| invoicenum | The invoice number |
| amount | The amount due |
| description | A standardised payment descriptor - format: "[CompanyName] - Invoice #[InvoiceNum]" |
| clientsdetails | Provides an array of client profile data (see below) |
| systemurl | The url to the WHMCS installation eg. http://www.example.com/whmcs |
| returnurl | The invoice url to be returned to following completion or cancellation of payment |
| companyname | The system configured company name |
| name | The display name of the payment gateway that is being called |
| paymentmethod | The system name of the payment gateway that is being called |
| type | The type of payment gateway module |
| visible | Whether the payment gateway is visible |
| langpaynow | A localised text string for "Pay Now" based on the clients selected language |
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:
| Parameter | Description |
|---|---|
| firstname | |
| lastname | |
| fullname | First Name + Last Name |
| companyname | |
| address1 | |
| address2 | |
| city | |
| state | |
| statecode | 2 Letter State Code (US & Canada Only) |
| postcode | |
| country | 2 Letter ISO Country Code |
| countryname | |
| phonecc | Country Dialing Code Prefix (eg. 1 for US, 44 for UK, etc...) |
| phonenumber | |
| phonenumberformatted | Phone Number in Format +X.XXXXXXX |
| twofaenabled | Two-Factor Status - Boolean true/false |
| currency | Currency ID (relates to tblcurrencies.id) |
| groupid | Client Group ID |
| language | Client defined language (defaults to empty) |
| customfields | Provides an array of all custom field names and values for the current client (see below) |
| status | Status of Client: Active, Inactive or Closed |
| notes | Admin only client notes |
| password | Hashed version of client area password - cannot be decrypted |
Capture
The following additional parameters are made available for capture requests.
Refunds
The following additional parameters are made available for refund requests.