サーバー間通信
キャプチャAPI
キャプチャAPIは、以前に認証APIを通じて認可された資金を転送することにより、支払いを完了させます。
POST
重要なポイント
-
キャプチャAPIは、顧客のアカウントから加盟店のアカウントに認可された資金を移動させることにより、決済プロセスを完了させます。
-
このAPIは通常、認証後に最終金額が確認された後(商品発送後やサービス提供後など)に使用されます。
-
以前に認可された金額のみがキャプチャできます。キャプチャ金額が少ない場合、残りの資金は返金されます。
フローダイアグラム
APIパラメータ
Authorizations
認証のためのAPIキー。形式:'Basic YOUR_API_KEY_HERE'
x-api-key専用のAPIキー。
Body
application/json
取引をキャプチャするためのリクエストペイロード。
承認された取引の元の取引ID。
Maximum length:
36
Example:
"e0b0731e-7170-4b64-8a21-7d835eebd641"
キャプチャする金額。これは承認された金額を超えてはなりません。金額の制限は銀行によって異なります。
Example:
1000
加盟店ID(DASMID)。
Maximum length:
10
Example:
"< Merchant ID >"
キャプチャ取引の参照(オプション)。
Maximum length:
128
Example:
"Capturing authorised amount"
Response
201 - application/json
取引が正常にキャプチャされました。
取引が成功した場合はtrue、失敗した場合はfalse。
Example:
true
取引のステータスコード。
Example:
201
本番取引の場合はtrue、テスト取引の場合はfalse。
Example:
false
取引タイプ(例:CAPTURE)。
Example:
"CAPTURE"
ゲートウェイからの応答を含むJSONオブジェクト。
加盟店の詳細を含むJSONオブジェクト。
取引の支払い詳細を含むJSONオブジェクト。
取引の詳細を含むJSONオブジェクト。