Mirakl Custom Fields Creation

Mirakl custom fields allow you to extend the Mirakl shop data model with new fields, that can also be edited from the Mirakl backend. The connector makes use of custom fields to:

  • Store internal required data to link Mirakl information with Hyperwallet.

  • Store additional information required by Hyperwallet not available in Mirakl (like the bank account state)

Before using the connector, you need to create in Mirakl the custom fields required by the connector. You can create custom fields from Mirakl Backoffice in the Settings > Advanced parameters > Shops section as explained in this guide.

The connector will check at the start up if all the fields are created correctly, as explained here.

Required Custom Fields

All custom fields listed here need to be created in Mirakl. The column (“Required/Optional”) indicated whether the value in this field need to be provided in Mirakl or not:

  • Required: the value must be provided for this field.

  • Optional: the value is not required but can be provided.

  • n/a: the value should not be provided by the user and will be auto-generated.

Hyperwallet Seller/Payee Details – Operator-only fields

Section Name: Hyperwallet Seller/Payee Details - Operator-only fields

Section Description: The fields in this section are for assisting in the operator’s administration & operation tasks. All fields herein should be invisible to sellers.

Code Label Description Type Values Shop permissions Required/ Optional

hw-program

Hyperwallet Program

Your Hyperwallet implementation may consist of one or more programs based on your payout needs. Select the appropriate program for this Seller/Payee.

Single value list

Values configured by the operator based on the program hierarchy agreed with Hyperwallet.

This is set to DEFAULT for a single-level merchant hierarchy. New values can be added in case of multi-level program hierarchy. More information on Configuring Programs.

Invisible

Required

hw-user-token

Hyperwallet User Token

Auto-generated, DO NOT change this value. This is a unique identifier for this Seller/Payee in Hyperwallet.

Text

Autogenerated

Invisible

n/a

hw-bankaccount-token

Hyperwallet Bank Account Token

Auto-generated, DO NOT change this value. This is a unique identifier for this Seller/Payee’s bank account in Hyperwallet.

Text

Autogenerated

Invisible

n/a

hw-bankaccount-state

Bank Account State/Province

Seller/Payee’s Bank Account State/Province

Text

Free text

Invisible

Required

Hyperwallet Ts & Cs and Privacy Policy consent

Note: this section is placed at the end of the Seller custom fields section, before the Contact details on the Seller Details page.

Section Name: Hyperwallet Ts & Cs and Privacy Policy consent

Section Description: Payment Services for your Store will be provided by Hyperwallet, a PayPal company. In order to use this marketplace, you are required to accept the Hyperwallet Terms of Services and Privacy Policy

Code Label Description Type Values Shop permissions Required/ Optional

hw-terms-consent

I accept the Hyperwallet Terms of Services and Privacy Policy: https://hyperwallet.com/agreements-terms

By accepting these terms I also agree that Hyperwallet may contact me directly to request additional information to verify my account. I will contact the marketplace operator if I need to revoke this.

Yes/No

Read Write

required