https://github.com/aporat/store-receipt-validator
PHP receipt validator for Apple iTunes, Google Play and Amazon App Store
https://github.com/aporat/store-receipt-validator
amazon app-store apple in-app-purchases itunes php receipt receipt-validation validation
Last synced: about 8 hours ago
JSON representation
PHP receipt validator for Apple iTunes, Google Play and Amazon App Store
- Host: GitHub
- URL: https://github.com/aporat/store-receipt-validator
- Owner: aporat
- License: apache-2.0
- Created: 2013-12-04T15:57:08.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T18:11:31.000Z (7 days ago)
- Last Synced: 2025-04-27T07:37:58.568Z (3 days ago)
- Topics: amazon, app-store, apple, in-app-purchases, itunes, php, receipt, receipt-validation, validation
- Language: PHP
- Homepage:
- Size: 953 KB
- Stars: 640
- Watchers: 23
- Forks: 151
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# store-receipt-validator
[](https://packagist.org/packages/aporat/store-receipt-validator)
[](https://packagist.org/packages/aporat/store-receipt-validator)
[](https://codecov.io/github/aporat/store-receipt-validator)
[](LICENSE)
A modern PHP library for validating in-app purchase receipts from Apple iTunes, and Amazon App Store. Supports production and sandbox environments with detailed response parsing.
---
## 📦 Requirements
- PHP >= 8.3
## 📥 Installation
```bash
composer require aporat/store-receipt-validator
```
---
## 🚀 Quick Start
### 📲 Apple App Store Server API
```php
use ReceiptValidator\AppleAppStore\ReceiptUtility;
use ReceiptValidator\AppleAppStore\Validator as AppleValidator;
use ReceiptValidator\Environment;
// Credentials
$signingKey = file_get_contents($root . '/examples/SubscriptionKey_RA9DAYVX3X.p8');
$keyId = 'RA9DAYVX3X';
$issuerId = 'xxxxxx-xxxx-xxxx-xxxx-xxxxxxx';
$bundleId = 'com.myapp';
$receiptBase64Data = '...'; // your app receipt here
$transactionId = ReceiptUtility::extractTransactionIdFromAppReceipt($receiptBase64Data);
$validator = new AppleValidator(
signingKey: $signingKey,
keyId: $keyId,
issuerId: $issuerId,
bundleId: $bundleId,
environment: Environment::PRODUCTION
);
try {
$response = $validator->setTransactionId($transactionId)->validate();
} catch (Exception $e) {
echo 'Error validating transaction: ' . $e->getMessage() . PHP_EOL;
exit(1);
}
echo 'Validation successful.' . PHP_EOL;
echo 'Bundle ID: ' . $response->getBundleId() . PHP_EOL;
echo 'App Apple ID: ' . $response->getAppAppleId() . PHP_EOL;
foreach ($response->getTransactions() as $transaction) {
echo 'getProductId: ' . $transaction->getProductId() . PHP_EOL;
echo 'getTransactionId: ' . $transaction->getTransactionId() . PHP_EOL;
if ($transaction->getPurchaseDate() != null) {
echo 'getPurchaseDate: ' . $transaction->getPurchaseDate()->toIso8601String() . PHP_EOL;
}
}
```
### 🍏 Apple iTunes (Deprecated)
```php
use ReceiptValidator\Environment;
use ReceiptValidator\iTunes\Validator as iTunesValidator;
$validator = new iTunesValidator(Environment::PRODUCTION);
try {
$response = $validator->setSharedSecret('SHARED_SECRET')->setReceiptData('BASE64_RECEIPT')->validate();
} catch (Exception $e) {
echo 'got error = ' . $e->getMessage() . PHP_EOL;
echo $e->getTraceAsString() . PHP_EOL;
exit;
}
echo 'Receipt is valid.' . PHP_EOL;
echo 'getBundleId: ' . $response->getBundleId() . PHP_EOL;
foreach ($response->getPurchases() as $purchase) {
echo 'getProductId: ' . $purchase->getProductId() . PHP_EOL;
echo 'getTransactionId: ' . $purchase->getTransactionId() . PHP_EOL;
if ($purchase->getPurchaseDate() != null) {
echo 'getPurchaseDate: ' . $purchase->getPurchaseDate()->toIso8601String() . PHP_EOL;
}
}
```
---
### 🛒 Amazon App Store
```php
use ReceiptValidator\Amazon\Validator;
use ReceiptValidator\Amazon\Response;
$validator = new Validator();
try {
$response = $validator->setDeveloperSecret('SECRET')->setReceiptId('RECEIPT_ID')->setUserId('USER_ID')->validate();
} catch (Exception $e) {
echo 'got error = ' . $e->getMessage() . PHP_EOL;
echo $e->getTraceAsString() . PHP_EOL;
exit;
}
echo 'Receipt is valid.' . PHP_EOL;
foreach ($response->getPurchases() as $purchase) {
echo 'getProductId: ' . $purchase->getProductId() . PHP_EOL;
if ($purchase->getPurchaseDate() != null) {
echo 'getPurchaseDate: ' . $purchase->getPurchaseDate()->toIso8601String() . PHP_EOL;
}
}
```
### 📬 Apple App Store Server Notifications
#### 🔔 V2 Notifications (App Store Server API)
```php
use ReceiptValidator\AppleAppStore\ServerNotification;
use ReceiptValidator\Exceptions\ValidationException;
public function subscriptions(Request $request): JsonResponse {
try {
$notification = new ServerNotification($request->all());
echo 'Type: ' . $notification->getNotificationType()->value . PHP_EOL;
echo 'Subtype: ' . ($notification->getSubtype()?->value ?? 'N/A') . PHP_EOL;
echo 'Bundle: ' . $notification->getBundleId() . PHP_EOL;
$tx = $notification->getTransaction();
if ($tx !== null) {
echo 'Transaction ID: ' . $tx->getTransactionId() . PHP_EOL;
}
$renewalInfo = $notification->getRenewalInfo();
if ($renewalInfo !== null) {
echo 'Auto Renew Product: ' . $renewalInfo->getAutoRenewProductId() . PHP_EOL;
}
} catch (ValidationException $e) {
echo 'Invalid notification: ' . $e->getMessage();
}
}
```
#### 🔔 V1 Notifications (iTunes) (Deprecated)
```php
use ReceiptValidator\iTunes\ServerNotification;
use ReceiptValidator\Exceptions\ValidationException;
public function subscriptions(Request $request): JsonResponse {
$sharedSecret = 'your_shared_secret';
try {
$notification = new ServerNotification($request->all(), $sharedSecret);
echo 'Type: ' . $notification->getNotificationType()->value . PHP_EOL;
echo 'Bundle: ' . $notification->getBundleId() . PHP_EOL;
$latestReceipt = $notification->getLatestReceipt();
$transactions = $latestReceipt->getTransactions();
foreach ($transactions as $tx) {
echo 'Transaction ID: ' . $tx->getTransactionId() . PHP_EOL;
}
} catch (ValidationException $e) {
echo 'Invalid notification: ' . $e->getMessage();
}
}
```
---
## 🧪 Testing
```bash
composer test
composer check # Run code style checks (PHP_CodeSniffer)
composer analyze # Run static analysis (PHPStan)
```
---
## 🙌 Contributing
Contributions are welcome! Feel free to:
- Fork this repo
- Create a feature branch
- Submit a pull request
Found a bug or want a new feature? [Open an issue](https://github.com/aporat/store-receipt-validator/issues)