概要 #
完全なチェックアウトには4つのステップがある:
- 製品を作る
- 価格設定
- チェックアウトの作成
- レジに移動して支払いを完了する
製品を作る #
商品と価格は、多くのWooshPay統合のコアリソースです。商品は、商品であれサービスであれ、あなたのビジネスが提供するものを定義します。
リクエスト
{
"name": "例の商品"
"active":true、
"description": "何らかの説明"、
「メタデータ": {
"key1": "value1"、
"key3": "value3"
},
"url": "www.example.com"
}
応答
{
"id":"prod_1554351292598452224",
"object":"product"、
"created":1665642282000,
"active": true、
"説明":"記述": true
"メタデータ":{
"key1":"value1"、
"key2":"value2"
},
"name":「商品例
"livemode": false、
"url":"www.example.com"、
"updated":1665642282000,
「画像": null
}
価格設定 #
価格は、商品の価格と頻度を定義します。1つの商品に対して1つまたは複数の価格を設定することができます。
要望1:既成品と直接結合する。
{
"通貨": "GBP"、
"product":"prod_1554351292598452224",
"unit_amount":5、
"active":true、
「メタデータ": {
"key1": "value1"、
"key2": "value2"
},
"ニックネーム": "ニックネーム"、
"product_data":null、
"lookup_key": "test_lookup_key"
}
リクエスト2:新商品を作りながら価格も決めたい
{
"通貨": "GBP"、
"product": null、
"unit_amount":5、
"active":true、
"metadata":{
"key1": "value1"、
"key2": "value2"
},
"ニックネーム": "fengli"、
"product_data":{
"id":null、
"name": "例の商品"、
"active":true、
"description": "とても美味しい"、
"metadata":{
"key1": "value1"、
"key2": "value2"
},
"url": "www.example.com"
},
"billing_scheme": "testscheme"、
"lookup_key": "test_lookup_key"
}
応答
{
"id":"price_1554384814788837376",
"object": "price"、
"created":1659429194000,
"active":true、
"currency": "GBP"、
「メタデータ": {
"key1": "value1"、
"key2": "value2"
},
"ニックネーム": "ニックネーム"、
"product": {
"id":"prod_1554351292598452224",
"object": "product"、
"created":1659421201000,
"active":true、
"description": "とてもおいしい"、
「メタデータ": {
"key1": "value1"、
"key3": "value3"
},
"name": "台湾鳳梨"、
"livemode":false、
"url": "www.example.com"、
"updated":1659422039000
},
「type": "one_time"、
「livemode":false、
"unit_amount":5、
"billing_scheme": "per_unit"、
"lookup_key": "test_lookup_key"
}
チェックアウトの作成 #
チェックアウトセッションは、顧客が支払いフォームにリダイレクトされたときに表示されるものをプログラムで表現したものです。以下のようなオプションで設定できます:
行目
料金- 使用通貨
また、指定する必要がある:
- A
成功URL
支払い完了後、顧客にリダイレクトするウェブサイト上のページ。 - A
キャンセル_url
お客様がチェックアウトの際にロゴをクリックした場合、リダイレクトさせるページをウェブサイト上にご用意ください。
注意:チェックアウトセッションの有効期限は、作成後24時間です。
リクエスト
{
"cancel_url": "www.example.com"、
「mode": "payment"、
"success_url": "www.wooshpay.com"、
「line_items":[
{
「price_data": {
"currency": "GBP"、
"product": null、
"unit_amount":5、
"active":true、
"metadata":{
"key1": "value1"、
"key2": "value2"
},
"ニックネーム": "fengli"、
"product_data":{
"id":null、
"name": "例の商品"、
"active":true、
"description": "とても美味しい"、
"metadata":{
"key1": "value1"、
"key2": "value2"
},
"url": "www.example.com"
},
"billing_scheme": "testscheme"、
"lookup_key": "test_lookup_key"
},
「数量": 1
}
]
}
応答
{
"id":"cs_1580071142008291328",
"オブジェクト": "checkout.session"、
"created":1665553291000,
"通貨": "GBP"、
「customer":"、
「mode": "payment"、
「livemode":false、
"shipping": "null"、
"status": "open"、
"url": "https://checkouttest.wooshpay.com/pay/cs_test_1580071142008291328?key=pk_test_dGVzdDpXWUg1eUF4OXZpUUF4UHNoYmdRRjVTTTE="、
"cancel_url": "www.baidu.com"、
"client_reference_id":null、
「customer_email":null、
"line_items":{
"object": "list"、
「データ":[
{
"id":"li_1580071142847152128",
"object": "item"、
"currency": "GBP"、
"description": "商品例"、
「価格": {
"id":"price_1580071142859735040",
"object": "price"、
"created":1665553291000,
"active":true、
"currency": "GBP"、
「メタデータ": {
"key1": "value1"、
"key2": "value2"
},
"ニックネーム": "fengli"、
"製品": {
"id":"prod_1580071142880706560",
"オブジェクト": "商品"、
"created":1665553291000,
"active":true、
"description": "何らかの説明"、
「メタデータ": {
"key1": "value1"、
"key2": "value2"
},
「name": "example product"、
"livemode":false、
"url": "www.example.com"、
"updated":1665553291000,
「画像":null
},
「type": "one_time"、
「livemode":false、
"unit_amount":5、
"billing_scheme": "per_unit"、
"lookup_key": "test_lookup_key"
},
「数量": 1、
"amount_subtotal":5、
「amount_total":5
}
],
"url":null、
"has_more":null
},
"payment_intent":"pi_1580071150141046784",
"payment_method_types":null、
"payment_status": "unpaid"、
"success_url": "www.wooshpay.com"、
"amount_subtotal":5、
"amount_total":5、
"billing_address_collection": "auto"、
"expires_at":1665639691214,
"payment_link":"、
"payment_method_options": "null"、
「phone_number_collection":null、
"shipping_address_collection":null、
"client_secret":"pi_1580071150141046784_secret_bsOGcAMewpe6orzCbZHMlomu"
}
URLをリダイレクトする #
チェックアウトセッションを作成したら、レスポンスで返されたURLに顧客をリダイレクトします。