決済情報取得

 

１．基本情報

指定された定期購買IDの決済情報を取得する。
※1 定期購買アプリではクレジットカード番号全ては管理しておりません。下4桁のみの返却となります。
 
項目名内容
アクション名getPaymentMethod
リクエストメソッドPOST

２．リクエストに必要な内容

項目名内容必須フォーマット入力例備考
subscriptionContractId定期購買IDはいgid://shopify/SubscriptionContract/***gid://shopify/SubscriptionContract/123456789

３．レスポンス内容

 
■正常時レスポンス
プロパティ型説明
customerPaymentMethodcustomerPaymentMethod | null決済情報。顧客情報がマスク化されている場合、nullが返却されます
L brandstring | nullクレジットカード種別
L expiryMonthnumber | null有効期限（月）
L expiryYearnumber | null有効期限（年）
L namestring | nullクレジットカード氏名
L maskedNumberstring | nullクレジットカード番号（下4桁以外はマスク済み）
L lastDigitsstring | nullクレジットカード末尾4桁
L inactiveboolean | null利用できない支払い方法かどうか
L paypalAccountEmailstring | nullPaypalメールアドレス
 
※ 決済方法によって返却されるレスポンスが異なります。
 
■異常時レスポンス
ステータスコード型エラーメッセージ
404string定期購買が存在しません
404stringストアが存在しません
404string顧客決済情報が存在しません
500string内部エラーが発生しています
 
■参考情報（Shopifyにおける支払い方法の取り扱いについて）
https://help.shopify.com/ja/manual/products/purchase-options/subscriptions/setup
 
（１）Shopify Payment（クレジットカード）による支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。
（Google Payはクレジットカードと同じ取り扱いとなるため、上記と同じく返却されます）
  • brand
  • expiryMonth
  • expiryYear
  • name
  • maskedNumber
  • lastDigits
 
（２）PayPal Expressの支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。
  • inactive
  • paypalAccountEmail
 
（３）Shop Payの支払いの場合
上記の正常時レスポンスの内、下記項目が返却されます。
  • expiryMonth
  • expiryYear
  • name
  • maskedNumber
  • inactive