Aera Invoice
Learn all you need to know about our Aera Invoice plugin
Overview
Aera Invoice payment provider supports the following functionalities for existing Aera sessions:
- Invoice activation
- Refunds
- Authorization release/cancellation
Configuration Steps
- Navigate to:
Configuration > Settings > Orders > Payment > Payment Types > Add New > Aera Invoice
Required Settings
| Field | Value |
|---|---|
| Payment Setting Name | AeraInvoice |
| Payment Method Name | AeraInvoice |
| Provider Name | AeraInvoice |
| Display Name | Customizable |
| API Token | Your Aera authentication token |
| Base URL | - Test: https://api-staging.aerahost.com |
| Merchant ID | Id from Aera. Must either be set here or on the store property AeraMerchantId |
| Username (Property) | Your Aera username |
| Password (Property) | Your Aera password |
Note that the AeraMerchantId property on stores will not be used if Merchant ID is set in the plugin configurations.
Additional Configuration
| Field | Value |
|---|---|
| Vue Template | aera-payment |
| Display in cart | true |
- Enablement:
- Configure settings to enable Aera for specific stores and markets as needed.
Add Payments with the API
Payments can be added to orders by for instance using the endpoint /api/Orders/{orderId}/AddPayments with status Processed and matching the payment method name with the one in settings. Transaction IDs that are GUIDs are assumed to be payment references from Aera while everything else is assumed to be transaction IDs.
For returns to work we need to send the same ItemId to Aera as the one used in the items when creating the invoice. Currently, we try to use EAN/GTIN and fall back to LineItemId.