Introduction

Laybuy is a credit payment provider that allows customers to spread the cost of their order value over multiple payments. Aurora's integration with Laybuy allows your customers to make use of Laybuy's payment plans when placing orders via the Aurora Front-end.

🚧

The Laybuy payment solution does not currently offer deferred payment capture and as such all Laybuy payment transactions are essentially instance payments and must be manually refunded where an order cannot be fulfilled.

Initial Setup

🚧

The Laybuy Integration uses the Aurora Microservice (MS) framework, and as such must be set-up in advance by Aurora Commerce before you can use it with your store.

Doing this requires a one-off development to setup and configure your store to use the Laybuy MS, after which, you can then configure the integration at your own leisure.

If you have not yet had (or do not know if you have had) the Laybuy MS setup and configured for your store, then please contact Aurora Commerce for more details regarding how to get this done.

In order to configure your Laybuy MS, you will need to request the following details from Laybuy:

• Laybuy API endpoint prefix
• Laybuy Merchant ID
• Laybuy API key

Please request these details for both Staging (Test) and Production (Live) environments, so that you can test your integration before go live.

Aurora Backend Settings

Once the Laybuy MS has been setup and enabled for your store, you can follow these steps to allow your customers to use it on your front-end checkout.

Enable the Laybuy Microservice

Store > Settings > Feeds > Microservice > Proxy-laybuy

Configure visibility of the Laybuy payment option (in conjunction with the "Payment Types Accepted at Checkout" setting):

🚧

This 'visibility behaviour' is enforced entirely within the Aurora Front-end Templates and so is the default behaviour offered by the Aurora Demo Example Front-end Templates, but may not be how your own Front-end Templates are configured.

If you run into issues with payment option visibility, please check your Front-end Templates for the appropriate logic.

Payment Types Accepted at Checkout

Store > Settings > Payment Providers

Configure Aurora to accept orders using the Laybuy payment type:

🚧

This 'visibility behaviour' is enforced entirely within the Aurora Front-end Templates and so is the default behaviour offered by the Aurora Demo Example Front-end Templates, but may not be how your own Front-end Templates are configured.

If you run into issues with payment option visibility, please check your Front-end Templates for the appropriate logic.

Microservice Settings

Store > Microservice > Proxy Laybuy

Configure the Laybuy MS to communicate with the Laybuy API:

Aurora Service Errors

Content > Site Text

User error messages from the Aurora payment service that can be changed and translated using the Aurora Site Text system:

Frontend Template Integration

In order to use the Laybuy MS within your checkout, you must simply include the following values within your checkout submission:

Example template:

{if $config.microservice_proxylaybuy_live}
<p>
    <input name="payment_custom_fields[proxy-laybuy]" value="true" type="hidden" />
    <input type="radio" class="radio" name="payment_type" id="proxy-laybuy" value="proxy-laybuy" />
    <label class="checkout_label_radio" for="proxy-laybuy">{site_text page="Checkout" part="Label: Laybuy"}</label>
</p>
{/if}

Testing

Please see the following documentation from Laybuy on testing: https://integrations.laybuy.com/reference#how-to-test