Configuration Environment Variables

The connector is configured using environment variables. There are many configuration variables that can be tweaked to tailor the connector to your needs. However, we have tried to provide good default values, so our recommendation is to stick with the defaults unless they don’t work for you.

Generic configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HMC_STARTUPCHECKS_EXITONFAIL

NO (default value: false)

Whether or not the application should shutdown if the startup checks found a severe error.

Possible values: true or false

PAYPAL_MANAGEMENT_ENABLED

NO (default value: false)

Enables HTTP management endpoints under /management/ path.

true

PAYPAL_HYPERWALLET_HTTP_CAPTURE_ENABLED

NO (default value: false)

Enables HTTP traffic logging.

true

PAYPAL_HYPERWALLET_DATA_DIR

NO (default value: ./data)

Directory where the application stores its runtime data.

/workspace/data

Hyperwallet configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_API_SERVER

YES

The URL for your Hyperwallet environment’s API (provided by Hyperwallet).

https://uat-api.paylution.com

PAYPAL_HYPERWALLET_API_USERNAME

YES

Hyperwallet environment username (provided by Hyperwallet).

restapiuser@000001

PAYPAL_HYPERWALLET_API_PASSWORD

YES

Hyperwallet environment password (provided by Hyperwallet).

yourSecret

PAYPAL_HYPERWALLET_PROGRAMS_NAMES

YES

A set of comma separated program names based on the program hierarchy provided by Hyperwallet (See the Program Configuration).

DEFAULT

PAYPAL_HYPERWALLET_PROGRAMS_IGNORED

YES

A set of comma separated values with the programs to be ignored. Sellers belonging to programs in this list won’t be processed by the connector.

<empty>

PAYPAL_HYPERWALLET_PROGRAMS_USERTOKENS

YES

A set of comma separated values with the program tokens to be used for contacting the Hyperwallet API on the /users path. Each token corresponds to the program name that resides in the same position in the list.

prg-6541532-as1a23s242-12as124-as2454,prg-b541532-cs1a23s242-12as124-as2454

PAYPAL_HYPERWALLET_PROGRAMS_PAYMENTTOKENS

YES (default value: DEFAULT)

A set of comma separated values with the program tokens to be used for contacting the Hyperwallet API on the /payments path. Each token corresponds to the program name that resides in the same position in the list.

prg-54545a532-asda2refs43-as2fd35-das233,prg-87545a532-asda2refs43-as2fd35-das233

PAYPAL_HYPERWALLET_PROGRAMS_BANKACCOUNTTOKENS

NO

A set of comma separated values with the transfer bank account tokens where commissions will be paid out. Each token corresponds to the program name that resides in the same position in the list. If commissions are disabled leave it empty, but still separated for commas (for example , if there are two programs, or ,, if there are three programs).

trm-2646asas54-21asdas5642-xasa45sxx, trm-bbb46asas54-21asdas5642-xasa45sxx

Mirakl configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_MIRAKL_ENVIRONMENT

YES

The URL for your Mirakl environment’s API (provided by Mirakl).

https://yourCompany.mirakl.net/api

PAYPAL_MIRAKL_SDK_USER

YES

Mirakl username for accessing the Mirakl Java SDK.

yourCompanyName

PAYPAL_MIRAKL_SDK_PASSWORD

YES

Mirakl password, for accessing the Mirakl Java

secret

PAYPAL_MIRAKL_OPERATOR_API_KEY

YES

The Mirakl operator API key generated for your operator account.

c262b297-c8a7-45a5-a22f-a0d9fe25132a

PAYPAL_MIRAKL_OPERATOR_TIME_ZONE

NO (default value: UTC)

The Mirakl time zone of your Mirakl instance. Possible values are documented here.

GMT, Europe/London

Alerts and mail configuration

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_SERVER_EMAIL_HOST

NO

The URL where your POP3/SMTP server is hosted. If you’re using the Docker Compose script provided in this repo, use smtp.

smtp.example.com

PAYPAL_SERVER_EMAIL_PORT

NO

The port used by your POP3/SMTP server. If you’re using the Docker Compose script provided in this repo, use 1025.

