payjpv2 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +13 -2
- data/docs/BankAccountStatus.md +15 -0
- data/docs/BankInfoResponse.md +2 -2
- data/docs/CardBrand.md +15 -0
- data/docs/CardFunding.md +15 -0
- data/docs/CheckoutSessionCreateRequest.md +3 -1
- data/docs/CheckoutSessionDetailsResponse.md +2 -0
- data/docs/CheckoutSessionPaymentMethodOptionsCardRequest.md +2 -2
- data/docs/CheckoutSessionsApi.md +70 -0
- data/docs/DisplayPreferenceRequest.md +1 -1
- data/docs/PaymentFlowCancelRequest.md +1 -1
- data/docs/PaymentFlowCreateRequest.md +2 -0
- data/docs/PaymentFlowPaymentMethodOptionsCardRequest.md +2 -2
- data/docs/PaymentFlowResponse.md +2 -0
- data/docs/PaymentFlowUpdateRequest.md +2 -0
- data/docs/PaymentMethodCardDetailsResponse.md +4 -2
- data/docs/PaymentMethodConfigurationDisplayPreference.md +2 -2
- data/docs/PaymentMethodConfigurationPreference.md +15 -0
- data/docs/PaymentMethodConfigurationValue.md +15 -0
- data/docs/PaymentTransactionsApi.md +4 -4
- data/docs/ProductCreateRequest.md +1 -1
- data/docs/RedirectOptionsRequest.md +18 -0
- data/docs/RedirectOptionsResponse.md +18 -0
- data/docs/RequestExtendedAuthorization.md +15 -0
- data/docs/RequestThreeDSecure.md +15 -0
- data/docs/SetupFlowCancelRequest.md +1 -1
- data/docs/SetupFlowCreateRequest.md +2 -0
- data/docs/SetupFlowPaymentMethodOptionsCardRequest.md +1 -1
- data/docs/SetupFlowResponse.md +2 -0
- data/docs/SetupFlowUpdateRequest.md +2 -0
- data/docs/TaxRateCreateRequest.md +2 -0
- data/docs/TaxRateDetailsResponse.md +2 -0
- data/docs/TaxRateUpdateRequest.md +2 -0
- data/docs/TaxType.md +15 -0
- data/lib/payjpv2/api/checkout_sessions_api.rb +60 -0
- data/lib/payjpv2/api/payment_transactions_api.rb +2 -2
- data/lib/payjpv2/models/balance_state.rb +4 -3
- data/lib/payjpv2/models/bank_account_status.rb +42 -0
- data/lib/payjpv2/models/bank_info_response.rb +24 -2
- data/lib/payjpv2/models/capture_method.rb +4 -3
- data/lib/payjpv2/models/card_brand.rb +45 -0
- data/lib/payjpv2/models/card_funding.rb +41 -0
- data/lib/payjpv2/models/checkout_session_create_request.rb +12 -2
- data/lib/payjpv2/models/checkout_session_details_response.rb +23 -1
- data/lib/payjpv2/models/checkout_session_mode.rb +4 -3
- data/lib/payjpv2/models/checkout_session_payment_method_options_card_request.rb +2 -22
- data/lib/payjpv2/models/checkout_session_status.rb +4 -3
- data/lib/payjpv2/models/checkout_session_submit_type.rb +4 -3
- data/lib/payjpv2/models/checkout_session_ui_mode.rb +4 -3
- data/lib/payjpv2/models/country.rb +4 -3
- data/lib/payjpv2/models/currency.rb +4 -3
- data/lib/payjpv2/models/customer_creation.rb +4 -3
- data/lib/payjpv2/models/display_preference_request.rb +6 -6
- data/lib/payjpv2/models/line_item_request.rb +14 -0
- data/lib/payjpv2/models/locale.rb +4 -3
- data/lib/payjpv2/models/payment_dispute_reason.rb +4 -3
- data/lib/payjpv2/models/payment_dispute_status.rb +4 -3
- data/lib/payjpv2/models/payment_flow_cancel_request.rb +1 -11
- data/lib/payjpv2/models/payment_flow_cancellation_reason.rb +4 -3
- data/lib/payjpv2/models/payment_flow_create_request.rb +11 -1
- data/lib/payjpv2/models/payment_flow_payment_method_options_card_request.rb +2 -22
- data/lib/payjpv2/models/payment_flow_response.rb +23 -1
- data/lib/payjpv2/models/payment_flow_status.rb +4 -3
- data/lib/payjpv2/models/payment_flow_update_request.rb +11 -1
- data/lib/payjpv2/models/payment_method_card_details_response.rb +40 -7
- data/lib/payjpv2/models/payment_method_configuration_display_preference.rb +2 -22
- data/lib/payjpv2/models/payment_method_configuration_preference.rb +42 -0
- data/lib/payjpv2/models/payment_method_configuration_value.rb +41 -0
- data/lib/payjpv2/models/payment_method_types.rb +4 -3
- data/lib/payjpv2/models/payment_refund_reason.rb +4 -3
- data/lib/payjpv2/models/payment_refund_status.rb +4 -3
- data/lib/payjpv2/models/payment_transaction_type.rb +4 -3
- data/lib/payjpv2/models/price_type.rb +4 -3
- data/lib/payjpv2/models/product_create_request.rb +15 -1
- data/lib/payjpv2/models/redirect_options_request.rb +206 -0
- data/lib/payjpv2/models/redirect_options_response.rb +208 -0
- data/lib/payjpv2/models/request_extended_authorization.rb +42 -0
- data/lib/payjpv2/models/request_three_d_secure.rb +41 -0
- data/lib/payjpv2/models/setup_flow_cancel_request.rb +1 -1
- data/lib/payjpv2/models/setup_flow_cancellation_reason.rb +6 -4
- data/lib/payjpv2/models/setup_flow_create_request.rb +11 -1
- data/lib/payjpv2/models/setup_flow_payment_method_options_card_request.rb +1 -11
- data/lib/payjpv2/models/setup_flow_response.rb +23 -1
- data/lib/payjpv2/models/setup_flow_status.rb +4 -3
- data/lib/payjpv2/models/setup_flow_update_request.rb +11 -1
- data/lib/payjpv2/models/statement_subject.rb +4 -3
- data/lib/payjpv2/models/statement_type.rb +4 -3
- data/lib/payjpv2/models/tax_rate_create_request.rb +11 -1
- data/lib/payjpv2/models/tax_rate_details_response.rb +13 -1
- data/lib/payjpv2/models/tax_rate_update_request.rb +11 -1
- data/lib/payjpv2/models/tax_type.rb +40 -0
- data/lib/payjpv2/models/usage.rb +4 -3
- data/lib/payjpv2/version.rb +1 -1
- data/lib/payjpv2.rb +10 -0
- data/spec/api/checkout_sessions_api_spec.rb +33 -0
- data/spec/api/payment_transactions_api_spec.rb +2 -2
- data/spec/integration/anyof_deserialization_spec.rb +8 -1
- data/spec/models/bank_account_status_spec.rb +30 -0
- data/spec/models/card_brand_spec.rb +30 -0
- data/spec/models/card_funding_spec.rb +30 -0
- data/spec/models/checkout_session_create_request_spec.rb +6 -0
- data/spec/models/checkout_session_details_response_spec.rb +6 -0
- data/spec/models/checkout_session_payment_method_options_card_request_spec.rb +0 -8
- data/spec/models/display_preference_request_spec.rb +0 -4
- data/spec/models/payment_flow_cancel_request_spec.rb +0 -4
- data/spec/models/payment_flow_create_request_spec.rb +6 -0
- data/spec/models/payment_flow_payment_method_options_card_request_spec.rb +0 -8
- data/spec/models/payment_flow_response_spec.rb +6 -0
- data/spec/models/payment_flow_update_request_spec.rb +6 -0
- data/spec/models/payment_method_card_details_response_spec.rb +6 -0
- data/spec/models/payment_method_configuration_display_preference_spec.rb +0 -8
- data/spec/models/payment_method_configuration_preference_spec.rb +30 -0
- data/spec/models/payment_method_configuration_value_spec.rb +30 -0
- data/spec/models/redirect_options_request_spec.rb +36 -0
- data/spec/models/redirect_options_response_spec.rb +36 -0
- data/spec/models/request_extended_authorization_spec.rb +30 -0
- data/spec/models/request_three_d_secure_spec.rb +30 -0
- data/spec/models/setup_flow_create_request_spec.rb +6 -0
- data/spec/models/setup_flow_payment_method_options_card_request_spec.rb +0 -4
- data/spec/models/setup_flow_response_spec.rb +6 -0
- data/spec/models/setup_flow_update_request_spec.rb +6 -0
- data/spec/models/tax_rate_create_request_spec.rb +6 -0
- data/spec/models/tax_rate_details_response_spec.rb +6 -0
- data/spec/models/tax_rate_update_request_spec.rb +6 -0
- data/spec/models/tax_type_spec.rb +30 -0
- metadata +41 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 81d43c23b5a8578c804421e1221f7586c023d758000e1a1415e42a901fb545ad
|
|
4
|
+
data.tar.gz: 43d409f825e1110049a584f5f85ce1c2c4a1ef33d964192f2cdf2cfbfd19beaa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bc1edf16e9dc200bdc0afe359dc9f2a8e629c45d557d836cc43438315f7cb18012c46d06ce6fe23e3f0dfea6e4641557b755240a02c9cd80c39be14d8185e29f
|
|
7
|
+
data.tar.gz: 2427b98cf9e7919f875012eb358dd3588aeac9265bf941e1179a9acc98057244b6dba7b4fb19de3fa2a3ad2112a504532a32ce0ab1971076e4c27bafd17b72d2
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -5,7 +5,7 @@ A Ruby client library for the PAY.JP v2 API. This SDK provides a convenient way
|
|
|
5
5
|
This Ruby gem is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
6
6
|
|
|
7
7
|
- API version: 2.0.0
|
|
8
|
-
- Package version: 1.
|
|
8
|
+
- Package version: 1.3.0
|
|
9
9
|
- Generator version: 7.14.0
|
|
10
10
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
11
11
|
|
|
@@ -26,7 +26,7 @@ gem install payjpv2
|
|
|
26
26
|
Add this line to your application's Gemfile:
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem 'payjpv2', '~> 1.
|
|
29
|
+
gem 'payjpv2', '~> 1.3.0'
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
Then execute:
|
|
@@ -196,6 +196,7 @@ Class | Method | HTTP request | Description
|
|
|
196
196
|
*PAYJPv2::BalancesApi* | [**get_all_balances**](docs/BalancesApi.md#get_all_balances) | **GET** /v2/balances | Get All Balances
|
|
197
197
|
*PAYJPv2::BalancesApi* | [**get_balance**](docs/BalancesApi.md#get_balance) | **GET** /v2/balances/{balance_id} | Get Balance
|
|
198
198
|
*PAYJPv2::CheckoutSessionsApi* | [**create_checkout_session**](docs/CheckoutSessionsApi.md#create_checkout_session) | **POST** /v2/checkout/sessions | Create Checkout Session
|
|
199
|
+
*PAYJPv2::CheckoutSessionsApi* | [**expire_checkout_session**](docs/CheckoutSessionsApi.md#expire_checkout_session) | **POST** /v2/checkout/sessions/{checkout_session_id}/expire | Expire Checkout Session
|
|
199
200
|
*PAYJPv2::CheckoutSessionsApi* | [**get_all_checkout_session_line_items**](docs/CheckoutSessionsApi.md#get_all_checkout_session_line_items) | **GET** /v2/checkout/sessions/{checkout_session_id}/line_items | Get All Checkout Session Line Items
|
|
200
201
|
*PAYJPv2::CheckoutSessionsApi* | [**get_all_checkout_sessions**](docs/CheckoutSessionsApi.md#get_all_checkout_sessions) | **GET** /v2/checkout/sessions | Get All Checkout Sessions
|
|
201
202
|
*PAYJPv2::CheckoutSessionsApi* | [**get_checkout_session**](docs/CheckoutSessionsApi.md#get_checkout_session) | **GET** /v2/checkout/sessions/{checkout_session_id} | Get Checkout Session
|
|
@@ -266,9 +267,12 @@ Class | Method | HTTP request | Description
|
|
|
266
267
|
- [PAYJPv2::BalanceResponse](docs/BalanceResponse.md)
|
|
267
268
|
- [PAYJPv2::BalanceState](docs/BalanceState.md)
|
|
268
269
|
- [PAYJPv2::BalanceURLResponse](docs/BalanceURLResponse.md)
|
|
270
|
+
- [PAYJPv2::BankAccountStatus](docs/BankAccountStatus.md)
|
|
269
271
|
- [PAYJPv2::BankInfoResponse](docs/BankInfoResponse.md)
|
|
270
272
|
- [PAYJPv2::CaptureMethod](docs/CaptureMethod.md)
|
|
273
|
+
- [PAYJPv2::CardBrand](docs/CardBrand.md)
|
|
271
274
|
- [PAYJPv2::CardConfigRequest](docs/CardConfigRequest.md)
|
|
275
|
+
- [PAYJPv2::CardFunding](docs/CardFunding.md)
|
|
272
276
|
- [PAYJPv2::CheckoutSessionCreateRequest](docs/CheckoutSessionCreateRequest.md)
|
|
273
277
|
- [PAYJPv2::CheckoutSessionCustomerDetailsAddressResponse](docs/CheckoutSessionCustomerDetailsAddressResponse.md)
|
|
274
278
|
- [PAYJPv2::CheckoutSessionCustomerDetailsResponse](docs/CheckoutSessionCustomerDetailsResponse.md)
|
|
@@ -329,8 +333,10 @@ Class | Method | HTTP request | Description
|
|
|
329
333
|
- [PAYJPv2::PaymentMethodConfigurationDetailsResponse](docs/PaymentMethodConfigurationDetailsResponse.md)
|
|
330
334
|
- [PAYJPv2::PaymentMethodConfigurationDisplayPreference](docs/PaymentMethodConfigurationDisplayPreference.md)
|
|
331
335
|
- [PAYJPv2::PaymentMethodConfigurationListResponse](docs/PaymentMethodConfigurationListResponse.md)
|
|
336
|
+
- [PAYJPv2::PaymentMethodConfigurationPreference](docs/PaymentMethodConfigurationPreference.md)
|
|
332
337
|
- [PAYJPv2::PaymentMethodConfigurationSettingResponse](docs/PaymentMethodConfigurationSettingResponse.md)
|
|
333
338
|
- [PAYJPv2::PaymentMethodConfigurationUpdateRequest](docs/PaymentMethodConfigurationUpdateRequest.md)
|
|
339
|
+
- [PAYJPv2::PaymentMethodConfigurationValue](docs/PaymentMethodConfigurationValue.md)
|
|
334
340
|
- [PAYJPv2::PaymentMethodCreateCardDetailsRequest](docs/PaymentMethodCreateCardDetailsRequest.md)
|
|
335
341
|
- [PAYJPv2::PaymentMethodCreateRequest](docs/PaymentMethodCreateRequest.md)
|
|
336
342
|
- [PAYJPv2::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
|
|
@@ -361,6 +367,10 @@ Class | Method | HTTP request | Description
|
|
|
361
367
|
- [PAYJPv2::ProductDetailsResponse](docs/ProductDetailsResponse.md)
|
|
362
368
|
- [PAYJPv2::ProductListResponse](docs/ProductListResponse.md)
|
|
363
369
|
- [PAYJPv2::ProductUpdateRequest](docs/ProductUpdateRequest.md)
|
|
370
|
+
- [PAYJPv2::RedirectOptionsRequest](docs/RedirectOptionsRequest.md)
|
|
371
|
+
- [PAYJPv2::RedirectOptionsResponse](docs/RedirectOptionsResponse.md)
|
|
372
|
+
- [PAYJPv2::RequestExtendedAuthorization](docs/RequestExtendedAuthorization.md)
|
|
373
|
+
- [PAYJPv2::RequestThreeDSecure](docs/RequestThreeDSecure.md)
|
|
364
374
|
- [PAYJPv2::SetupFlowCancelRequest](docs/SetupFlowCancelRequest.md)
|
|
365
375
|
- [PAYJPv2::SetupFlowCancellationReason](docs/SetupFlowCancellationReason.md)
|
|
366
376
|
- [PAYJPv2::SetupFlowCreateRequest](docs/SetupFlowCreateRequest.md)
|
|
@@ -381,6 +391,7 @@ Class | Method | HTTP request | Description
|
|
|
381
391
|
- [PAYJPv2::TaxRateDetailsResponse](docs/TaxRateDetailsResponse.md)
|
|
382
392
|
- [PAYJPv2::TaxRateListResponse](docs/TaxRateListResponse.md)
|
|
383
393
|
- [PAYJPv2::TaxRateUpdateRequest](docs/TaxRateUpdateRequest.md)
|
|
394
|
+
- [PAYJPv2::TaxType](docs/TaxType.md)
|
|
384
395
|
- [PAYJPv2::TermListResponse](docs/TermListResponse.md)
|
|
385
396
|
- [PAYJPv2::TermResponse](docs/TermResponse.md)
|
|
386
397
|
- [PAYJPv2::Usage](docs/Usage.md)
|
data/docs/BankInfoResponse.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **bank_code** | **String** | 銀行コード | |
|
|
8
8
|
| **bank_branch_code** | **String** | 支店番号 | |
|
|
9
|
-
| **bank_account_type** | **String** |
|
|
9
|
+
| **bank_account_type** | **String** | 口座種別。`普通` または `当座` | |
|
|
10
10
|
| **bank_account_number** | **String** | 口座番号 | |
|
|
11
11
|
| **bank_account_holder_name** | **String** | 口座名義 | |
|
|
12
|
-
| **bank_account_status** | **
|
|
12
|
+
| **bank_account_status** | [**BankAccountStatus**](BankAccountStatus.md) | 最新振込結果 | 値 | |:---| | **success**: 成功 | | **failed**: 失敗 | | **pending**: 初回振込み前 | | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
data/docs/CardBrand.md
ADDED
data/docs/CardFunding.md
ADDED
|
@@ -13,8 +13,9 @@
|
|
|
13
13
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
|
|
14
14
|
| **success_url** | **String** | 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。 | [optional] |
|
|
15
15
|
| **cancel_url** | **String** | キャンセル時のリダイレクト URL | [optional] |
|
|
16
|
+
| **redirect_options** | [**RedirectOptionsRequest**](RedirectOptionsRequest.md) | Checkout から success_url へリダイレクトする際のオプション。Checkout が作成する PaymentFlow / SetupFlow に引き継がれます。 | [optional] |
|
|
16
17
|
| **currency** | [**Currency**](Currency.md) | 価格の通貨。現在は `jpy` のみサポートしています。 | [optional] |
|
|
17
|
-
| **expires_at** | **Time** | Checkout Session
|
|
18
|
+
| **expires_at** | **Time** | Checkout Session の有効期限が失効する日時<br> 24時間以内の日時を指定できます。未指定の場合は作成時点から24時間後になります。 | [optional] |
|
|
18
19
|
| **locale** | [**Locale**](Locale.md) | Checkout 画面の表示言語を指定します。 | 指定できる値 | |:---| | **ja**: 日本語で表示します。 | | [optional] |
|
|
19
20
|
| **payment_method_types** | [**Array<PaymentMethodTypes>**](PaymentMethodTypes.md) | この PaymentFlow で使用できる支払い方法の種類(カードなど)のリストです。指定しない場合、管理画面で利用可能な状態にしている支払い方法を自動的に表示します。 | [optional] |
|
|
20
21
|
| **payment_method_options** | [**CheckoutSessionPaymentMethodOptionsRequest**](CheckoutSessionPaymentMethodOptionsRequest.md) | この PaymentFlow の支払い方法の個別設定 | [optional] |
|
|
@@ -38,6 +39,7 @@ instance = PAYJPv2::CheckoutSessionCreateRequest.new(
|
|
|
38
39
|
metadata: null,
|
|
39
40
|
success_url: null,
|
|
40
41
|
cancel_url: null,
|
|
42
|
+
redirect_options: null,
|
|
41
43
|
currency: null,
|
|
42
44
|
expires_at: null,
|
|
43
45
|
locale: null,
|
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
| **status** | [**CheckoutSessionStatus**](CheckoutSessionStatus.md) | チェックアウトセッションのステータス | |
|
|
26
26
|
| **success_url** | **String** | | |
|
|
27
27
|
| **cancel_url** | **String** | | |
|
|
28
|
+
| **redirect_options** | [**RedirectOptionsResponse**](RedirectOptionsResponse.md) | success_url へリダイレクトする際のオプション | |
|
|
28
29
|
| **url** | **String** | URL | |
|
|
29
30
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | メタデータ | |
|
|
30
31
|
| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) | |
|
|
@@ -57,6 +58,7 @@ instance = PAYJPv2::CheckoutSessionDetailsResponse.new(
|
|
|
57
58
|
status: null,
|
|
58
59
|
success_url: null,
|
|
59
60
|
cancel_url: null,
|
|
61
|
+
redirect_options: null,
|
|
60
62
|
url: null,
|
|
61
63
|
metadata: null,
|
|
62
64
|
created_at: null,
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **request_extended_authorization** | **
|
|
8
|
-
| **request_three_d_secure** | **
|
|
7
|
+
| **request_extended_authorization** | [**RequestExtendedAuthorization**](RequestExtendedAuthorization.md) | オーソリ期間の延長要求 | 指定できる値 | |:---| | **if_available**: オーソリ期間の延長が可能な場合に延長要求を行います。 | | **must_extend**: オーソリ期間の延長を必須とします。延長できない場合はエラーを返します。 | | **never**: オーソリ期間の延長要求を行いません。 | | [optional] |
|
|
8
|
+
| **request_three_d_secure** | [**RequestThreeDSecure**](RequestThreeDSecure.md) | 3D セキュア認証の要求方法 | 指定できる値 | |:---| | **any**: 3D セキュア認証を要求します。 | | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/CheckoutSessionsApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_checkout_session**](CheckoutSessionsApi.md#create_checkout_session) | **POST** /v2/checkout/sessions | Create Checkout Session |
|
|
8
|
+
| [**expire_checkout_session**](CheckoutSessionsApi.md#expire_checkout_session) | **POST** /v2/checkout/sessions/{checkout_session_id}/expire | Expire Checkout Session |
|
|
8
9
|
| [**get_all_checkout_session_line_items**](CheckoutSessionsApi.md#get_all_checkout_session_line_items) | **GET** /v2/checkout/sessions/{checkout_session_id}/line_items | Get All Checkout Session Line Items |
|
|
9
10
|
| [**get_all_checkout_sessions**](CheckoutSessionsApi.md#get_all_checkout_sessions) | **GET** /v2/checkout/sessions | Get All Checkout Sessions |
|
|
10
11
|
| [**get_checkout_session**](CheckoutSessionsApi.md#get_checkout_session) | **GET** /v2/checkout/sessions/{checkout_session_id} | Get Checkout Session |
|
|
@@ -80,6 +81,75 @@ end
|
|
|
80
81
|
- **Accept**: application/json, application/problem+json
|
|
81
82
|
|
|
82
83
|
|
|
84
|
+
## expire_checkout_session
|
|
85
|
+
|
|
86
|
+
> <CheckoutSessionDetailsResponse> expire_checkout_session(checkout_session_id)
|
|
87
|
+
|
|
88
|
+
Expire Checkout Session
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'payjpv2'
|
|
95
|
+
# setup authorization
|
|
96
|
+
PAYJPv2.configure do |config|
|
|
97
|
+
# Configure HTTP basic authorization: HTTPBasic
|
|
98
|
+
config.username = 'YOUR USERNAME'
|
|
99
|
+
config.password = 'YOUR PASSWORD'
|
|
100
|
+
|
|
101
|
+
# Configure Bearer authorization: HTTPBearer
|
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
api_instance = PAYJPv2::CheckoutSessionsApi.new
|
|
106
|
+
checkout_session_id = 'checkout_session_id_example' # String |
|
|
107
|
+
|
|
108
|
+
begin
|
|
109
|
+
# Expire Checkout Session
|
|
110
|
+
result = api_instance.expire_checkout_session(checkout_session_id)
|
|
111
|
+
p result
|
|
112
|
+
rescue PAYJPv2::ApiError => e
|
|
113
|
+
puts "Error when calling CheckoutSessionsApi->expire_checkout_session: #{e}"
|
|
114
|
+
end
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
#### Using the include_http_info option
|
|
118
|
+
|
|
119
|
+
To get response data along with status code and headers, use the `include_http_info: true` option.
|
|
120
|
+
|
|
121
|
+
```ruby
|
|
122
|
+
begin
|
|
123
|
+
# Expire Checkout Session
|
|
124
|
+
data, status_code, headers = api_instance.expire_checkout_session(checkout_session_id, { include_http_info: true })
|
|
125
|
+
p status_code # => 2xx
|
|
126
|
+
p headers # => { ... }
|
|
127
|
+
p data # => <CheckoutSessionDetailsResponse>
|
|
128
|
+
rescue PAYJPv2::ApiError => e
|
|
129
|
+
puts "Error when calling CheckoutSessionsApi->expire_checkout_session: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
| Name | Type | Description | Notes |
|
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
|
137
|
+
| **checkout_session_id** | **String** | | |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**CheckoutSessionDetailsResponse**](CheckoutSessionDetailsResponse.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[HTTPBasic](../README.md#HTTPBasic), [HTTPBearer](../README.md#HTTPBearer)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: Not defined
|
|
150
|
+
- **Accept**: application/json, application/problem+json
|
|
151
|
+
|
|
152
|
+
|
|
83
153
|
## get_all_checkout_session_line_items
|
|
84
154
|
|
|
85
155
|
> <CheckoutSessionLineItemListResponse> get_all_checkout_session_line_items(checkout_session_id, opts)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **preference** | **
|
|
7
|
+
| **preference** | [**PaymentMethodConfigurationPreference**](PaymentMethodConfigurationPreference.md) | この支払い方法がアカウントで有効になっているかどうか | 値 | |:---| | **on**: この決済手段を決済画面に表示する | | **off**: この決済手段を決済画面に表示しない | | **none**: デフォルト設定を使用 | | |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **cancellation_reason** | **
|
|
7
|
+
| **cancellation_reason** | [**PaymentFlowCancellationReason**](PaymentFlowCancellationReason.md) | この PaymentFlow のキャンセル理由 | 値 | |:---| | **duplicate**: 重複した支払いである場合。 | | **fraudulent**: 不正な利用だと考えられる場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **abandoned**: 顧客が支払いを完了しなかった場合。 | | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **capture_method** | [**CaptureMethod**](CaptureMethod.md) | 支払いの確定方法を指定します。 | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Payment Flow の Capture API を使用して確定します。(すべての支払い方法がこれをサポートしているわけではありません)。 | | [optional] |
|
|
14
14
|
| **confirm** | **Boolean** | 「true」に設定すると、この PaymentFlow を直ちに確定しようと試みます。 | [optional][default to false] |
|
|
15
15
|
| **return_url** | **String** | 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。confirm=true の場合のみ指定できます。 | [optional] |
|
|
16
|
+
| **redirect_options** | [**RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional] |
|
|
16
17
|
| **description** | **String** | オブジェクトにセットする任意の文字列。 | [optional] |
|
|
17
18
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
|
|
18
19
|
|
|
@@ -31,6 +32,7 @@ instance = PAYJPv2::PaymentFlowCreateRequest.new(
|
|
|
31
32
|
capture_method: null,
|
|
32
33
|
confirm: null,
|
|
33
34
|
return_url: null,
|
|
35
|
+
redirect_options: null,
|
|
34
36
|
description: null,
|
|
35
37
|
metadata: null
|
|
36
38
|
)
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **request_extended_authorization** | **
|
|
8
|
-
| **request_three_d_secure** | **
|
|
7
|
+
| **request_extended_authorization** | [**RequestExtendedAuthorization**](RequestExtendedAuthorization.md) | オーソリ期間の延長要求 | 値 | |:---| | **if_available**: オーソリ期間の延長が可能な場合に延長要求を行います。 | | **must_extend**: オーソリ期間の延長を必須とします。延長できない場合はエラーを返します。 | | **never**: オーソリ期間の延長要求を行いません。 | | [optional] |
|
|
8
|
+
| **request_three_d_secure** | [**RequestThreeDSecure**](RequestThreeDSecure.md) | 3D セキュア認証の要求方法。 | 値 | |:---| | **any**: 3D セキュア認証を要求します。 | | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/PaymentFlowResponse.md
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
| **status** | [**PaymentFlowStatus**](PaymentFlowStatus.md) | この PaymentFlow のステータス。 | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **requires_capture**: 確定が必要です。 | | **canceled**: キャンセルされました。 | | **succeeded**: 成功しました。 | | |
|
|
21
21
|
| **next_action** | **Hash<String, Object>** | | |
|
|
22
22
|
| **return_url** | **String** | | |
|
|
23
|
+
| **redirect_options** | [**RedirectOptionsResponse**](RedirectOptionsResponse.md) | return_url へリダイレクトする際のオプション | |
|
|
23
24
|
| **capture_method** | [**CaptureMethod**](CaptureMethod.md) | 支払いの確定方法 | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。(すべての支払い方法がこれをサポートしているわけではありません)。 | | |
|
|
24
25
|
| **last_payment_error** | **Hash<String, Object>** | | |
|
|
25
26
|
| **cancellation_reason** | [**PaymentFlowCancellationReason**](PaymentFlowCancellationReason.md) | | |
|
|
@@ -51,6 +52,7 @@ instance = PAYJPv2::PaymentFlowResponse.new(
|
|
|
51
52
|
status: null,
|
|
52
53
|
next_action: null,
|
|
53
54
|
return_url: null,
|
|
55
|
+
redirect_options: null,
|
|
54
56
|
capture_method: null,
|
|
55
57
|
last_payment_error: null,
|
|
56
58
|
cancellation_reason: null,
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **payment_method_options** | [**PaymentFlowPaymentMethodOptionsRequest**](PaymentFlowPaymentMethodOptionsRequest.md) | この PaymentFlow 固有の支払い方法の設定 | [optional] |
|
|
11
11
|
| **payment_method_types** | [**Array<PaymentMethodTypes>**](PaymentMethodTypes.md) | この PaymentFlow で使用できる支払い方法の種類のリスト。指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional] |
|
|
12
12
|
| **return_url** | **String** | 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。 | [optional] |
|
|
13
|
+
| **redirect_options** | [**RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional] |
|
|
13
14
|
| **description** | **String** | オブジェクトにセットする任意の文字列。 | [optional] |
|
|
14
15
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
|
|
15
16
|
|
|
@@ -25,6 +26,7 @@ instance = PAYJPv2::PaymentFlowUpdateRequest.new(
|
|
|
25
26
|
payment_method_options: null,
|
|
26
27
|
payment_method_types: null,
|
|
27
28
|
return_url: null,
|
|
29
|
+
redirect_options: null,
|
|
28
30
|
description: null,
|
|
29
31
|
metadata: null
|
|
30
32
|
)
|
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **last4** | **String** | カードの下4桁 | |
|
|
8
|
-
| **brand** | **
|
|
8
|
+
| **brand** | [**CardBrand**](CardBrand.md) | | |
|
|
9
9
|
| **exp_month** | **Integer** | カードの有効期限(月) | |
|
|
10
10
|
| **exp_year** | **Integer** | カードの有効期限(年) | |
|
|
11
11
|
| **fingerprint** | **String** | このクレジットカード番号に紐づく値。同一番号のカードからは同一の値が生成されることが保証されています。 | |
|
|
12
12
|
| **country** | **String** | | |
|
|
13
|
+
| **funding** | [**CardFunding**](CardFunding.md) | | |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = PAYJPv2::PaymentMethodCardDetailsResponse.new(
|
|
|
22
23
|
exp_month: null,
|
|
23
24
|
exp_year: null,
|
|
24
25
|
fingerprint: null,
|
|
25
|
-
country: null
|
|
26
|
+
country: null,
|
|
27
|
+
funding: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **preference** | **
|
|
8
|
-
| **value** | **
|
|
7
|
+
| **preference** | [**PaymentMethodConfigurationPreference**](PaymentMethodConfigurationPreference.md) | この支払い方法がアカウントで有効になっているかどうか | 値 | |:---| | **on**: この決済手段を決済画面に表示する | | **off**: この決済手段を決済画面に表示しない | | **none**: デフォルト設定を使用 | | [optional] |
|
|
8
|
+
| **value** | [**PaymentMethodConfigurationValue**](PaymentMethodConfigurationValue.md) | この支払い方法を決済画面に表示するかどうか。 | 値 | |:---| | **on**: この決済手段を決済画面に表示する | | **off**: この決済手段を決済画面に表示しない | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PAYJPv2::PaymentMethodConfigurationPreference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'payjpv2'
|
|
12
|
+
|
|
13
|
+
instance = PAYJPv2::PaymentMethodConfigurationPreference.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PAYJPv2::PaymentMethodConfigurationValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'payjpv2'
|
|
12
|
+
|
|
13
|
+
instance = PAYJPv2::PaymentMethodConfigurationValue.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -35,8 +35,8 @@ opts = {
|
|
|
35
35
|
starting_after: 'starting_after_example', # String | このIDより後のデータを取得
|
|
36
36
|
ending_before: 'ending_before_example', # String | このIDより前のデータを取得
|
|
37
37
|
term_id: 'term_id_example', # String | 集計区間 ID
|
|
38
|
-
type:
|
|
39
|
-
payment_method_type:
|
|
38
|
+
type: PAYJPv2::PaymentTransactionType::PAYMENT, # PaymentTransactionType | 取引タイプ
|
|
39
|
+
payment_method_type: PAYJPv2::PaymentMethodTypes::CARD # PaymentMethodTypes | 支払い方法タイプ
|
|
40
40
|
}
|
|
41
41
|
|
|
42
42
|
begin
|
|
@@ -72,8 +72,8 @@ end
|
|
|
72
72
|
| **starting_after** | **String** | このIDより後のデータを取得 | [optional] |
|
|
73
73
|
| **ending_before** | **String** | このIDより前のデータを取得 | [optional] |
|
|
74
74
|
| **term_id** | **String** | 集計区間 ID | [optional] |
|
|
75
|
-
| **type** | **
|
|
76
|
-
| **payment_method_type** | **
|
|
75
|
+
| **type** | [**PaymentTransactionType**](.md) | 取引タイプ | [optional] |
|
|
76
|
+
| **payment_method_type** | [**PaymentMethodTypes**](.md) | 支払い方法タイプ | [optional] |
|
|
77
77
|
|
|
78
78
|
### Return type
|
|
79
79
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Checkout などで顧客に表示される商品名 | |
|
|
8
|
-
| **id** | **String** | 商品 ID | [optional] |
|
|
8
|
+
| **id** | **String** | 商品 ID(255文字以内) | [optional] |
|
|
9
9
|
| **active** | **Boolean** | 商品が購入可能かどうか | [optional][default to true] |
|
|
10
10
|
| **description** | **String** | Checkout などで顧客に表示される商品説明 | [optional] |
|
|
11
11
|
| **unit_label** | **String** | この製品の単位を表すラベル。設定すると、Checkout などに表示されます。(例:「個」、「ライセンス」、「時間」、「回」など) | [optional] |
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PAYJPv2::RedirectOptionsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **include_client_secret** | **Boolean** | return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは `true` です。 | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'payjpv2'
|
|
13
|
+
|
|
14
|
+
instance = PAYJPv2::RedirectOptionsRequest.new(
|
|
15
|
+
include_client_secret: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# PAYJPv2::RedirectOptionsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **include_client_secret** | **Boolean** | return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは `true` です。 | [optional][default to true] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'payjpv2'
|
|
13
|
+
|
|
14
|
+
instance = PAYJPv2::RedirectOptionsResponse.new(
|
|
15
|
+
include_client_secret: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# PAYJPv2::RequestExtendedAuthorization
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'payjpv2'
|
|
12
|
+
|
|
13
|
+
instance = PAYJPv2::RequestExtendedAuthorization.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **cancellation_reason** | [**SetupFlowCancellationReason**](SetupFlowCancellationReason.md) | この SetupFlow のキャンセル理由。 | 値 | |:---| | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **duplicate**: 支払い方法が重複している場合。 | | [optional] |
|
|
7
|
+
| **cancellation_reason** | [**SetupFlowCancellationReason**](SetupFlowCancellationReason.md) | この SetupFlow のキャンセル理由。 | 値 | |:---| | **abandoned**: 顧客が SetupFlow を完了しなかった場合。 | | **requested_by_customer**: 顧客がキャンセルを要求した場合。 | | **duplicate**: 支払い方法が重複している場合。 | `expired` はシステムが自動的に設定する値のため、リクエストでは指定できません。 | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **payment_method_options** | [**SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional] |
|
|
9
9
|
| **payment_method_types** | **Array<String>** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional] |
|
|
10
10
|
| **usage** | [**Usage**](Usage.md) | 支払い方法が今後どのように使用されるかを指定します。指定されていない場合、この値はデフォルトで `off_session` になります。 | 値 | |:---| | **off_session**: 定期課金など、顧客がカートなどの決済フローにいるかどうか不明な場合は `off_session` を使用してください。 | | **on_session**: 顧客がカートなどの決済フローにいる場合にのみ支払い方法を利用する場合は `on_session` を使用してください。 | | [optional] |
|
|
11
|
+
| **redirect_options** | [**RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional] |
|
|
11
12
|
| **description** | **String** | 説明。 | [optional] |
|
|
12
13
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
|
|
13
14
|
|
|
@@ -21,6 +22,7 @@ instance = PAYJPv2::SetupFlowCreateRequest.new(
|
|
|
21
22
|
payment_method_options: null,
|
|
22
23
|
payment_method_types: null,
|
|
23
24
|
usage: null,
|
|
25
|
+
redirect_options: null,
|
|
24
26
|
description: null,
|
|
25
27
|
metadata: null
|
|
26
28
|
)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **request_three_d_secure** | **
|
|
7
|
+
| **request_three_d_secure** | [**RequestThreeDSecure**](RequestThreeDSecure.md) | 3D セキュア認証の要求方法。 | 値 | |:---| | **any**: 3D セキュア認証を要求します。 | | **automatic**: 必要な場合にのみ 3D セキュア認証を要求します。 | | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
data/docs/SetupFlowResponse.md
CHANGED
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
| **status** | [**SetupFlowStatus**](SetupFlowStatus.md) | この SetupFlow のステータスです。<a href=\"https://docs.pay.jp/v2/guide/payments/setupflow#setup-flow-%E3%81%AE%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9\" target=\"_blank\">ステータスの詳細についてはこちらをご覧ください。</a> | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **succeeded**: 成功しました。 | | **canceled**: キャンセルされました。 | | |
|
|
18
18
|
| **next_action** | **Hash<String, Object>** | | |
|
|
19
19
|
| **return_url** | **String** | | |
|
|
20
|
+
| **redirect_options** | [**RedirectOptionsResponse**](RedirectOptionsResponse.md) | return_url へリダイレクトする際のオプション | |
|
|
20
21
|
| **last_setup_error** | **Hash<String, Object>** | | |
|
|
21
22
|
| **cancellation_reason** | [**SetupFlowCancellationReason**](SetupFlowCancellationReason.md) | | |
|
|
22
23
|
| **created_at** | **Time** | 作成日時 (UTC, ISO 8601 形式) | |
|
|
@@ -41,6 +42,7 @@ instance = PAYJPv2::SetupFlowResponse.new(
|
|
|
41
42
|
status: null,
|
|
42
43
|
next_action: null,
|
|
43
44
|
return_url: null,
|
|
45
|
+
redirect_options: null,
|
|
44
46
|
last_setup_error: null,
|
|
45
47
|
cancellation_reason: null,
|
|
46
48
|
created_at: null,
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **customer_id** | **String** | この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。 | [optional] |
|
|
8
8
|
| **payment_method_options** | [**SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional] |
|
|
9
9
|
| **payment_method_types** | **Array<String>** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional] |
|
|
10
|
+
| **redirect_options** | [**RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional] |
|
|
10
11
|
| **description** | **String** | 説明。 | [optional] |
|
|
11
12
|
| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。<a href=\"https://docs.pay.jp/v2/guide/developers/metadata\">詳細はメタデータのドキュメントを参照してください。</a> | [optional] |
|
|
12
13
|
|
|
@@ -19,6 +20,7 @@ instance = PAYJPv2::SetupFlowUpdateRequest.new(
|
|
|
19
20
|
customer_id: null,
|
|
20
21
|
payment_method_options: null,
|
|
21
22
|
payment_method_types: null,
|
|
23
|
+
redirect_options: null,
|
|
22
24
|
description: null,
|
|
23
25
|
metadata: null
|
|
24
26
|
)
|