Merge pull request #11 from iamport/fix/add_parameter_support_cancel_payment

Fix/add parameter support cancel payment

Author: khj309

example/payment/cancel.php

@@ -2,15 +2,18 @@
 
 require_once '../../vendor/autoload.php';
 
+use Iamport\RestClient\Enum\Naver\CancelPaymentRequester;
 use Iamport\RestClient\Iamport;
 use Iamport\RestClient\Request\CancelPayment;
+use Iamport\RestClient\Request\CancelPaymentExtra;
 
 $iamport = new Iamport('imp_apikey', 'ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f');
 
 // 클라이언트로부터 전달받은 주문번호, 환불사유, 환불금액
 $merchant_uid        = filter_input(INPUT_POST, 'merchant_uid', FILTER_SANITIZE_STRING);
 $reason              = filter_input(INPUT_POST, 'reason', FILTER_SANITIZE_STRING);
 $cancelRequestAmount = filter_input(INPUT_POST, 'cancel_request_amount', FILTER_SANITIZE_STRING);
+$extra_requester     = filter_input(INPUT_POST, 'extra_requester', FILTER_SANITIZE_STRING);
 
 // TODO : 아래 가맹점 DB 접근 코드는 예시를 돕고자 작성된 샘플코드로 실제 가맹점의 환경에 맞게 직접 작성하셔야 됩니다.
 // 가맹점 DB에서 환불할 결제 정보 조회
@@ -39,6 +42,16 @@
 $request->refund_holder  = '환불될 가상계좌 예금주';
 $request->refund_bank    = '환불될 가상계좌 은행코드';
 $request->refund_account = '환불될 가상계좌 번호';
+
+$extra = new CancelPaymentExtra();
+// 취소 요청자, API를 호출하는 출처 (optional)
+if ($extra_requester === 'admin') {
+    $extra->requester = CancelPaymentRequester::ADMIN;
+} else if ($extra_requester === 'customer'){
+    $extra->requester = CancelPaymentRequester::CUSTOMER;
+}
+
+$request->extra          = $extra;
 $result                  = $iamport->callApi($request);
 
 if ($result->isSuccess()) {

src/Enum/Naver/CancelPaymentRequester.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Iamport\RestClient\Enum\Naver;
+
+use Iamport\RestClient\Enum\Enum;
+
+/**
+ * Class CancelPaymentRequester.
+ */
+class CancelPaymentRequester extends Enum
+{
+    public const CUSTOMER = 'customer';
+    public const ADMIN    = 'admin';
+
+
+    /**
+     * Enum의 설명을 가져옵니다.
+     *
+     * @param string $value
+     */
+    public static function getDescription($value): ?string
+    {
+        switch ($value) {
+            case self::CUSTOMER:
+                return '구매자';
+            case self::ADMIN:
+                return '가맹점 관리자';
+            default:
+                return null;
+        }
+    }
+}

src/Request/CancelPayment.php

@@ -17,6 +17,8 @@
  * @property string $refund_holder
  * @property string $refund_bank
  * @property string $refund_account
+ * @property string $refund_tel
+ * @property CancelPaymentExtra $extra
  */
 class CancelPayment extends RequestBase
 {
@@ -67,6 +69,16 @@ class CancelPayment extends RequestBase
      */
     protected $refund_account;
 
+    /**
+     * @var string 환불계좌 예금주 연락처(가상계좌취소,스마트로 PG사 인경우 필수 )
+     */
+    protected $refund_tel;
+
+    /**
+     * @var CancelPaymentExtra
+     */
+    protected $extra;
+
     /**
      * CancelPayment constructor.
      */
@@ -146,6 +158,16 @@ public function setRefundAccount(string $refund_account): void
         $this->refund_account = $refund_account;
     }
 
+    public function setRefundTel(string $refund_tel): void
+    {
+        $this->refund_tel = $refund_tel;
+    }
+
+    public function setExtra(CancelPaymentExtra $extra): void
+    {
+        $this->extra = $extra;
+    }
+
     /**
      * 주문취소.
      * [POST] /payments/cancel.
@@ -157,13 +179,19 @@ public function path(): string
 
     public function attributes(): array
     {
+        $result = $this->toArray();
+
+        if ($this->extra instanceof CancelPaymentExtra) {
+            $result['extra'] = $this->extra->toArray();
+        }
+
         return [
-            'body' => json_encode($this->toArray()),
+            'body' => json_encode($result),
         ];
     }
 
     public function verb(): string
     {
         return 'POST';
     }
-}
+}

src/Request/CancelPaymentExtra.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Iamport\RestClient\Request;
+
+use Iamport\RestClient\Request\RequestTrait;
+
+/**
+ * Class CancelPaymentExtra
+ *
+ * @property string $requester
+ */
+class CancelPaymentExtra
+{
+    use RequestTrait;
+
+    /**
+     * @var string API를 호출하는 출처 [ customer, admin ]
+     */
+    protected $requester;
+
+    /**
+     * CustomerExtra constructor.
+     */
+    public function __construct()
+    {
+    }
+
+    public function setRequester(string $requester): void
+    {
+        $this->requester = $requester;
+    }
+}

tests/PaymentTest.php

@@ -1,6 +1,8 @@
 <?php
 
+use Iamport\RestClient\Enum\Naver\CancelPaymentRequester;
 use Iamport\RestClient\Request\CancelPayment;
+use Iamport\RestClient\Request\CancelPaymentExtra;
 use Iamport\RestClient\Request\Payment;
 use Iamport\RestClient\Test\IamportTestTrait;
 use PHPUnit\Framework\TestCase;
@@ -81,6 +83,10 @@ public function payment_cancel_by_imp_uid()
         $cancelPayment->refund_holder  = '환불될 가상계좌 예금주';
         $cancelPayment->refund_bank    = '환불될 가상계좌 은행코드';
         $cancelPayment->refund_account = '환불될 가상계좌 번호';
+        $cancelPayment->refund_tel     = "01012341234";
+        $extra                         = new CancelPaymentExtra();
+        $extra->requester              = CancelPaymentRequester::ADMIN;
+        $cancelPayment->setExtra($extra);
 
         $this->assertSame($cancelPayment->imp_uid, self::$impUid);
         $this->assertEquals('/payments/cancel/', $cancelPayment->path());
@@ -103,6 +109,10 @@ public function payment_cancel_by_merchant_uid()
         $cancelPayment->refund_holder  = '환불될 가상계좌 예금주';
         $cancelPayment->refund_bank    = '환불될 가상계좌 은행코드';
         $cancelPayment->refund_account = '환불될 가상계좌 번호';
+        $cancelPayment->refund_tel     = "01012341234";
+        $extra                         = new CancelPaymentExtra();
+        $extra->requester              = CancelPaymentRequester::ADMIN;
+        $cancelPayment->setExtra($extra);
 
         $this->assertSame($cancelPayment->merchant_uid, self::$merchantUid);
         $this->assertEquals('/payments/cancel/', $cancelPayment->path());