概要
APIリファレンス
指定された定期購買IDの決済情報を取得する。
※1 定期購買アプリではクレジットカード番号全ては管理しておりません。下4桁のみの返却となります。
項目名 | 内容 |
---|---|
アクション名 | getPaymentMethod |
リクエストメソッド | POST |
項目名 | 内容 | 必須 | フォーマット | 入力例 | 備考 |
---|---|---|---|---|---|
subscriptionContractId | 定期購買ID | はい | gid://shopify/SubscriptionContract/*** | gid://shopify/SubscriptionContract/123456789 |
■正常時レスポンス
プロパティ | 型 | 説明 |
---|---|---|
customerPaymentMethod | customerPaymentMethod | null |
L brand | string | null |
L expiryMonth | number | null |
L expiryYear | number | null |
L name | string | null |
L maskedNumber | string | null |
L lastDigits | string | null |
L inactive | boolean | null |
L paypalAccountEmail | string | null |
※ 決済方法によって返却されるレスポンスが異なります。
■異常時レスポンス
ステータスコード | 型 | エラーメッセージ |
---|---|---|
404 | string | 定期購買が存在しません |
404 | string | ストアが存在しません |
404 | string | 顧客決済情報が存在しません |
500 | string | 内部エラーが発生しています |
■参考情報(Shopifyにおける支払い方法の取り扱いについて)
https://help.shopify.com/ja/manual/products/purchase-options/subscriptions/setup
(1)Shopify Payment(クレジットカード)による支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。
(Google Payはクレジットカードと同じ取り扱いとなるため、上記と同じく返却されます)
(2)PayPal Expressの支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。
(3)Shop Payの支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。