hraph/paygreen-api-php

PHP SQK for Paygreen.io payment provider

1.1.1 2021-11-12 15:44 UTC

This package is auto-updated.

Last update: 2024-04-12 21:21:26 UTC


README

PHP SDK for Paygreen.io payment provider generated using OpenAPI Generator

Specifications for Paygreen.io API are available here

Requirements

PHP 7.1 and later

Installation & Usage

Composer

To install via Composer:

Run composer require hraph/paygreen-api-php

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/paygreen-api-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



$apiInstance = new Hraph\PaygreenApi\Api\AuthentificationOAuthApi(
    // 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()
);
$client_id = 'client_id_example'; // string | Variable OAuth contenant `accessPublic`. Exemple&nbsp;: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
$grant_type = 'grant_type_example'; // string | Variable OAuth contenant la valeur du \"grant type\" OAuth (valeur: authorization_code)
$code = 'code_example'; // string | Variable OAuth contenant le code generate après l'appel authorize OAuth

try {
    $result = $apiInstance->apiAuthAccessTokenPost($client_id, $grant_type, $code);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthentificationOAuthApi->apiAuthAccessTokenPost: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://paygreen.fr

Class Method HTTP request Description
AuthentificationOAuthApi apiAuthAccessTokenPost POST /api/auth/accessToken Contrôle OAuth
AuthentificationOAuthApi apiAuthAuthorizeGet GET /api/auth/authorize Affichage de la page d'authentification PayGreen
AuthentificationOAuthApi apiAuthPost POST /api/auth/ Création d'un token d'accès au protocole OAuth
GestionDeLaBoutiqueApi apiIdentifiantShopGet GET /api/{identifiant}/shop Afficher la boutique
GestionDeLaBoutiqueApi apiIdentifiantShopPatch PATCH /api/{identifiant}/shop Création et activation d'un compte
GestionDeLaBoutiqueApi apiIdentifiantShopPost POST /api/{identifiant}/shop Multi-boutiques : création d'une boutique
GestionDeLaBoutiqueApi apiIdentifiantShopPut PUT /api/{identifiant}/shop Mettre à jour la boutique
GestionDeLaBoutiqueApi apiIdentifiantShopShopIdGet GET /api/{identifiant}/shop/{shopId} Multi-boutiques : afficher une boutique
GestionDeLaBoutiqueApi apiIdentifiantShopShopIdPut PUT /api/{identifiant}/shop/{shopId} Multi-boutiques : mettre à jour une boutique
GestionDeLadresseApi apiIdentifiantAddressGet GET /api/{identifiant}/address Liste des adresses
GestionDeLadresseApi apiIdentifiantAddressPost POST /api/{identifiant}/address Créer une adresse
GestionDeMesBoutiquesApi apiIdentifiantShopsGet GET /api/{identifiant}/shops Liste des boutiques
GestionDeMesRIBApi apiIdentifiantBankGet GET /api/{identifiant}/bank Afficher mon RIB
GestionDeMesRIBApi apiIdentifiantBankPost POST /api/{identifiant}/bank Création d'un RIB
GestionDesDocumentsKYCsApi apiIdentifiantDocumentsGet GET /api/{identifiant}/documents Liste des documents
GestionDesDocumentsKYCsApi apiIdentifiantDocumentsIdDelete DELETE /api/{identifiant}/documents/{id} Supprimer un document
GestionDesDocumentsKYCsApi apiIdentifiantDocumentsIdGet GET /api/{identifiant}/documents/{id} Obtenir un document
GestionDesDocumentsKYCsApi apiIdentifiantDocumentsPost POST /api/{identifiant}/documents Envoyer des documents
GestionDesPropritairesApi apiIdentifiantShareholderGet GET /api/{identifiant}/shareholder Liste des propriétaires
GestionDesPropritairesApi apiIdentifiantShareholderPost POST /api/{identifiant}/shareholder Créer un propriétaire
GestionDuComptePrincipalApi apiIdentifiantAccountGet GET /api/{identifiant}/account Afficher le compte principal
GestionDuComptePrincipalApi apiIdentifiantAccountPut PUT /api/{identifiant}/account Met à jour le compte principal
GestionDuneAssociationApi apiIdentifiantSolidarityGet GET /api/{identifiant}/solidarity Liste des associations
LempreinteDeCarteApi apiIdentifiantPayinsCardprintGet GET /api/{identifiant}/payins/cardprint Liste des empreintes de carte
LempreinteDeCarteApi apiIdentifiantPayinsCardprintIdDelete DELETE /api/{identifiant}/payins/cardprint/{id} Supprimer une empreinte
LempreinteDeCarteApi apiIdentifiantPayinsCardprintIdGet GET /api/{identifiant}/payins/cardprint/{id} Détails
LempreinteDeCarteApi apiIdentifiantPayinsCardprintPost POST /api/{identifiant}/payins/cardprint Création d'une empreinte de carte
LesDonsApi apiIdentifiantSolidarityIdDelete DELETE /api/{identifiant}/solidarity/{id} Supprimer un don
LesDonsApi apiIdentifiantSolidarityIdGet GET /api/{identifiant}/solidarity/{id} Afficher un don
LesDonsApi apiIdentifiantSolidarityIdPatch PATCH /api/{identifiant}/solidarity/{id} Créer un don
LesMoyensDePaiementApi apiIdentifiantPaymenttypeGet GET /api/{identifiant}/paymenttype Liste des moyens de paiement
LesTransactionsApi apiIdentifiantPayinsTransactionCancelPost POST /api/{identifiant}/payins/transaction/cancel Annulation
LesTransactionsApi apiIdentifiantPayinsTransactionCashPost POST /api/{identifiant}/payins/transaction/cash Paiement comptant
LesTransactionsApi apiIdentifiantPayinsTransactionIdDelete DELETE /api/{identifiant}/payins/transaction/{id} Remboursement
LesTransactionsApi apiIdentifiantPayinsTransactionIdGet GET /api/{identifiant}/payins/transaction/{id} Détails
LesTransactionsApi apiIdentifiantPayinsTransactionIdPatch PATCH /api/{identifiant}/payins/transaction/{id} Modification du montant
LesTransactionsApi apiIdentifiantPayinsTransactionIdPut PUT /api/{identifiant}/payins/transaction/{id} Confirmer une transaction
LesTransactionsApi apiIdentifiantPayinsTransactionSubscriptionPost POST /api/{identifiant}/payins/transaction/subscription Paiement abonnement
LesTransactionsApi apiIdentifiantPayinsTransactionTokenizePost POST /api/{identifiant}/payins/transaction/tokenize Paiement avec confirmation
LesTransactionsApi apiIdentifiantPayinsTransactionXtimePost POST /api/{identifiant}/payins/transaction/xtime Paiement en plusieurs fois
LesVirementsApi apiIdentifiantPayoutTransferGet GET /api/{identifiant}/payout/transfer Liste des virements
LesVirementsApi apiIdentifiantPayoutTransferIdGet GET /api/{identifiant}/payout/transfer/{id} Détails
LesVirementsApi apiIdentifiantPayoutTransferPost POST /api/{identifiant}/payout/transfer Créer un virement
PaiementMultidestinataireApi apiIdentifiantPayinsMultiCashPost POST /api/{identifiant}/payins/multi/cash Créer un paiement multidestinataires
RechercheApi apiIdentifiantPayinsSearchGet GET /api/{identifiant}/payins/search Liste des transactions
RechercheApi apiIdentifiantPayinsSearchIdGet GET /api/{identifiant}/payins/search/{id} Plus d'informations

Documentation For Models