• プラグイン一覧
    - WCEX Item Combo Set
    - WCEX Amazon Pay
    - WCEX Wishlist お気に入りリスト
  • リリース情報
  • お役立ちコラム
  • お問い合わせ
  • サポート
    • よくある質問
      • WCEX Amazon Pay
      • WCEX Wishlist お気に入りリスト
      • wcex-item-combo-set
    • リファレンス
      • WCEX Amazon Pay
      • WCEX Wishlist お気に入りリスト
      • wcex-item-combo-set
新規会員登録
ログイン
新規会員登録
ログイン
カート
  • プラグイン一覧
    • - WCEX Item Combo Set
    • - WCEX Amazon Pay
    • - WCEX Wishlist お気に入りリスト
  • リリース情報
  • お役立ちコラム
  • サポート
    • - よくある質問
      • - WCEX Amazon Pay
      • - WCEX Wishlist お気に入りリスト
      • - wcex-item-combo-set
    • - リファレンス
      • - WCEX Amazon Pay
      • - WCEX Wishlist お気に入りリスト
      • - wcex-item-combo-set
  • お問い合わせ
Aivec APPs > WCEX Amazon Pay > クラス > Cancel
レファレンス
バージョン
2.6.4
絞り込み:

目次

  • ソース
  • 関数

フック

  • アクション
  • フィルター

ファンクション

    クラス

    Cancel

    Amazon Pay V2 SDK Cancel Charge.

    ソース #ソース

    ファイル: src/API/Charge/Cancel.php

    class Cancel extends ErrorStore
    {
    
        const INVALID_CHARGE_PERMISSION_STATUS = 'InvalidChargePermissionStatus';
        const INVALID_CHARGE_STATUS = 'InvalidChargeStatus';
    
        /**
         * AmazonPay module object
         *
         * @var AmazonPay
         */
        private $module;
    
        /**
         * Amazon Pay order object
         *
         * @var OrderMeta
         */
        private $order;
    
        /**
         * Sets `$module` member var with dependency injection.
         *
         * @author Evan D Shaw <evandanielshaw@gmail.com>
         * @param AmazonPay $module
         * @param OrderMeta $order
         * @return void
         */
        public function __construct(AmazonPay $module, OrderMeta $order) {
            $this->module = $module;
            $this->order = $order;
            parent::__construct();
            $this->populate();
        }
    
        /**
         * Cancels a Charge
         *
         * @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#capture-charge
         * @author Evan D Shaw <evandanielshaw@gmail.com>
         * @param string $chargeId Charge ID
         * @param string $reason
         * @return array
         * @throws InvalidArgumentException Thrown by `getAmazonClient`.
         */
        public function delete($chargeId, $reason) {
            $payload = ['cancellationReason' => $reason];
            try {
                $client = $this->module->getAmazonClient();
                $result = $client->cancelCharge($chargeId, $payload);
                if ($this->module->errors->hasError($result)) {
                    $error = $this->module->errors->getAmzErrorResponse($result, $this);
                    (new Logger())->logApiResponse(new Log(
                        $this->order->getChargePermissionId(),
                        Log::ACTION_CANCEL_TRANS,
                        $error->errorcode,
                        null,
                        $error
                    ));
                    return $error;
                }
            } catch (\Exception $e) {
                return $this->module->errors->getErrorResponse(
                    GenericErrorStore::AMAZON_PAY_SDK_CLIENT_EXCEPTION,
                    [$e->getMessage()]
                );
            }
    
            $response = json_decode($result['response'], true);
            $details = $response['statusDetails'];
            $this->order->updateChargeState(
                new State(
                    $details['state'],
                    $details['reasonCode'],
                    $details['reasonDescription']
                )
            );
    
            (new Logger())->logApiResponse(new Log(
                $this->order->getChargePermissionId(),
                Log::ACTION_CANCEL_TRANS,
                Log::RESPONSE_OK
            ));
            return $result;
        }
    
        /**
         * Populates error store
         *
         * @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#error-codes-2
         * @author Evan D Shaw <evandanielshaw@gmail.com>
         * @return void
         * @throws InvalidArgumentException Thrown if duplicate errorcodes exist.
         */
        public function populate() {
            $this->addError(new GenericError(
                self::INVALID_CHARGE_PERMISSION_STATUS,
                $this->getConstantNameByValue(self::INVALID_CHARGE_PERMISSION_STATUS),
                422,
                function ($message) {
                    return $message;
                },
                __('You tried to call an operation on a Charge Permission that is in a state where that operation cannot be called', 'wcexaap')
            ));
            $this->addError(new GenericError(
                self::INVALID_CHARGE_STATUS,
                $this->getConstantNameByValue(self::INVALID_CHARGE_STATUS),
                422,
                function ($message) {
                    return $message;
                },
                __('You tried to call an operation on a Charge that is in a state where that operation cannot be called', 'wcexaap')
            ));
        }
    }
    

    ソースを伸ばす ソースを縮める


    関数 #関数

    Top ↑

    • __construct — Sets `$module` member var with dependency injection.
    • delete — Cancels a Charge
    • populate — Populates error store

    • 新規会員登録
    • ログイン
      • プラグイン一覧
      • 会社概要
      • リリース情報
      • よくある質問
      • お役立ちコラム
      • お問い合わせ
      • 個人情報保護方針
      • 特定商取引法に基づく表記
      • 情報セキュリティ基本方針
      • 利用規約

    アイベック合同会社は「Welcart」「Amazon Pay」の公式パートナーです。

    ※Amazon、Amazon.co.jp、Amazon Payおよびそれらのロゴは、Amazon.com,inc.またはその関連会社の商標です。
    ※LINE Pay、およびLINE Pay 提携サービスのロゴは、法律上保護を受ける商標です。

    © 2025 Aivec llc All Rights Reserved.