Preparation Tasks

Before setting up the connector, you need to make some preparation tasks not only in your environment but also in Mirakl and Hyperwallet with the help of their respective support teams.

Mirakl preparation tasks

  1. Request Access to Mirakl SDK repository (the credentials will be needed during the build process). See the "Access to Artifactory" topic here.

  2. Ask Mirakl Support to enable the following features:

  3. Add to Mirakl the custom fields required by the connector. More details about it in Setting up required Mirakl Custom Fields

Hyperwallet preparation tasks

  1. Whitelist in Hyperwallet your server IPs, so the connector can make request to the Hyperwallet API.

  2. Configure in Hyperwallet connector’s URL for receiving webhook notifications. The connector listens for notifications in /webhooks/notifications path.

  3. Whitelist in your infrastructure Hyperwallet servers IP addresses (69.172.255.0/24 and 38.70.198.0/24) so notifications can reach the connector server.

More info about whitelisting and webhooks can be found here and here.

Connector environment requirements

For production and UAT it’s recommended to run the connector behind a load balancer or web proxy with a valid SSL/TLS certificate.

Setting up the required configuration variables

The connector provides sensible defaults for its configuration variables, so setting the required variables is enough for most of the scenarios.

Hyperwallet credentials and programs
PAYPAL_HYPERWALLET_API_SERVER
PAYPAL_HYPERWALLET_API_USERNAME
PAYPAL_HYPERWALLET_API_PASSWORD
PAYPAL_HYPERWALLET_PROGRAMS_NAMES
PAYPAL_HYPERWALLET_PROGRAMS_USERTOKENS
PAYPAL_HYPERWALLET_PROGRAMS_PAYMENTTOKENS
PAYPAL_HYPERWALLET_PROGRAMS_BANKACCOUNTTOKENS
Mirakl credentials
PAYPAL_MIRAKL_ENVIRONMENT
PAYPAL_MIRAKL_FRONT_API_KEY
PAYPAL_MIRAKL_OPERATOR_API_KEY
PAYPAL_MIRAKL_OPERATOR_TIME_ZONE
Email settings
PAYPAL_MAIL_SMTP_AUTH
PAYPAL_MAIL_SMTP_STARTTLS_ENABLE
PAYPAL_MAIL_USER_NAME
PAYPAL_MAIL_USER_PASSWORD
PAYPAL_SERVER_EMAIL_HOST
PAYPAL_SERVER_EMAIL_PORT

Configuration variables for new users

If you are NOT upgrading from 4.x versions, you should define the following variable setting its value to true.

PAYPAL_HYPERWALLET_NEW_USER_MAPPING_ENABLED=true
Changing the value of this variable can impact the KYC status of already verified sellers. So be sure not to change its value after onboarding sellers. More details about this variable in: Enabling and Disabling Optional Features