{"id":19888942,"url":"https://github.com/paypal/mirakl-hyperwallet-connector","last_synced_at":"2025-10-30T21:23:22.458Z","repository":{"id":37959521,"uuid":"375703273","full_name":"paypal/mirakl-hyperwallet-connector","owner":"paypal","description":"The Hyperwallet Mirakl Connector (HMC) is a self-hosted solution that mediates between a Mirakl marketplace solution and the Hyperwallet (PayPal) payout platform. ","archived":false,"fork":false,"pushed_at":"2024-03-19T12:03:53.000Z","size":8434,"stargazers_count":35,"open_issues_count":2,"forks_count":35,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-07-12T20:52:40.974Z","etag":null,"topics":["connector","hyperwallet","java","mirakl","paypal"],"latest_commit_sha":null,"homepage":"https://paypal.github.io/mirakl-hyperwallet-connector/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paypal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-06-10T13:15:29.000Z","updated_at":"2025-07-11T08:24:31.000Z","dependencies_parsed_at":"2024-01-31T17:11:02.064Z","dependency_job_id":null,"html_url":"https://github.com/paypal/mirakl-hyperwallet-connector","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"purl":"pkg:github/paypal/mirakl-hyperwallet-connector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2Fmirakl-hyperwallet-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2Fmirakl-hyperwallet-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2Fmirakl-hyperwallet-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2Fmirakl-hyperwallet-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paypal","download_url":"https://codeload.github.com/paypal/mirakl-hyperwallet-connector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2Fmirakl-hyperwallet-connector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278322146,"owners_count":25967874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["connector","hyperwallet","java","mirakl","paypal"],"created_at":"2024-11-12T18:08:42.546Z","updated_at":"2025-10-04T14:15:00.039Z","avatar_url":"https://github.com/paypal.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hyperwallet Mirakl Connector\n\n\u003e :warning: **If your are upgrading from versions 4.x**, you should read the\n\u003e [upgrade guide](https://paypal.github.io/mirakl-hyperwallet-connector/component-hmc/upgrade/upgrade.html),\n\u003e since there has been important changes in the requisites and configuration variables\n\u003e and the connector won't correctly run if you don't follow the instructions in the\n\u003e guide.\n\nHyperwallet-Mirakl Connector (HMC) is a drop-in service that interconnects\nMirakl and Hyperwallet providing payout connectivity between them.\n\nIt's designed to be easy to install and operate, providing self-healing features\nand a mail based alert system. The connector supports the following workflows:\n\n- Seller onboarding\n- KYC verification\n- Payout\n\nYou can find more information on its features and how to configure and deploy\nthe connector in the\n[online documentation](https://paypal.github.io/mirakl-hyperwallet-connector/).\n\n## Getting Started\n\n### Requirements\n\nFor building and running the connector you will need the following software:\n\n* Java JDK 17\n* Docker (Optional)\n\nFor the build process you will need to configure these two variables, since the\nconnector uses the Mirakl SDK which is hosted in a private Maven repository\nowned by Mirakl:\n\n```\nPAYPAL_MIRAKL_SDK_USER\nPAYPAL_MIRAKL_SDK_PASSWORD\n```\n\n### Building the Connector\n\nThe connector is a standard Spring-Boot application that uses Gradle as its\nbuild system. For building the connector you need to execute the following\ncommand:\n\n* `./gradlew clean build`\n\nAdditionally you can create an executable JAR with the following command:\n\n* `./gradlew app:bootJar`\n\nthat will generate the JAR in the directory  `app/build/libs`\n\n### Running the Connector\n\nBefore running the connector you must set the configuration environment\nvariables as described [here](#quick-configuration). With the environment set\nyou can run the connector by executing this command:\n\n* `./gradlew bootRun`\n\n### Checking if the connector is working\n\nTo ensure that the connector is properly set up and ready to work, you can check\nthe health endpoint using, for example, cUrl:\n\n* `curl -X GET --location \"http://localhost:8080/actuator/health\"`\n\nIf the connector is OK the endpoint will respond with a `200` OK status. If\nsomething is wrong it will respond with a `500` status and a JSON detailing the\nindividual checks and their statuses.\n\n### Quick Configuration\n\nThe connector is configured with environment variables. These are the minimum\nrequired variables that you will need to set to run the connector:\n\n**[Hyperwallet Credentials and Programs Configuration](https://paypal.github.io/mirakl-hyperwallet-connector/component-hmc/configuration/configvars/configvars.html#configvarsvars-hyperwallet)**\n\n```\nPAYPAL_HYPERWALLET_API_SERVER\nPAYPAL_HYPERWALLET_API_USERNAME\nPAYPAL_HYPERWALLET_API_PASSWORD\nPAYPAL_HYPERWALLET_PROGRAMS_NAMES\nPAYPAL_HYPERWALLET_PROGRAMS_USERTOKENS\nPAYPAL_HYPERWALLET_PROGRAMS_PAYMENTTOKENS\nPAYPAL_HYPERWALLET_PROGRAMS_BANKACCOUNTTOKENS\n```\n\n**[Mirakl Credentials](https://paypal.github.io/mirakl-hyperwallet-connector/component-hmc/configuration/configvars/configvars.html#configvarsvars-mirakl)**\n\n```\nPAYPAL_MIRAKL_ENVIRONMENT\nPAYPAL_MIRAKL_FRONT_API_KEY\nPAYPAL_MIRAKL_OPERATOR_API_KEY\n```\n\n**[Email Settings](https://paypal.github.io/mirakl-hyperwallet-connector/component-hmc/configuration/configvars/configvars.html#configvarsvars-alerts)**\n```\nPAYPAL_MAIL_SMTP_AUTH\nPAYPAL_MAIL_SMTP_STARTTLS_ENABLE\nPAYPAL_MAIL_USER_NAME\nPAYPAL_MAIL_USER_PASSWORD\nPAYPAL_SERVER_EMAIL_HOST\nPAYPAL_SERVER_EMAIL_PORT\n```\n\n### Running the connector with Docker Compose\n\nAlternative you can run the connector with Docker and Docker Compose. To do that\nyo need to execute the following commands:\n\n* `./gradlew build`\n* `./gradlew buildDockerCompose`\n\nIn addition to create a docker image for the connector it will also create a\n`docker-compose.yml` file for running it with Docker Compose. You can do that\nwith the following command:\n\n* `docker-compose up`\n\nThe generated `docker-compose.yml` is based on the\n`docker-compose.yml.template`. In addition to the connector it will also start\nan email server so you don't need one for development purposes.\n\nIf you want to generate a `docker-compose.yml` with only the connector, you can\nrun the following command:\n\n* `./gradlew buildDockerCompose -Pprod=true`\n\nIn this case it will use `docker-compose.prod.yml.template`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaypal%2Fmirakl-hyperwallet-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaypal%2Fmirakl-hyperwallet-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaypal%2Fmirakl-hyperwallet-connector/lists"}