gmopg

Instalação

 composer require sanmai/ gmopg

Configuração

Existem duas maneiras de configurar a API:

1. Com constantes globais. Ou seja, você precisa ter definido:

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

   Onde os três primeiros você pode obter no painel de gerenciamento ou nos e-mails do GMO PG.

   A última constante GMO_TRIAL_MODE deve ser definida como true se você estiver usando uma senha de loja de teste.

2. Chamando estes métodos estáticos:

    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); 

Testando pagamentos

Atualmente não há outra maneira de ativar um modo de teste a não ser definindo uma constante GMO_TRIAL_MODE definida como true .

 define ( ' GMO_TRIAL_MODE ' , true );

Testar pagamentos com números de cartão inseridos diretamente com credenciais de ambiente de teste exige que você habilite esses pagamentos conforme descrito na documentação.

Uso básico

 // 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.

A matriz de $errors vem em um formato semelhante a este:

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

Uma lista dos códigos de erro mais conhecidos. De forma legível. E outro.

Uma $response típica será assim:

 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"
}

Pagando com um token

Um objeto de pagamento pode aceitar um token recebido da API JavaScript em vez de detalhes de cartão de crédito:

 $ 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

Deve-se usar o método de pagamento acima se estiver recebendo o venerável erro E61040001.

Detalhes da transação

Agora você naturalmente deseja carregar os detalhes da transação do pagamento atual.

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

$ response = $ searchTrade -> dispatch ();

Nesta $response você encontraria estes campos:

 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) ""
}

Documentação adicional da API

O GMO-PG é muito secreto, aparentemente sem motivo algum (isso é completamente o oposto do Stripe), e normalmente você só pode acessar a documentação deles após assinar um acordo de confidencialidade.