1025

PAYPAL_MAIL_SMTP_AUTH

NO

Whether or not authentication is needed for accessing the POP3/SMTP mail server.

Possible values: true or false

PAYPAL_MAIL_USER_NAME

NO

The username credential for using the POP3/SMTP server. It can be left empty if PAYPAL_MAIL_SMTP_AUTH is set to false.

smtp-username

PAYPAL_MAIL_USER_PASSWORD

NO

The password credential for using the POP3/SMTP server. It can be left empty if PAYPAL_MAIL_SMTP_AUTH is set to false.

smtp-pass

PAYPAL_MAIL_SMTP_STARTTLS_ENABLE

NO

Whether or not TLS is needed for establishing connection with the POP3/SMTP server.

Possible values:`true` or false

PAYPAL_HYPERWALLET_MAIL_RECIPIENT

NO (default value: recipient1@test.com)

The email recipient for the errors thrown by the connector.

recipient@email.com

PAYPAL_HYPERWALLET_MAIL_FROM

NO (default value: from@email.com)

The from email that appears on the emails sent by the connector.

from@email.com

Seller onboarding configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_EXTRACT_SELLERS_CRON_EXPRESSION

NO (default value: 0 0 0 1/1 * ? * )

The cron expression to trigger periodically the Sellers Extract Job.

0 0 0 1/1 * ? *

PAYPAL_HYPERWALLET_RETRY_SELLERS_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * * )

The cron expression to trigger periodically the Sellers Retry Job.

0 0/15 * ? * * *

PAYPAL_HYPERWALLET_EXTRACT_PROFESSIONAL_SELLERS_CRON_EXPRESSION

NO (default value: 0 0 0 1/1 * ? *)

The cron expression to trigger periodically the Professional Sellers Extract Job.

0 0 0 1/1 * ? *

PAYPAL_HYPERWALLET_RETRY_PROFESSIONAL_SELLERS_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * *)

The cron expression to trigger periodically the Professional Sellers Retry Job.

0 0/15 * ? * * *

PAYPAL_HYPERWALLET_BANK_ACCOUNT_EXTRACT_CRON_EXPRESSION

NO (default value: 0 30 0 1/1 * ? *)

The cron expression to trigger periodically the Bank account Extract Job.

0 30 0 1/1 * ? *

PAYPAL_HYPERWALLET_BANK_ACCOUNT_RETRY_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * *)

The cron expression to trigger periodically the Bank account Retry Job.

0 0/15 * ? * * *

KYC and business stakeholders configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_STK_MANDATORY_EMAIL

NO (default value: false)

By default, the business stakeholder email is not mandatory in Hyperwallet.

Possible values:`true` or false

PAYPAL_HYPERWALLET_RETRY_BUSINESS_STAKEHOLDERS_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * *)

The cron expression to trigger periodically the Business Stakeholders Retry Job.

0 0/15 * ? * * *

Invoices configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_OPERATOR_COMMISSIONS_ENABLED

NO (default value: true)

By default, the operator commissions feature is enabled.

Possible values:`true` or false

PAYPAL_HYPERWALLET_OPERATOR_CREDIT_NOTES_ENABLED

NO (default value: false)

By default, the direct processing of manual credit notes is disabled. This can be enabled to facilitate manual testing of payout scenarios.

Possible values:`true` or false

PAYPAL_HYPERWALLET_EXTRACT_INVOICES_CRON_EXPRESSION

NO (default value: 1 0 0 1/1 * ? *)

The cron expression to trigger periodically the Invoices Extract Job.

1 0 0 1/1 * ? *

PAYPAL_HYPERWALLET_RETRY_INVOICES_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * *)

The cron expression to trigger periodically the Invoices Retry Job.

0 0/15 * ? * * *

PAYPAL_HYPERWALLET_RETRY_CREDITNOTES_CRON_EXPRESSION

NO (default value: 0 0/15 * ? * * *)

The cron expression to trigger periodically the Credit Notes Retry Job.

0 0/15 * ? * * *

