{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Metadata Parameters","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"metadata-parameters","__idx":0},"children":["Metadata Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The metadata function allows you to define module related capabilities and settings."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payment Gateway Modules support the following metadata configuration parameters."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Supported As Of"},"children":["Supported As Of"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DisplayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["6.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module Name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An alternate display name that will be used instead of the filename if defined"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["APIVersion"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["5.2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1.1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines API Version the module uses. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.1"]}," unless you have a need specific to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1.0"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["gatewayType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["8.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["undefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This should be set to 'Bank' if the module is a Bank module, or the metadata should be omitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["failedEmail"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.7"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credit Card Payment Failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of an email template to send should a payment capture fail"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["successEmail"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.7"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credit Card Payment Confirmation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of an email template to send should a payment capture be successful"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pendingEmail"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["7.7"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credit Card Payment Pending"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of an email template to send should a payment capture be pending"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":1},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"function yourmodulename_MetaData()\n{\n    return [\n        'DisplayName' => 'Your Module Name',\n        'gatewayType' => 'Bank', // Only set if the module is a Bank Module\n        'failedEmail' => 'Credit Card Payment Failed',\n        'successEmail' => 'Custom Credit Card Payment Template', // You can utilise custom templates here\n        'pendingEmail' => 'Custom Credit Card Pending Template',\n        'APIVersion' => '1.1', // Use API Version 1.1\n    ];\n}\n\n"},"children":[]}]},"headings":[{"value":"Metadata Parameters","id":"metadata-parameters","depth":1},{"value":"Example","id":"example","depth":3}],"frontmatter":{"title":"Metadata Parameters","seo":{"title":"Metadata Parameters"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/payment-gateways/meta-data-params","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}