Skip to content

PaymentFlowResponse.md

Latest commit

 

History

History
64 lines (58 loc) · 3.45 KB

PaymentFlowResponse.md

File metadata and controls

64 lines (58 loc) · 3.45 KB

PAYJPv2::PaymentFlowResponse

Properties

Name Type Description Notes
object String [optional][default to 'payment_flow']
id String 支払いフロー ID
livemode Boolean 本番環境かどうか
amount Integer 支払い予定の金額
currency Currency 価格の通貨。現在は `jpy` のみサポートしています。
amount_capturable Integer
amount_received Integer
client_secret String この PaymentFlow のクライアントシークレットです。フロントエンドで公開 API キーと合わせて使用し PaymentFlow の情報を取得や支払い処理を行います。**この値はこの PaymentFlow の支払いを行う顧客以外へ公開しないでください。**また保存やログへの記録なども行わないでください。
customer_id String
description String
payment_method_id String
payment_method_options Hash<String, Object>
payment_method_types Array<PaymentMethodTypes> この PaymentFlow で使用できる支払い方法の種類のリスト
status PaymentFlowStatus この PaymentFlow のステータス。 値
next_action Hash<String, Object>
return_url String
capture_method CaptureMethod 支払いの確定方法 値
last_payment_error Hash<String, Object>
cancellation_reason PaymentFlowCancellationReason
canceled_at Time
expired_at Time [optional]
metadata Hash<String, MetadataValue> メタデータ
created_at Time 作成日時 (UTC, ISO 8601 形式)
updated_at Time 更新日時 (UTC, ISO 8601 形式)

Example

require 'payjpv2'

instance = PAYJPv2::PaymentFlowResponse.new(
  object: null,
  id: null,
  livemode: null,
  amount: null,
  currency: null,
  amount_capturable: null,
  amount_received: null,
  client_secret: null,
  customer_id: null,
  description: null,
  payment_method_id: null,
  payment_method_options: null,
  payment_method_types: null,
  status: null,
  next_action: null,
  return_url: null,
  capture_method: null,
  last_payment_error: null,
  cancellation_reason: null,
  canceled_at: null,
  expired_at: null,
  metadata: null,
  created_at: null,
  updated_at: null
)