PAYPAL_HYPERWALLET_SEARCH_INVOICES_MAX_DAYS

NO (default value: 15)

Size in days of the search window when searching invoices by id. Used by invoice retry jobs.

Possible values: Any positive integer

Financial reports configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_BRAINTREE_MERCHANT_ID

NO

BrainTree merchant id provided by BrainTree.

myBrainTreeMerchantId

PAYPAL_BRAINTREE_PUBLIC_KEY

NO

BrainTree public key provided by BrainTree.

myBrainTreePublicKey

PAYPAL_BRAINTREE_PRIVATE_KEY

NO

BrainTree private key provided by BrainTree.

myBrainTreePrivateKey

PAYPAL_BRAINTREE_REPORT_ENVIRONMENT

NO

By default the value is pointing to the sandbox environment. In case you want to point to production environment, set the value to production.

sandbox

PAYPAL_HYPERWALLET_FINANCIAL_REPORTS_OUTPUT_DIR

NO (default value: ./financial-reports)

Directory where the application stores the financial reports.

/workspace/financial-reports

Generic job configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_JOB_EXTRACTION_MAXDAYS

NO (default value: 30)

The maximum number of days to look in the past when retrieving data from Mirakl during the extraction jobs.

Possible values: Any positive integer

PAYPAL_HYPERWALLET_MAX_FAILED_ITEMS_TO_BE_PROCESSED

NO (default value: 100)

As some Mirakl APIs have a maximun number of items to be requested it sets the amount of max number failed items to be processed on retry jobs

Possible values: Any positive integer

Hyperwallet webhook notifications configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_RETRY_FAILED _NOTIFICATIONS_CRON_EXPRESSION

NO (default value: 0 0/15 * * * ? *)

The cron expression to trigger periodically the Failed Notifications Retry Job.

1 30 0 1/1 * ? *

PAYPAL_HYPERWALLET_RETRY_NOTIFICATIONS

NO (default value: true)

Whether or not Hyperwallet notifications should be retried when an error occurs (e.g. connection issues). If set to true, any notification that fails is stored in the database and automatically restarted up to PAYPAL_HYPERWALLET_MAX_AMOUNT _OF_NOTIFICATION_RETRIES times. If set to false, notifications are not stored or retried

Possible values:`true` or false

PAYPAL_HYPERWALLET_MAX_AMOUNT_OF_NOTIFICATION_RETRIES

NO (default value: 5)

Sets the amount of retries a Hyperwallet notification operation can be retried before it is discarded. Whenever a notification is discarded, an email is sent to the integrators so it can be analyzed and addressed

Possible values: Any positive integer

Encryption configuration variables

ENVIRONMENT VARIABLE MANDATORY DESCRIPTION EXAMPLE VALUE

PAYPAL_HYPERWALLET_ENCRYPTION_ENABLED

NO (default value: false)

Enables or disables the usage of encryption for the communications between the connector and Hyperwallet, for both requests to Hyperwallet API and Hyperwallet notifications handling.

true`

PAYPAL_HYPERWALLET_KEY_SET_LOCATION

NO (default value: https://uat-api.paylution.com/jwkset)

The key set uri. For pointing to production, replace the value by https://api.paylution. com/jwkset

https://uat-api.paylution.com/jwkset

PAYPAL_HYPERWALLET_ENCRYPTION_ALGORITHM

NO

The algorithm used for Layer7 encryption Hyperwallet encryption

RSA-OAEP-256

PAYPAL_HYPERWALLET_SIGN_ALGORITHM

NO

The sign algorithm for Layer7 encryption Hyperwallet encryption

RS256

PAYPAL_HYPERWALLET_ENCRYPTION_METHOD

NO

The encryption method used for Layer7 encryption Hyperwallet encryption

A256CBC-HS512

PAYPAL_HYPERWALLET_PRIVATE_JWK_JSON_LOCATION

NO

The private/public JWK set location

/your/path/to/private/keys/jwk_set.key

PAYPAL_HYPERWALLET_PUBLIC_JWK_JSON_LOCATION

NO

The public JWK set location.

https://example.com/hw/shared