Skip to main content
Advanced Search
Search Terms
Content Type

Exact Matches
Tag Searches
Date Options
Updated after
Updated before
Created after
Created before

Search Results

418 total results found

Module Development

Developer Documentation

Module Development

How do I register a custom Vue component for my module

Developer Documentation Module Development

To register a Vue component for our module, we will need to create a JavaScript file for our components and in order to initialize Vue. Link assets In order to link all the assets, which is a necessary step of registering a Vue component, we need to add a func...

Anatomy of a custom module

Developer Documentation Module Development

└─ module └─ database └─ migrations └─ public └─ resources └─ css └─ js └─ views └─ admin └─ store └─ routes └─ src └─ Http └─ Control...

How do I create a custom module?

Developer Documentation Module Development

When interacting with the admin, especially when making a custom module, it is important to require aerocommerce/adminin the modules’ composer.jsonfile. Scaffolding modules Modules can be created using artisan, a command line interface supplied with Laravel....

How do I setup routes for my custom module?

Developer Documentation Module Development

There are a few necessary steps to create and properly configure module routing. Creating routes The first step to creating module routes is to create a directory named routeson the same level as the srcdirectory – for more information refer to "Anatomy of a c...

Payment Drivers

Developer Documentation

Payment Drivers

What is the payment driver interface in my payment driver?

Developer Documentation Payment Drivers

All payment gateway drivers must implement the Aero\Payment\Contracts\PaymentDriverinterface. The Aero\Payment\PaymentDriverabstract class can be used as the starting point, which supports the ECOMoperation mode by default. It's important to register the pa...

What are the capturing methods in my payment driver?

Developer Documentation Payment Drivers

here are two types of capturing methods: Automatic– the payment is both authorised and captured when the customer clicks the pay button - Manual– the payment is authorised when the customer clicks the pay button, the funds are ring-fenced and captured at a lat...

How do I cancel a payment in my payment driver?

Developer Documentation Payment Drivers

If capturing of the payment is done at a later stage to the initial authorisation, the payment gateway should support the ability to cancel the transaction. The driver should therefore implement a cancelmethod. The cancelmethod should return a Aero\Payment\...

How do I capture a payment in my payment driver?

Developer Documentation Payment Drivers

If the gateway provides the option to defer capturing the payment (authorising and capturing are performed at different times), the capturemethod should be implemented. This captured amount may be equal to or less than the authorised amount, and is always pas...

How do I refund a payment in my payment driver?

Developer Documentation Payment Drivers

If the payment gateway provides the ability to externally make refund requests, the payment driver can use the Aero\Payment\SupportsRefundingtrait. The refundmethod should then be implemented, which returns an instance of Aero\Payment\Responses\PaymentRespo...

What are operating modes in my payment driver?

Developer Documentation Payment Drivers

There are two modes a gateway can operate: ECOM– a standard ecommerce online transaction, typically originating from the storefront - MOTO– a transaction that is taken via telephone or through the mail, typically originating from the backend admin As the proc...

How do I support express checkout in my payment driver?

Developer Documentation Payment Drivers

If the payment gateway stores customer information, this can be used to populate the contact information, billing and/or shipping address. To specify that the payment gateway supports the express checkout flow, use the Aero\Payment\OffersExpressCheckouttrait....

Can I restricting availability of my payment driver?

Developer Documentation Payment Drivers

It is likely that a payment gateway could have restrictions on when it can be used. For example, a finance based provider may require a certain order total amount, be restricted by geographical location or the items being purchased. To determine if the gateway...

How do I return a payment response in my payment driver?

Developer Documentation Payment Drivers

To unify all payment gateway driver communication, an Aero\Payment\Responses\PaymentResponseclass is used. This common class must be returned from the register, complete, capture, refundand cancelmethods. Setting the payment view Many payment gateways us...

How do I register the transaction in my payment driver?

Developer Documentation Payment Drivers

When a payment method is selected that uses the gateway driver, the registermethod is called. Within this method, the bootstrapping of the transaction should be carried out. This may involve connecting to the payment gateway's API to register the transaction....

How do I complete the transaction in my payment driver?

Developer Documentation Payment Drivers

Once the payment gateway has handled the customer inputting their secure details (such as card information), they will most likely be redirected back to the retailer's store. On doing so, the completemethod is called on the payment driver, allowing for the tr...

How do I display payment icons on checkout in my payment driver?

Developer Documentation Payment Drivers

To improve brand awareness of the payment provider during the checkout process, a label view can be used. The payment driver should implement the labelView method, which returns a string. This is typically a namespaced view that lives in the payment gateway mo...