gmopg

Installation

 composer require sanmai/ gmopg

Configuration

Il existe deux manières de configurer l'API :

1. Avec des constantes globales. A savoir, vous devez avoir défini :

     // ショップ情報
   define ( ' GMO_SHOP_ID ' , ' tshop0000001 ' ); // ショップＩＤ
   define ( ' GMO_SHOP_PASSWORD ' , ' qwerty ' ); // ショップ名
   define ( ' GMO_SHOP_NAME ' , ' My Shop ' ); // ショップパスワード
   define ( ' GMO_TRIAL_MODE ' , false );

   Vous pouvez obtenir les trois premiers depuis le panneau de gestion ou depuis les e-mails de GMO PG.

   La dernière constante GMO_TRIAL_MODE doit être définie sur true si vous utilisez un mot de passe de boutique de test.

2. En appelant ces méthodes statiques :

    GMO  API Defaults:: setShopID ( $ shopId );
    GMO  API Defaults:: setShopName ( $ shopName );
    GMO  API Defaults:: setPassword ( $ shopPassword );
   
   // When using a test password, this constant is mandatory
   //define('GMO_TRIAL_MODE', true); 

Tester les paiements

Actuellement, il n'existe pas d'autre moyen d'activer un mode test qu'en définissant une constante GMO_TRIAL_MODE définie sur true .

 define ( ' GMO_TRIAL_MODE ' , true );

Pour tester les paiements avec des numéros de carte saisis directement avec les informations d'identification de l'environnement de test, vous devez activer ces paiements comme indiqué dans la documentation.

Utilisation de base

 // A wrapper object that does everything for you.
$ payment = new  GMO  ImmediatePayment ();
 // Unique ID for every payment; probably should be taken from an auto-increment field from the database.
$ payment -> paymentId = 123 ;
$ payment -> amount = 1000 ;
// This card number can be used for tests.
$ payment -> cardNumber = ' 4111111111111111 ' ;
// A date in the future.
$ payment -> cardYear = ' 2020 ' ;
$ payment -> cardMonth = ' 7 ' ;
$ payment -> cardCode = ' 123 ' ;

// Returns false on an error.
if (! $ payment -> execute ()) {
	$ errors = $ payment -> getErrors ();
	foreach ( $ errors as $ errorCode => $ errorDescription ) {
        // Show an error code and a description to the customer? Your choice.
        // Probably you want to log the error too.
	}
	return ;
}

// Success!
$ response = $ payment -> getResponse ();
/** @var GMOAPIResponseExecTranResponse $response */
// You would probably want to save the response in the database for future reference.
// The response can be used to query details about a transaction, make refunds and so on.

Le tableau de $errors se présente sous une forme similaire à celle-ci :

 array(1) {
  'E01040010' =>
  string(34) "This order ID was used previously."
}

Une liste des codes d'erreur les plus connus. Sous une forme lisible. Et un autre.

Une $response typique ressemblera à ceci :

 class GMOAPIResponseExecTranResponse#1 (9) {
  public $ACS =>
  string(1) "0"
  public $OrderID =>
  string(10) "1517000000"
  public $Forward =>
  string(7) "0afd1200"
  public $Method =>
  string(1) "1"
  public $PayTimes =>
  string(0) ""
  public $Approve =>
  string(7) "0112234"
  public $TranID =>
  string(28) "180111111111111111111344439"
  public $TranDate =>
  string(14) "20221222213141"
  public $CheckString =>
  string(32) "68b329da9893e34099c7d8ad5cb9c940"
}

Payer avec un jeton

Un objet de paiement peut accepter un jeton reçu de l'API JavaScript au lieu des détails de la carte de crédit :

 $ payment = new  GMO  ImmediatePayment ();
$ payment -> paymentId = 123 ; // Unique ID for every payment; see above
$ payment -> amount = 1000 ;
// Card details are unnecessary in this case
$ payment -> token = $ _POST [ ' token ' ];

if (! $ payment -> execute ()) {
    // ... same as above
}

// ... same as above

Il faut utiliser le mode de paiement ci-dessus s’il obtient la vénérable erreur E61040001.

Détails de la transaction

Maintenant, vous souhaitez naturellement charger les détails de la transaction pour le paiement en cours.

 $ searchTrade = new  GMO  API  Call  SearchTrade ();
$ searchTrade -> OrderID = $ payment -> getResponse ()-> OrderID ;
// Copy credential from the original payment
$ payment -> setupOther ( $ searchTrade );

$ response = $ searchTrade -> dispatch ();

Dans cette $response vous trouverez ces champs :

 class GMOAPIResponseSearchTradeResponse#4950 (21) {
  public $AccessID =>
  string(32) "b026324c6904b2a9cb4b88d6d61c81d1"
  public $AccessPass =>
  string(32) "26ab0db90d72e28ad0ba1e22ee510510"
  public $OrderID =>
  string(10) "1517000000"
  public $Status =>
  string(5) "SALES"
  public $ProcessDate =>
  string(14) "20221222213141"
  public $JobCd =>
  string(5) "SALES"
  public $ItemCode =>
  string(7) "0000000"
  public $Amount =>
  string(4) "4999"
  public $Tax =>
  string(1) "0"
  public $SiteID =>
  string(0) ""
  public $MemberID =>
  string(0) ""
  public $CardNo =>
  string(16) "************1111"
  public $Expire =>
  string(4) "2307"
  public $Method =>
  string(1) "1"
  public $PayTimes =>
  string(0) ""
  public $Forward =>
  string(7) "0afd1200"
  public $TranID =>
  string(28) "180111111111111111111344439"
  public $Approve =>
  string(7) "0112234"
  public $ClientField1 =>
  string(0) ""
  public $ClientField2 =>
  string(0) ""
  public $ClientField3 =>
  string(0) ""
}

Documentation supplémentaire sur l'API

GMO-PG est très secret, apparemment sans aucune raison (c'est tout le contraire de Stripe), et vous ne pouvez généralement accéder à leur documentation qu'après avoir signé un accord de non-divulgation.