{"id":460,"date":"2025-03-20T17:26:54","date_gmt":"2025-03-20T17:26:54","guid":{"rendered":"http:\/\/documentation.wpgetpaid.com\/?post_type=gd_place&p=460"},"modified":"2025-03-26T15:12:38","modified_gmt":"2025-03-26T15:12:38","slug":"creating-a-payment-gateway","status":"publish","type":"gd_place","link":"https:\/\/wpgetpaid.com\/documentation\/article\/developers-developers\/creating-a-payment-gateway\/","title":{"rendered":"Creating a Payment Gateway"},"content":{"rendered":"\n

Developers can extend the GetPaid_Payment_Gateway<\/a> PHP class to create their own custom payment gateways. This class will take care of registering the payment gateway and provide a way of adding the admin settings fields and frontend payment fields.<\/p>\n\n\n\n

GetPaid supports 4 different types of payment gateways:-<\/strong><\/p>\n\n\n\n

    \n
  1. Redirect <\/strong>– When a customer clicks on the pay now button, this payment gateway redirects them to the payment processor’s website. For example, PayPal.<\/li>\n\n\n\n
  2. iFrame based<\/strong> – The payment fields (e.g credit card forms) are loaded within the payment form in an iframe. For example, Square and Stripe.<\/li>\n\n\n\n
  3. Embedded <\/strong>– The payment fields (e.g credit card forms) are added directly\u00a0to the payment form. For example,\u00a0Authorize.net AIM. These types of gateways may require the website to be PCI compliant<\/a>.<\/li>\n\n\n\n
  4. Offline <\/strong>– Money is collected offline and the invoice is manually marked as paid. For example, Bank Transfer.<\/li>\n<\/ol>\n\n\n\n

    Creating a simple payment gateway<\/h2>\n\n\n\n

    Start by creating a PHP class that extends the GetPaid_Payment_Gateway <\/strong>class as shown…<\/p>\n\n\n\n

    <?php\n\/**\n * Custom payment gateway\n *\n *\/\n\ndefined( 'ABSPATH' ) || exit;\n\n\/**\n * Custom Payment Gateway class.\n *\n *\/\nclass My_Custom_Gateway extends GetPaid_Payment_Gateway {\n\n}<\/code><\/pre>\n\n\n\n
    Next, use the getpaid_default_gateways<\/a> filter hook to register the payment gateway as shown below.<\/p>\n\n\n\n
    \/**\n * Registers the gateway.\n *\/\nfunction register_my_custom_gateway( $gateways ){\n    $gateways['custom'] = 'My_Custom_Gateway';\n    return $gateways;\n}\nadd_filter( 'getpaid_default_gateways', 'register_my_custom_gateway' );<\/code><\/pre>\n\n\n\n
    That’s all.<\/strong><\/p>\n\n\n\n
    However, before the gateway can be used to process payments and subscriptions, you need to implement a few required methods.<\/p>\n\n\n\n
    Required Methods<\/h3>\n\n\n\n
    Most methods will be inherited from the GetPaid_Payment_Gateway class, but some are required in your custom gateway.<\/p>\n\n\n\n
    __construct()<\/h4>\n\n\n\n
    This is where you set a unique id for the gateway and give it a name and description. In addition, you can also set the features that your gateway supports and add some hooks that are unique to the gateway.<\/p>\n\n\n\n
    Some of the properties that you can set here include:-<\/p>\n\n\n\n