{"id":294,"date":"2023-01-21T20:42:44","date_gmt":"2023-01-21T17:42:44","guid":{"rendered":"https:\/\/akaunting.com\/hc\/?post_type=docs&p=294"},"modified":"2023-01-21T20:56:20","modified_gmt":"2023-01-21T17:56:20","slug":"making-a-payment-method","status":"publish","type":"docs","link":"https:\/\/akaunting.com\/hc\/docs\/developers\/making-a-payment-method\/","title":{"rendered":"Making a payment method"},"content":{"rendered":"\n

Akaunting is not used only for accounting management but also for getting invoices paid. That said, Akaunting is being used in 150+ countries that accept different payment methods. For example, while in Brazil PagSeguro is used to get paid, eWay is the leader of online payments in Australia. Therefore, there is a separate category for\u00a0payment methods<\/a>\u00a0in Akaunting App Store.<\/p>\n\n\n\n

Akaunting ships with the famous Omnipay package, which eases the way to accept payments. Furthermore, Akaunting has a specific trait<\/a> for Omnipay which sets the invoice details and makes the proper redirects.<\/p>\n\n\n\n

First of all, create and install a module<\/a>.<\/p>\n\n\n\n

Composer<\/h3>\n\n\n\n

First, let\u2019s add the Omnipay v3 gateway to the composer file.<\/p>\n\n\n\n

{\n    \"require\": {\n        \"omnipay\/paypal\": \"3.0.*\"\n    },\n    \"replace\": {\n        \"guzzlehttp\/guzzle\": \"*\",\n        \"guzzlehttp\/psr7\": \"*\",\n        \"laravel\/framework\": \"*\",\n        \"omnipay\/common\": \"*\",\n        \"symfony\/http-foundation\": \"*\"\n    },\n    \"scripts\": {\n        \"test\": [\n            \"composer install --prefer-dist --no-interaction --no-scripts --no-suggest --no-progress --no-ansi\"\n        ]\n    }\n}<\/code><\/pre>\n\n\n\n
Settings<\/h3>\n\n\n\n
The module should offer some settings such as API Key, Secret, etc. to the user\/company that will get the payments. As described in the Settings<\/a> documentation, you can do it 2 ways but generally the module.json<\/code> file is more than enough for payment methods.<\/p>\n\n\n\n
{\n    \"alias\": \"paypal-express\",\n    \"icon\": \"simple-icons-paypal\",\n    \"version\": \"1.0.0\",\n    \"active\": 1,\n    \"providers\": [\n        \"Modules\\\\PaypalExpress\\\\Providers\\\\Event\",\n        \"Modules\\\\PaypalExpress\\\\Providers\\\\Main\"\n    ],\n    \"aliases\": {},\n    \"files\": [],\n    \"requires\": [],\n    \"settings\": [\n        {\n            \"type\": \"text\",\n            \"name\": \"name\",\n            \"title\": \"general.name\",\n            \"attributes\": {\n                \"required\": \"required\"\n            },\n            \"rules\": \"required|string\"\n        },\n        {\n            \"type\": \"text\",\n            \"name\": \"order\",\n            \"title\": \"paypal-express::general.order\",\n            \"attributes\": {},\n            \"rules\": \"nullable|integer\"\n        },\n        {\n            \"type\": \"text\",\n            \"name\": \"username\",\n            \"title\": \"paypal-express::general.username\",\n            \"attributes\": {\n                \"required\": \"required\"\n            },\n            \"rules\": \"required\"\n        },\n        {\n            \"type\": \"text\",\n            \"name\": \"password\",\n            \"title\": \"paypal-express::general.password\",\n            \"attributes\": {\n                \"required\": \"required\"\n            },\n            \"rules\": \"required\"\n        },\n        {\n            \"type\": \"text\",\n            \"name\": \"signature\",\n            \"title\": \"paypal-express::general.signature\",\n            \"attributes\": {\n                \"required\": \"required\"\n            },\n            \"rules\": \"required\"\n        },\n        {\n            \"type\": \"select\",\n            \"name\": \"mode\",\n            \"title\": \"paypal-express::general.mode\",\n            \"values\": {\n                \"live\": \"Live\",\n                \"test\": \"Test\"\n            },\n            \"selected\": \"live\",\n            \"attributes\": {},\n            \"rules\": \"required\"\n        },\n        {\n            \"type\": \"accountSelect\",\n            \"name\": \"account_id\",\n            \"attributes\": {\n                \"required\": \"required\"\n            },\n            \"rules\": \"required\"\n        },\n        {\n            \"type\": \"toggle\",\n            \"name\": \"customer\",\n            \"title\": \"paypal-express::general.customer\",\n            \"attributes\": {}\n        }\n    ]\n}<\/code><\/pre>\n\n\n\n
Listener<\/h3>\n\n\n\n
To get shown in the payment method list when the customer views the invoice in the client portal<\/code> or via a signed<\/code> link, you have to register your module as shown below:<\/p>\n\n\n\n
<?php<\/strong>\n\nnamespace Modules\\PaypalExpress\\Listeners;\n\nuse App\\Events\\Module\\PaymentMethodShowing as Event;\n\nclass ShowAsPaymentMethod\n{\n    public function handle(Event $event): void\n    {\n        $method = setting('paypal-express');\n\n        $method['code'] = 'paypal-express';\n\n        $event->modules->payment_methods[] = $method;\n    }\n}<\/code><\/pre>\n\n\n\n
Routes<\/h3>\n\n\n\n
Getting shown in the payment methods list is the first step; the next one is to have the routes set up. The module should have at least 2 route files: portal.php<\/code> for customers logged in and signed.php<\/code> for guests with a shared link. Here you can see the examples:<\/p>\n\n\n\n
portal.php<\/h4>\n\n\n\n
<?php<\/strong>\n\nuse Illuminate\\Support\\Facades\\Route;\n\n\/**\n * 'portal' middleware and 'portal\/paypal-express' prefix applied to all routes (including names)\n *\n * @see \\App\\Providers\\Route::register\n *\/\n\nRoute::portal('paypal-express', function () {\n    Route::get('invoices\/{invoice}', 'Payment@show')->name('invoices.show');\n    Route::post('invoices\/{invoice}\/confirm', 'Payment@confirm')->name('invoices.confirm');\n    Route::get('invoices\/{invoice}\/return', 'Payment@return')->name('invoices.return');\n    Route::get('invoices\/{invoice}\/cancel', 'Payment@cancel')->name('invoices.cancel');\n});<\/code><\/pre>\n\n\n\n
signed.php<\/h4>\n\n\n\n
<?php<\/strong>\n\nuse Illuminate\\Support\\Facades\\Route;\n\n\/**\n * 'signed' middleware and 'signed\/paypal-express' prefix applied to all routes (including names)\n *\n * @see \\App\\Providers\\Route::register\n *\/\n\nRoute::signed('paypal-express', function () {\n    Route::get('invoices\/{invoice}', 'Payment@show')->name('invoices.show');\n    Route::post('invoices\/{invoice}\/confirm', 'Payment@confirm')->name('invoices.confirm');\n    Route::get('invoices\/{invoice}\/return', 'Payment@return')->name('invoices.return');\n    Route::get('invoices\/{invoice}\/cancel', 'Payment@cancel')->name('invoices.cancel');\n});<\/code><\/pre>\n\n\n\n
Controller<\/h3>\n\n\n\n
Now that you\u2019ve set up everything, it\u2019s time to create the controller:<\/p>\n\n\n\n
<?php<\/strong>\n\nnamespace Modules\\PaypalExpress\\Http\\Controllers;\n\nuse App\\Abstracts\\Http\\PaymentController;\nuse App\\Models\\Sale\\Invoice;\nuse App\\Traits\\Omnipay;\nuse Illuminate\\Http\\Request;\n\nclass Payment extends PaymentController\n{\n    use Omnipay;\n\n    public $alias = 'paypal-express';\n\n    public $type = 'redirect';\n\n    public function confirm(Invoice $invoice, Request $request)\n    {\n        $this->create('PayPal_Express');\n\n        return $this->purchase($invoice, $request, [\n            'username' => $this->setting['username'],\n            'password' => $this->setting['password'],\n            'signature' => $this->setting['signature'],\n            'testMode' => ($this->setting['mode'] == 'test'),\n        ]);\n    }\n\n    public function return(Invoice $invoice, Request $request)\n    {\n        $this->create('PayPal_Express');\n\n        return $this->completePurchase($invoice, $request, [\n            'username' => $this->setting['username'],\n            'password' => $this->setting['password'],\n            'signature' => $this->setting['signature'],\n            'testMode' => ($this->setting['mode'] == 'test'),\n        ]);\n    }\n}<\/code><\/pre>\n\n\n\n
As you can see from the example, it doesn\u2019t extend the general Controller<\/a> but PaymentController<\/a> abstract of Akaunting. The confirm<\/code> and return<\/code> functions will first create an instance of Ompnipay and then redirect the customer.<\/p>\n\n\n\n
As it\u2019s also mentioned in the documentation of Omnipay, there are 2 types of payment methods: hosted<\/code> which embeds the credit card form and redirect<\/code> which redirects the customer to the payment method site to make the payment and redirects them back to Akaunting.<\/p>\n\n\n\n
The view\/blade part of both credit card and redirect is built into<\/a> Akaunting, so you don\u2019t have to take any further action unless you don\u2019t want to override them.<\/p>\n\n\n\n
Language<\/h3>\n\n\n\n
Finally, the language file in Resources\/lang\/en-GB\/general.php<\/code> should be something like this:<\/p>\n\n\n\n
<?php<\/strong>\n\nreturn [\n\n    'name'              => 'PayPal Express',\n    'description'       => 'Express Checkout for faster PayPal transactions',\n\n    'customer'          => 'Show to Customer',\n    'username'          => 'Username',\n    'password'          => 'Password',\n    'signature'         => 'Signature',\n    'mode'              => 'Mode',\n    'order'             => 'Order',\n\n    'error' => [\n\n    ],\n];<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Akaunting is not used only for accounting management but also for getting invoices paid. That said, Akaunting is being used in 150+ countries that accept different payment methods. For example, while in Brazil PagSeguro is used to get paid, eWay is the leader of online payments in Australia. Therefore, there is a separate category for\u00a0payment […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":31,"menu_order":13,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-294","docs","type-docs","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/294","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/comments?post=294"}],"version-history":[{"count":3,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/294\/revisions"}],"predecessor-version":[{"id":307,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/294\/revisions\/307"}],"up":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/31"}],"wp:attachment":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/media?parent=294"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/doc_tag?post=294"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}