Laravel Package for Pi Network API

Overview

This package integrates the Pi Network API into Laravel and provides two main services:

• LaraPiDbService: Manages all database operations for Pi payments using PaymentDTO objects, including creating, updating, deleting, and retrieving payment records along with their associated statuses and transactions.
• LaraPiPaymentService: Handles communication with the Pi Network API. It provides methods to create, approve, complete, cancel payments, and retrieve payment details.

LaraPiDbService

LaraPiPaymentService

The LaraPiPaymentService is used to interact directly with the Pi Network API. Its main methods include:

• createPayment(float $amount, string $uid, string $memo = 'A2U Payment', array $metadata = []): PaymentDTO|null – Sends a payment creation request to the API. On success, it returns a PaymentDTO containing the payment details.
• getPayment(string $paymentId): PaymentDTO|null – Retrieves payment details from the API for the given payment ID.
• approvePayment(string $paymentId): PaymentDTO|null – Approves a pending payment by sending the appropriate request to the API.
• completePayment(string $paymentId, string $txid): PaymentDTO|null – Completes a payment by providing the transaction ID (txid) to the API.
• cancelPayment(string $paymentId): PaymentDTO|null – Cancels a pending payment through an API call.
• incompleteServerPayments(): object|null – Retrieves server-side payments that have not yet been completed, allowing further processing or error handling.

Example Usage

The following examples demonstrate how you can use these services within your Laravel application:

use Rgalstyan\Larapi\Facades\LaraPiPayment;

use Rgalstyan\Larapi\Facades\LaraPiDb;

Example 1: Creating a Payment

// Create a payment via the Pi Network API
$paymentDTO = LaraPiPayment::createPayment(10.50, 'user-unique-id', 'Payment for Order #1234', ['order_id' => 1234]);

if ($paymentDTO) {
    // Store the payment information in your database using PaymentDTO
    $payment = LaraPiDb::createPayment($paymentDTO);
    return response()->json(['success' => true, 'message' => "Payment created successfully with ID: " . $payment->id]);
} else {
    return response()->json(['success' => true, 'message' => "Payment creation failed."]);
}
    

Example 2: Updating a Payment

// Assume $paymentDTO contains updated payment details and $paymentId holds the existing payment ID
$paymentId = 123; // Example payment ID
$updatedPayment = LaraPiDb::updatePayment($paymentId, $paymentDTO);
return response()->json(['success' => true, 'message' => "Payment updated successfully."]);