{"id":28364066,"url":"https://github.com/payrexx/payrexx-php","last_synced_at":"2025-11-14T07:00:56.721Z","repository":{"id":21750805,"uuid":"25072735","full_name":"payrexx/payrexx-php","owner":"payrexx","description":"Payrexx API for PHP","archived":false,"fork":false,"pushed_at":"2025-06-03T13:16:21.000Z","size":417,"stargazers_count":16,"open_issues_count":1,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-04T22:52:31.352Z","etag":null,"topics":["creditcard","payment-gateway","payment-integration","php","sdk-php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/payrexx.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-10-11T09:52:52.000Z","updated_at":"2025-04-09T09:44:26.000Z","dependencies_parsed_at":"2023-02-16T06:00:24.039Z","dependency_job_id":"8a42c4cf-f100-4b01-a0eb-535188e58e84","html_url":"https://github.com/payrexx/payrexx-php","commit_stats":{"total_commits":110,"total_committers":21,"mean_commits":5.238095238095238,"dds":0.7909090909090909,"last_synced_commit":"4eef7d12fb2650e53adeb25b57ab1f18301d100a"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"purl":"pkg:github/payrexx/payrexx-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payrexx%2Fpayrexx-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payrexx%2Fpayrexx-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payrexx%2Fpayrexx-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payrexx%2Fpayrexx-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/payrexx","download_url":"https://codeload.github.com/payrexx/payrexx-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payrexx%2Fpayrexx-php/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261582378,"owners_count":23180585,"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","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":["creditcard","payment-gateway","payment-integration","php","sdk-php"],"created_at":"2025-05-28T20:13:03.894Z","updated_at":"2025-11-14T07:00:56.703Z","avatar_url":"https://github.com/payrexx.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# payrexx-php SDK\n\n## Overview\n\nThis is the official PHP client library for the Payrexx API, supporting API version **1.0 - 1.11**. It enables easy integration with Payrexx payment services from your PHP applications.\n\n---\n\n## Versioning\n\n- This client library targets **Payrexx API version 1.11**.\n- Make sure to use the compatible library version to avoid compatibility issues.\n- The current stable release is **2.0.0**, which requires PHP 8.0 or higher.\n\n---\n\n## Requirements\n\n- **PHP version:** 8.0 or higher (recommended from version 2.0.0 onwards)\n- **PHP modules:** cURL extension enabled\n\n---\n\n## Installation\n\n### Using Composer (recommended)\n\nIf you do not have Composer installed, please visit [https://getcomposer.org/download/](https://getcomposer.org/download/) for installation instructions.\n\nAdd Payrexx SDK to your project via Composer:\n\n```bash\ncomposer require payrexx/payrexx\n```\nAlternatively, add this to your composer.json and run composer update:\n- For the latest development version:\n    ```JSON\n    {\n      \"require\": {\n        \"payrexx/payrexx\": \"dev-master\"\n      }\n    }\n    ```\n- For the stable version 2.0.0:\n    ```JSON\n    {\n      \"require\": {\n        \"payrexx/payrexx\": \"2.0.0\"\n      }\n    }\n    ```\n\nThis will install the SDK and generate the necessary autoload files.\n\n---\n\n## Quick Start\n1. Instantiate the Payrexx client\n    ```PHP\n    $instance = 'your-instance-name'; // e.g., 'demo' for https://demo.payrexx.com\n    $apiSecret = 'your-api-secret';   // Find this in your Payrexx instance admin panel\n    \n    $payrexx = new \\Payrexx\\Payrexx($instance, $apiSecret);\n    ```\n\n2. Create a model object\n    For example, to work with subscriptions:\n    ```PHP\n    use Payrexx\\Models\\Request\\Subscription;\n    \n    $subscription = new Subscription();\n    $subscription-\u003esetId(1);\n    ```\n\n3. Call API methods\n\n   For example, to cancel a subscription:\n    ```PHP\n    try {\n        $response = $payrexx-\u003ecancel($subscription);\n        $subscriptionId = $response-\u003egetId();\n    } catch (\\Payrexx\\PayrexxException $e) {\n        // Handle errors\n        echo 'Error Code: ' . $e-\u003egetCode() . PHP_EOL;\n        echo 'Error Message: ' . $e-\u003egetMessage() . PHP_EOL;\n    }\n    ```\n\n### Specifying the API Version\n\nThe Payrexx PHP SDK constructor supports an optional `$version` parameter that allows you to specify the API version you want to use.\n\n```PHP\n$instance = 'your-instance-name';\n$apiSecret = 'your-api-secret';\n\n// Specify the API version explicitly (e.g., \"1.8\")\n$apiVersion = '1.8';\n\n$payrexx = new \\Payrexx\\Payrexx(\n    $instance,\n    $apiSecret,\n    \\Payrexx\\Communicator::DEFAULT_COMMUNICATION_HANDLER,\n    '',           // leave empty if not using a custom API base domain\n    $apiVersion   // specify the API version here\n);\n```\n---\n\n## Using Platform Accounts (Custom API Base URL)\nIf you are working with Platform accounts, you must specify a custom API base domain when instantiating the client.\n\n```PHP\nuse Payrexx\\Communicator;\n\n$apiBaseDomain = 'your.domain.com';\n\n$payrexx = new \\Payrexx\\Payrexx(\n    $instance, \n    $apiSecret, \n    Communicator::DEFAULT_COMMUNICATION_HANDLER,\n    $apiBaseDomain\n);\n```\nNotes:\n\n- `$instance` is the subdomain part of your unique domain.\n- For example, if your login domain is client.platform.yourcompany.com, then:  \n  - `$instance = 'client'`\n  - `$apiBaseDomain = 'platform.yourcompany.com'`\n\n---\n\n## Documentation and Support\nFor detailed information about the API endpoints and data models, please refer to the official Payrexx REST API documentation:\nhttps://developers.payrexx.com/v1.0/reference\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayrexx%2Fpayrexx-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpayrexx%2Fpayrexx-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayrexx%2Fpayrexx-php/lists"}