PHPackages peggyforms/php-sdk - 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. peggyforms/php-sdk ActiveLibrary[API Development](/categories/api) peggyforms/php-sdk ================== PeggyPay PHP SDK 1.2.0(9mo ago)072proprietaryPHPPHP >=7.0.0CI failing Since Oct 2Pushed 9mo ago1 watchersCompare [ Source](https://github.com/peggyforms/php-sdk)[ Packagist](https://packagist.org/packages/peggyforms/php-sdk)[ RSS](/packages/peggyforms-php-sdk/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (7)Dependencies (2)Versions (10)Used By (0) [![](https://camo.githubusercontent.com/715727c8fefa53e0a24db727858016691d39e0c95bbe42e9405c288152729213/68747470733a2f2f7777772e7065676779666f726d732e636f6d2f6170702f696d616765732f7068702d73646b2e706e673f37)](https://camo.githubusercontent.com/715727c8fefa53e0a24db727858016691d39e0c95bbe42e9405c288152729213/68747470733a2f2f7777772e7065676779666f726d732e636f6d2f6170702f696d616765732f7068702d73646b2e706e673f37) Peggy Pay PHP SDK ================= [](#peggy-pay-php-sdk) Use this SDK for easy communication with Peggy Pay. Install ------- [](#install) `composer require peggyforms/php-sdk dev-master` Current version: 1.2.0 Basic Usage ----------- [](#basic-usage) Init ---- [](#init) You have to start always by initialize the PeggyPay object with your API key. You can find your API key [in your account](https://www.peggyforms.com/account/api-keys) ``` require "vendor/autoload.php"; $peggyPay = new PeggyForms\Api("myApiKey"); ``` Get submission by hash ---------------------- [](#get-submission-by-hash) Get a submission by its Hash code. Every redirect of Peggy Pay sends the submission hash in the parametere: peggyHash ``` // Get the HTTP request param $hash = $peggyPay->get->param("peggyHash"); // And get the submission $submission = $peggyPay->submissions->get($hash); ``` Get field submitted value: ``` $submission->get("fieldName"); ``` This is the way to get the payment status of an order: ``` $submission->PaymentStatus; // complete/init/error $submission->PaymentAmount; ``` Get order by hash ----------------- [](#get-order-by-hash) Get an order with orderlines by submissionhash or orderhash. ``` // Get the HTTP request param $hash = $peggyPay->get->param("peggyHash"); // And get the order $order = $peggyPay->orders->getBySubmissionHash($hash); ``` The response: ``` PeggyForms\Classes\Order Object ( [PaymentType] => onetime ... [Amount] => 2198 [AmountEx] => 1817 [AmountVat] => 381 [VatAmount] => 21 [IsIncVat] => 1 [IsVatShifted] => 0 [Description] => SDK get order ... [OrderLines] => Array ( [0] => PeggyForms\Classes\OrderLine Object ( [Description] => Clone bug [Quantity] => 1 [Amount] => 1999 [AmountEx] => 1652.07 [AmountTax] => 346.93 [Tax] => 21 [IdTax] => 2 [IsTaxFree] => 0 ) ... ) ) ``` This can be used to connect your Peggy Pay to your accounting software. Use [Webhooks](https://www.peggypay.com/kennisbank/apps/webhooks/introductie) for this. Always return the proper respone to webhooks: ``` $peggyPay->response->webhook(true); ``` ADVANCED usage - Dynamic content -------------------------------- [](#advanced-usage---dynamic-content) For plans with AJAX / HTTP features you can: - populate choicefields, lists, ajax proxy and datagrids. - create custom field validation - respond to the POST submit action ### Choicefields [](#choicefields) ``` $peggyPay->response->choiceField( true, // Call succeded? [ new \PeggyForms\Classes\ListItem(1, "My dynamic option 1"), new \PeggyForms\Classes\ListItem(2, "My dynamic option 2") ] ); ``` ### Validation [](#validation) You can validate your form fields using the default validation tools in the editor. When you need custom valdation, you can use [Javascript](https://www.peggypay.com/kennisbank/overig/js-api/introductie). Or you can setup to validate via an HTTP request. This example is for validating a field via an HTTP request. [Read more](https://www.peggypay.com/kennisbank/overig/js-api/introductie) ``` // Value of the field with the validation $value = $peggyPay->get->param("value"); // Other fields you added as parameters $yourFormField1 = $peggyPay->get->param("formfield-1-name"); $yourFormField2 = $peggyPay->get->param("formfield-2-name"); $validated = your_function($value, $yourFormField1, $yourFormField2); if ($validated === true) { $status = \PeggyForms\Constants\Validation::OK; } elseif ($validated === false) { $status = \PeggyForms\Constants\Validation::NOK; } else { $status = \PeggyForms\Constants\Validation::INIT; } $peggyPay->response->validation( true, // Call succeded $status, "My nice custom response message", [ "prop" => 102 ] // Your custom props for usage in your rules or display as text in your form ); ``` ### Populate the Ajax Proxy field [](#populate-the-ajax-proxy-field) The Ajax Proxy field can be very useful if you have 1 web service which provides multiple data sets. For example, if your API call returns a list of products and a list of countries, the AJAX proxy field is very useful. Only 1 HTTP request will be made and all the dependent fields will use this result as data source. In this example we use typeless objects, but you can use any JSON-serializable object. ``` $peggyPay->response->ajaxProxy( true, [ "products" => [ (object)[ "id" => 1, "name" => "My product 1" ], .. ], "countries" => [ (object)[ "id" => 1, "name" => "The Netherlands" ], .. ] ] ); ``` Populate pricefields within ajax proxy: ``` $peggyPay->response->ajaxProxy( true, [ // See further this document for specifications for price and discount fields "discount" => [ new \PeggyForms\Classes\DiscountItem... ] ] ); ``` ### The POST submit action [](#the-post-submit-action) This example reacts on the POST submit action. The hash of the submission will always be added as 'submissionHash'. Use your custom props in your thanks page or email body by writing `{POST:data.StatusMessage}` in the Peggy Pay editor, in example in the \[Form\] => \[Thanks\] body: [Read more](https://www.peggypay.com/kennisbank/apps/webhooks/introductie) ``` $submissionHash = $peggyPay->get->param("submissionHash"); $field1 = $peggyPay->get->param("field1"); // ... $statusMessage = your_function($field1); // This example function should return a string with a message $peggyPay->response->post( // Call succeded? true, // Message to show when call failed, $statusMessage, // Properties to pass back to your page, to use in your thanks page or email body using {POST:myprop} in this example [ "myprop" => 100 ], // Optional you can change the thankspage to an redirect $peggyPay->post->returnAction( \PeggForms\Modules\Post::ReturnActionRedirect, "https://www.google.nl" ), // And use some data in the CSV export [ $peggyPay->response->exportColumn("uniqueColumnKey", "Column label", $yourValueForExport ) ] ); ``` ### Populate the Price field [](#populate-the-price-field) Price fields are used to collect amounts in your form in a very flexible way. With dynamic data you also can collect amounts via your webservices via an HTTP request. Check this screenshot of the price field settings: ``` // Currency is always passed by Peggy Pay, USD / EUR supported by now $currency = $peggyPay->get->param("currency", "EUR"); // Optioanlly get some params from Peggy Pay $amount = (int)$peggyPay->get->param("amount", 1); // Calculate the amount with your own functions $price = my_function($amount); // Price should be an integer representing cents $price2 = my_function_2($amount); // Price should be an integer representing cents $peggyPay->response->priceField( true, [ new \PeggyForms\Classes\PriceItem("My dynamic item", $price, $amount, $currency, "Id"), new \PeggyForms\Classes\PriceItem("Administration costs", $price2, 1, $currency, "AdminCosts") ] ); ``` It is highly recommended to fill the Id parameter if possible. To populate a Discount field, use: ``` $peggyPay->response->priceField( true, [ new \PeggyForms\Classes\DiscountItem("My dynamic item", $price, $amount, $currency), ] ); ``` ### Health Score 36 — LowBetter than 82% of packages Maintenance57 Moderate activity, may be stable Popularity10 Limited adoption so far Community4 Small or concentrated contributor base Maturity59 Maturing project, gaining track record 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 ~266 days Recently: every ~427 days Total 9 Last Release 285d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b7c138e8005586b328c497aa2ea1a8d0e4a32595e5b849b08398b81ae9b221b6?d=identicon)[peggyforms](/maintainers/peggyforms) ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/peggyforms-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/peggyforms-php-sdk/health.svg)](https://phpackages.com/packages/peggyforms-php-sdk) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)