PHPackages pagamastarde/orders-api-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. pagamastarde/orders-api-client Abandoned → [pagantis/orders-api-client](/?search=pagantis%2Forders-api-client)Library[API Development](/categories/api) pagamastarde/orders-api-client ============================== Pagantis Orders Api Client in PHP. Use the api with simple methods and using OOP. v2.1.5(6y ago)15.1k2proprietaryPHPPHP >=5.3CI failing Since Jun 17Pushed 5y ago2 watchersCompare [ Source](https://github.com/pagantis/orders-api-client)[ Packagist](https://packagist.org/packages/pagamastarde/orders-api-client)[ RSS](/packages/pagamastarde-orders-api-client/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (10)Dependencies (4)Versions (31)Used By (2) Orders Api Client [![](https://camo.githubusercontent.com/034cb504b587da689b4ac60e7dd147e8e6d548fa3dae0d4dfde649bdd7d1a792/68747470733a2f2f7777772e706167616e7469732e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031392f30322f63726f707065642d706167616e7469735f6c6f676f2d312e706e67)](https://camo.githubusercontent.com/034cb504b587da689b4ac60e7dd147e8e6d548fa3dae0d4dfde649bdd7d1a792/68747470733a2f2f7777772e706167616e7469732e636f6d2f77702d636f6e74656e742f75706c6f6164732f323031392f30322f63726f707065642d706167616e7469735f6c6f676f2d312e706e67) =============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== [](#orders-api-client-) CircleCI: [![CircleCI](https://camo.githubusercontent.com/740860c8290e4cef904da4f71e8551ee6a39951026cb1288a9cb64ac2a91ea95/68747470733a2f2f636972636c6563692e636f6d2f67682f706167616e7469732f6f72646572732d6170692d636c69656e742f747265652f6d61737465722e7376673f7374796c653d737667)](https://circleci.com/gh/pagantis/orders-api-client/tree/master) [![Latest Stable Version](https://camo.githubusercontent.com/533d8d3ba0255f31ced591e856d7a8d054d3d61086ede1f49d7fb60f4ec51ee9/68747470733a2f2f706f7365722e707567782e6f72672f706167616e7469732f6f72646572732d6170692d636c69656e742f762f737461626c65)](https://packagist.org/packages/pagantis/orders-api-client)[![composer.lock](https://camo.githubusercontent.com/5644ca6af0d8b8e27d88e6307ebec8da8a01f4ab6aeedb74c449b94f26c5a767/68747470733a2f2f706f7365722e707567782e6f72672f706167616e7469732f6f72646572732d6170692d636c69656e742f636f6d706f7365726c6f636b)](https://packagist.org/packages/pagantis/orders-api-client)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/b6d9eac817edbe43cd716448b8b78835d6e3637b7f8e339e0b6e6a0c00f80023/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f706167616e7469732f6f72646572732d6170692d636c69656e742f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/pagantis/orders-api-client/?branch=master) Orders API Client offers the merchants working with Pagantis a way to consume the API services without the effort of doing a complete development. The library provides stubs for each type of object withing the API and the method calls. Each Method supported by the API is implemented in this client and is documented within the code and [here](https://developer.pagantis.com/api/) All the code is tested and inspected by external services. How to use ---------- [](#how-to-use) Install the library by: - Downloading it from [here](https://github.com/pagantis/orders-api-client/releases/latest) - Using Composer: ``` composer require pagantis/orders-api-client ``` Finally, be sure to include the autoloader: ``` require_once '/path/to/your-project/vendor/autoload.php'; ``` Once the library is ready and inside the project the stub objects will available and the ordersApiClient will also available. ``` //Create a OrdersApiClient object, for example: $ordersApiClient = new OrdersApiClient($publicKey, $privateKey); //Example: get an existing Order status: $order = $ordersApiClient->getOrder($pagantisOrderId); //$pmOrderId is the id of the order if ($order instanceof Pagantis\OrdersApiClient\Model\Order) { $orderStatus = $order->getStatus(); echo $orderStatus; } // You can investigate the rest of the methods. And find all the documentation of the API here: // https://developer.pagantis.com/api/ ``` Examples / DemoTool ------------------- [](#examples--demotool) Find [examples in PHP](https://github.com/pagantis/orders-api-client/tree/master/examples) and a [demonstration tool](https://github.com/pagantis/orders-api-client/tree/master/examples) with the complete integration [here](https://github.com/pagantis/orders-api-client/tree/master/examples) Objects ------- [](#objects) The objects used inside the API are already defined as Classes with the desired properties. Each object has a setup of setters and getters for easy validation and OOP. Inside `src/Model` find defined the Order Object. Inside Order folder it is possible to see each element that the main Order object has. Use always the defined objects when using the API Client. For example when creating a refund: ``` @Exception Handling use Try|Catch when using the API methods, since it can cause HTTP exceptions. ``` API Methods ----------- [](#api-methods) ### Create Order [](#create-order) To create a order using the API Client start from a empty Order object, create the sub-objects and set the mandatory information. Then send the API Call to Pagantis using the API Client. The result is the same order object with the rest of the fields completed. The status is `CREATED`. Store the relation between Pagantis order id and the merchant order id to be able to identify orders after creation. ``` @Exception Handling use Try|Catch when using order Create method, since it can cause HTTP exceptions. When setting data into the order object there is Client Exceptions that may force to set the attributes in the correct format. ``` ### Get Order [](#get-order) Use the method Get Order to retrieve the order again from Pagantis server. The order retrieved has updated status. Store the relation between Pagantis order id and the merchant order id to be able to identify orders after creation. ``` @Exception Handling use Try|Catch when using get Order method, since it can cause HTTP exceptions. @Exception Handling use Try|Catch when using get Order method, since it can cause HTTP exceptions. @Exception Handling use Try|Catch when using get Order method, since it can cause HTTP exceptions. Remember that if a AUTHORIZED order is not confirmed, the payment will be released and the loan will not be created. It is mandatory to confirm all AUTHORIZED orders. ``` ### Refund Order [](#refund-order) Refund is a deduction of the order total\_amount. Refund can only be requested over a confirmed order. The refund of an order is automatically decreasing the amount from the end of the installments. A order can have several refunds, as long as they do not reach the order total\_amount. Once the total\_amount is refunded, the order status will keep to CONFIRMED. ``` @Exception Handling use Try|Catch when using get Order method, since it can cause HTTP exceptions. ``` Help us to improve ------------------ [](#help-us-to-improve) We are happy to accept suggestions or pull requests. If you are willing to help us develop better software please create a pull request here following the PSR-2 code style and we will use reviewable to check the code and if al test pass and no issues are detected by SensioLab Insights you could will be ready to merge. - [Issue Tracker](https://github.com/pagantis/orders-api-client/issues) ### Health Score 34 — LowBetter than 77% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity19 Limited adoption so far Community17 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 75.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~29 days Recently: every ~119 days Total 29 Last Release 2062d ago Major Versions v1.1.0 → v2.0.02019-03-13 v2.1.5 → v3.x-dev2020-09-16 ### Community Maintainers ![](https://www.gravatar.com/avatar/8c7c8679369f56fd689eb622494bb223ddca47be08cba78fe4036092fe0a3539?d=identicon)[romeritoCL](/maintainers/romeritoCL) --- Top Contributors [![romeritoCL](https://avatars.githubusercontent.com/u/301758?v=4)](https://github.com/romeritoCL "romeritoCL (124 commits)")[![PGarSol](https://avatars.githubusercontent.com/u/152878420?v=4)](https://github.com/PGarSol "PGarSol (30 commits)")[![rmarinleal](https://avatars.githubusercontent.com/u/1807196?v=4)](https://github.com/rmarinleal "rmarinleal (6 commits)")[![pgarcess](https://avatars.githubusercontent.com/u/37547687?v=4)](https://github.com/pgarcess "pgarcess (3 commits)")[![pagantis-integrations](https://avatars.githubusercontent.com/u/66306212?v=4)](https://github.com/pagantis-integrations "pagantis-integrations (1 commits)") --- Tags api-clientclientcomposerlibraryorders-apipagantisphp-libraryvendor ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/pagamastarde-orders-api-client/health.svg) ``` [![Health](https://phpackages.com/badges/pagamastarde-orders-api-client/health.svg)](https://phpackages.com/packages/pagamastarde-orders-api-client) ``` ### Alternatives [asana/asana A PHP client for the Asana API 1381.6M4](/packages/asana-asana)[balanced/balanced Client for Balanced API 72372.9k](/packages/balanced-balanced)[kontent-ai/delivery-sdk-php Kontent.ai Delivery SDK for PHP 4628.8k](/packages/kontent-ai-delivery-sdk-php)[maksekeskus/maksekeskus-php Maksekeskus PHP SDK 12179.8k](/packages/maksekeskus-maksekeskus-php)[nlpcloud/nlpcloud-client NLP Cloud serves high performance pre-trained or custom models for NER, sentiment-analysis, classification, summarization, paraphrasing, grammar and spelling correction, keywords and keyphrases extraction, chatbot, product description and ad generation, intent classification, text generation, image generation, code generation, question answering, automatic speech recognition, machine translation, language detection, semantic search, semantic similarity, tokenization, POS tagging, speech synthesis, embeddings, and dependency parsing. It is ready for production, served through a REST API. This is the PHP client for the API. More details here: https://nlpcloud.com. Documentation: https://docs.nlpcloud.com. Github: https://github.com/nlpcloud/nlpcloud-php 2523.9k](/packages/nlpcloud-nlpcloud-client)[slakbal/gotowebinar GotoWebinar API wrapper for laravel 5+ 1713.1k](/packages/slakbal-gotowebinar) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)