{"id":33978207,"url":"https://github.com/ixopay/php-ixopay","last_synced_at":"2025-12-13T02:44:30.853Z","repository":{"id":37444313,"uuid":"42438582","full_name":"ixopay/php-ixopay","owner":"ixopay","description":"Accept payments and integrate 100+ payment methods on your PHP backend: the IXOPAY PHP SDK provides convenient access to the IXOPAY REST APIs.","archived":false,"fork":false,"pushed_at":"2025-07-24T10:04:50.000Z","size":568,"stargazers_count":9,"open_issues_count":2,"forks_count":13,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-11-18T22:57:29.833Z","etag":null,"topics":["client-library","ixopay","ixopay-client","payment","payment-gateway","php"],"latest_commit_sha":null,"homepage":"https://documentation.ixopay.com","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/ixopay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2015-09-14T09:10:29.000Z","updated_at":"2025-07-18T09:59:52.000Z","dependencies_parsed_at":"2022-08-18T23:51:01.168Z","dependency_job_id":"0e960f46-7d68-44a4-b55e-5ff492755b88","html_url":"https://github.com/ixopay/php-ixopay","commit_stats":null,"previous_names":[],"tags_count":86,"template":false,"template_full_name":null,"purl":"pkg:github/ixopay/php-ixopay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixopay%2Fphp-ixopay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixopay%2Fphp-ixopay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixopay%2Fphp-ixopay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixopay%2Fphp-ixopay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ixopay","download_url":"https://codeload.github.com/ixopay/php-ixopay/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ixopay%2Fphp-ixopay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27698918,"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-12-13T02:00:09.769Z","response_time":147,"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":["client-library","ixopay","ixopay-client","payment","payment-gateway","php"],"created_at":"2025-12-13T02:44:30.046Z","updated_at":"2025-12-13T02:44:30.843Z","avatar_url":"https://github.com/ixopay.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# IXOPAY PHP SDK\n\n\u003c!-- shields --\u003e\n[![Packagist][packagist-shield]][packagist-url]\n[![PHP Version][php-shield]][packagist-url]\n[![License][license-shield]][license]\n\nAccept payments and integrate 100+ payment methods on your PHP backend:\nthe [IXOPAY][ixopay] PHP SDK\nprovides convenient access to the [IXOPAY REST APIs][ixopay-docs-api].\n\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n\u003c!-- TOC --\u003e\n- [IXOPAY PHP SDK](#ixopay-php-sdk)\n  - [Installation](#installation)\n    - [Requirements](#requirements)\n    - [Composer](#composer)\n  - [Documentation](#documentation)\n  - [Usage](#usage)\n    - [Prerequisites](#prerequisites)\n    - [Setting up credentials](#setting-up-credentials)\n    - [Process a debit transaction](#process-a-debit-transaction)\n  - [Support](#support)\n  - [Licence](#licence)\n  - [See also](#see-also)\n\u003c!-- TOC --\u003e\n\n\u003c/details\u003e\n\n## Installation\n\n### Requirements\n\n- PHP v8.1 or newer\n- [Composer][composer]\n\n### Composer\n\nAdd the IXOPAY PHP SDK to your `composer.json`.\n\n```bash\ncomposer require ixopay/ixopay-php-client\n```\n\n## Documentation\n\nPlease see [IXOPAY Gateway Documentation][ixopay-docs-gateway] for general\ninformation about how to use the transaction processing API.\n\nSee the [IXOPAY API Reference][ixopay-docs-api] for a reference of all\ntransaction processing API calls.\n\n## Usage\n\n### Prerequisites\n\n- [IXOPAY][ixopay] account\n- API User - consisting of:\n  - username, and\n  - password\n- Connector - consisting of:\n  - API key, and\n  - optional: shared secret\n\n### Setting up credentials\n\nInstantiate a new `Ixopay\\Client\\Client` authenticated via your API user \u0026 password,\nconnecting it to a payment adapter identified by an API key and authenticated using a shared secret.\n\n```php\n\u003c?php\n\nuse Ixopay\\Client\\Client;\nuse Ixopay\\Client\\Data\\Customer;\nuse Ixopay\\Client\\Transaction\\Debit;\nuse Ixopay\\Client\\Transaction\\Result;\n\n// Instantiate the \"Ixopay\\Client\\Client\" with your credentials\n$api_user = \"your_username\";\n$api_password = \"your_username\";\n$connector_api_key = \"your_chosen_connector_api_key\";\n$connector_shared_secret = \"your_generated_connector_shared_secret\";\n$client = new Client($api_user, $api_password, $connector_api_key, $connector_shared_secret);\n```\n\n### Process a debit transaction\n\nOnce you instantiated a [client with credentials](#setting-up-credentials),\nyou can use the instance to make transaction API calls.\n\n```php\n\u003c?php\n\n// define your transaction ID: e.g. 'myId-'.date('Y-m-d').'-'.uniqid()\n$merchantTransactionId = 'your_transaction_id'; // must be unique\n\n$customer = new Customer()\n$customer = $customer\n    -\u003esetBillingCountry(\"AT\")\n    -\u003esetEmail(\"customer@example.org\");\n\n// after the payment flow the user is redirected to the $redirectUrl\n$redirectUrl = 'https://example.org/success';\n// all payment state changes trigger the $callbackUrl hook\n$callbackUrl = 'https://api.example.org/payment-callback';\n\n$debit = new Debit();\n$debit = $debit-\u003esetTransactionId($merchantTransactionId)\n    -\u003esetSuccessUrl($redirectUrl)\n    -\u003esetCancelUrl($redirectUrl)\n    -\u003esetCallbackUrl($callbackUrl)\n    -\u003esetAmount(10.00)\n    -\u003esetCurrency('EUR')\n    -\u003esetCustomer($customer);\n\n// send the transaction\n$result = $client-\u003edebit($debit);\n\n// now handle the result\nif ($result-\u003eisSuccess()) {\n    //act depending on $result-\u003egetReturnType()\n\n    $gatewayReferenceId = $result-\u003egetReferenceId(); //store it in your database\n\n    if ($result-\u003egetReturnType() == Result::RETURN_TYPE_ERROR) {\n        //error handling\n        $errors = $result-\u003egetErrors();\n        //cancelCart();\n\n    } elseif ($result-\u003egetReturnType() == Result::RETURN_TYPE_REDIRECT) {\n        //redirect the user\n        header('Location: '.$result-\u003egetRedirectUrl());\n        die;\n\n    } elseif ($result-\u003egetReturnType() == Result::RETURN_TYPE_PENDING) {\n        //payment is pending, wait for callback to complete\n\n        //setCartToPending();\n\n    } elseif ($result-\u003egetReturnType() == Result::RETURN_TYPE_FINISHED) {\n        //payment is finished, update your cart/payment transaction\n\n        //finishCart();\n    }\n}\n\n?\u003e\n```\n\n## Support\n\nIf you have suggestions for new features, spotted a bug, or encountered a\ntechnical problem, [create an issue here][repo-new-issue].\nAlso, you can always contact IXOPAY's Support Team as defined in your contract.\n\n## Licence\n\nThis repository is available under the [MIT License][license].\n\n## See also\n\n- [Documentation][ixopay-docs-gateway]\n- [API Reference][ixopay-docs-api]\n\n\u003c!-- references --\u003e\n[license]: LICENSE.md\n[ixopay]: https://ixopay.com\n[ixopay-docs-api]: https://documentation.ixopay.com/api/transaction/transaction-api\n[ixopay-docs-gateway]: https://documentation.ixopay.com\n[repo-new-issue]: https://github.com/ixopay/php-ixopay/issues/new/choose\n[packagist-shield]: https://img.shields.io/packagist/v/ixopay/ixopay-php-client.svg\n[packagist-url]: https://packagist.org/packages/ixopay/ixopay-php-client\n[php-shield]: https://img.shields.io/packagist/php-v/ixopay/ixopay-php-client.svg\n[license-shield]: https://img.shields.io/github/license/ixopay/php-ixopay.svg\n[composer]: https://getcomposer.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixopay%2Fphp-ixopay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fixopay%2Fphp-ixopay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fixopay%2Fphp-ixopay/lists"}