KOMOJU をどのように導入するかにかかわらず、直接的あるいは間接的に「決済(payment)」を扱うことになります。Shopify や WooCommerce などの EC プラグイン経由の連携でも、内部では決済が作成されており、それらは API から参照・操作できます。
決済は、お客様から受け取った金銭を表すリソースです。すべての決済は少なくとも amount(金額)と currency(通貨)を持ちます。全属性の詳細は Payment: Show API リファレンスで確認できます。
決済ステータス
決済には読み取り専用の status フィールドがあり、資金が回収されたかどうかを示します。
| ステータス | 意味 |
|---|---|
pending | 決済は開始されましたが、まだ確定していません。顧客の操作を待っている状態です。 |
authorized | 下記の authorized の2つの意味 を参照してください。 |
captured | 決済が成功しました。次回の入金サイクルで指定の銀行口座に振り込まれます。 |
refunded | 決済は完了しましたが、全額返金されました。なお、部分返金の場合は captured のままです。 |
cancelled | 加盟店または顧客のいずれかによってキャンセルされた決済です。 |
expired | pending または authorized のまま一定期間操作がなかったため、有効期限が切れた決済です。 |
authorized の2つの意味
authorized ステータスは、決済手段によって意味が異なります。
- 時間のかかる非同期の決済手段(
konbini、bank_transfer、payeasy)— 決済は予約されており、顧客の操作を待っている状態です(例:コンビニで現金を支払うのを待っている)。 - その他すべての決済手段 —
authorizedはクレジットカードの与信を指します。資金は加盟店側で確保されていますが、まだ顧客の口座からは引き落とされていません。この状態の決済は、加盟店側の操作(商品発送時の手動キャプチャなど)を待っています。詳細は2段階キャプチャを参照してください。
Payment details(高度な連携でのみ使用)
KOMOJU では、決済手段ごとに固有の情報を「payment details」(API では payment_details)と呼びます。たとえば、クレジットカード決済ではカード番号や有効期限、コンビニ決済では顧客が支払うコンビニチェーンなどが該当します。これらの情報がすべて payment details です。
API では、payment_details は以下の場面で使用されます。
Hosted Page または Hosted Fields を利用している場合、payment details を直接扱う必要はありません。決済手段ごとのフィールド一覧については、Payments API | Payment Details を参照してください。