README

Magpie API for QRPh and Disbursement services

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, run:

composer require domdanao/magpiepay-sdk-php

Manual Installation

Download the files and include autoload.php:

### Laravel Integration

This package includes a Laravel Service Provider for easy integration.

#### Configuration

1.  Add your MagpiePay API key to your `.env` file:

    ```env
    MAGPIEPAY_API_KEY=your_api_key_here
    ```

2.  (Optional) Publish the configuration file:

    ```bash
    php artisan vendor:publish --provider="MagpiePay\Laravel\MagpiePayServiceProvider"
    ```

#### Usage

You can inject the API clients directly into your controllers or services. The Service Provider will automatically configure them with your API key.

```php
use MagpiePay\Api\PaymentsApi;

public function index(PaymentsApi $api)
{
    try {
        $payments = $api->listPayments();
        return response()->json($payments);
    } catch (\Exception $e) {
        return response()->json(['error' => $e->getMessage()], 500);
    }
}

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: basicAuth
$config = MagpiePay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// The SDK uses https://api.magpiepay.com as the base URL


$apiInstance = new MagpiePay\Api\PaymentsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$payment_id = 'payment_id_example'; // string
$x_api_key = 'x_api_key_example'; // string
$authorization = 'authorization_example'; // string

try {
    $result = $apiInstance->getPayment($payment_id, $x_api_key, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsApi->getPayment: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.magpiepay.com

Models

• ApiError
• BankCodeCollection
• BankCodeEntry
• CancelQRPhRequest
• CanonicalCreateQRReq
• HTTPValidationError
• PaymentCollectionResponse
• PaymentResponse
• PaymentSingleResponse
• PayoutCollectionResponse
• PayoutCreateRequest
• PayoutDestination
• PayoutDestinationResponse
• PayoutResponse
• PayoutSingleResponse
• QRPhCollectionResponse
• QRPhResponse
• QRPhSingleResponse
• ValidationError
• ValidationErrorLocInner

Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
  • Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen