入金API

指定した受注の入金情報を更新します。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

ご注意事項

futureshop管理画面内のデータ（入金日・入金ステータス）のみを更新します。外部連携は行われません。
以下の自動連携機能をお使いの場合でも、連携されません（売上処理されません）。各決済システムから売上処理を行ってください。
NP後払い（即時与信）の場合は、「NP後払い管理画面」から操作できませんので、futureshop管理画面を利用して受注処理されている場合は特にご注意ください。

基本仕様

1リクエストで、最大100件の受注の入金日を更新できます。
「受注番号」「入金日」を指定してリクエストします。

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2024.06.05	各決済の最小金額	「楽天ペイ（オンライン決済）V2（SBPS）」追加	楽天ペイ（オンライン決済）V2（SBPS）追加のため	参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

https://{APIドメイン}/admin-api/v1/payment/status

HTTPメソッド

POST

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ(json)

key		項目名	必須	型	byte	内容
orderList		受注リスト	○	Array	-	受注ごとに配列。最大100件
	orderNo	受注番号	○	String	12
	receiptDate	入金日	○	String	10	「yyyy-mm-dd」形式入金日を削除する場合：空文字を設定

サンプル（リクエストボディ）

{
    "orderList": [
        {
            "orderNo": "100000002828",
            "receiptDate": "2021-10-29"
        }
    ]
}

レスポンス

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-	成功：success 失敗：failed ※一部更新失敗の場合、failedを出力
errors		エラーリスト		Array	-	リクエストのエラー発生時に出力
	code	コード	○	String	-
	path	パス		String	-	入力値エラーの場合、対象のjson位置を出力
	message	メッセージ	○	String	-
results		エラーリスト		Array	-	処理結果
	status	ステータス	○	String	-	成功：success 失敗：failed
	orderNo	受注番号		String	-
	code	コード	○	String	-
	message	メッセージ	○	String	-

results

コード	メッセージ	説明
TooMany	ordersListの指定は100件までです	受注リストの数が100件を超過した場合に返却されます。
TooLong	orderNoは12文字以内で指定してください	orderNoが長過ぎます。12文字以下で指定して下さい。
InvalidValue	orderNoの指定が不正です	数値が正しく指定されてない場合に返却されます。
DuplicateOrderNo	orderNoが重複しています	orderList内に同じ受注番号が存在する場合に返却されます。
InvalidDateFormat	receiptDateの日付フォーマットを正しく指定してください	「yyyy-mm-dd」形式ではない場合、返却されます。
OrderLocked	指定された受注はロックされています	決済方法がPayPayの場合、増額売上げ承認待ち時に受注更新が不可となるため時間を空けてリクエストして下さい。 ------------------------------------------------------ ※増額売上承認待ちについて詳しくはPayPay画面遷移と対応機能-受注処理ロックについてをご覧ください。
OrderNotFound	指定された受注が登録されていません	受注データが存在しない場合に返却されます。
CannotUpdatePaymentStatus	指定された受注の決済区分では入金できません	決済区分が代金引換(COD)、オリコWebクレジット (ORICO_WEB_CREDIT)、決済不要(NONE)の場合に返却されます。
MinPurchaseAmount	決済の最低金額を下回っています	受注金額が各決済の最小金額を下回った場合に返却されます。
MaxPurchaseAmount	決済の最高金額を上回っています	受注金額が設定＞決済一覧＞決済方法設定／【CC未利用・移行中】構築＞送料・決済設定＞決済方法設定の各決済で設定している「利用金額設定-最大購入金額」を超過した場合に返却されます。 ------------------------------------------------------ ※設定＞決済一覧＞決済方法設定／【CC未利用・移行中】構築＞送料・決済設定＞決済方法設定の設定は一定期間(10分程度)キャッシュされる事があります。
PreorderNotAuthorized	予約受注が未オーソリの場合、入金処理はできません	予約受注かつ未オーソリの受注に対して入金処理を行った場合に返却されます。

各決済の最小金額

決済方法名	決済コード	最小決済金額
クレジットカード(F-REGI)	FREGI_CREDIT_CARD	2
AmazonPay	AMAZON_PAY	1
楽天Pay	RAKUTEN_PAY	100
ApplePay	APPLE_PAY	2
クレジットカード(SBPS)	SBPS_CREDIT_CARD	2
PayPay（SBPS）	PAYPAY	1
d払い（SBPS）	DOCOMO	1
キャリア決済　ソフトバンクまとめて支払い（SBPS）	SOFTBANK	1
キャリア決済　auかんたん決済（SBPS）	AU	1
コンビニ支払（SBPS）	SBPS_CONVENI	1
NP後払い（即時与信）	NP_POSTPAY_RTA	1
あと払い（ペイディ）	PAIDY	1
au PAY（ネット支払い）（SBPS）	AU_PAY	1
楽天ペイ（オンライン決済）V2（SBPS）	RAKUTEN_PAY_V2	100

サンプル

サンプル（エラー時）

{
    "status": "failed",
    "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
    "results": [
        {
            "orderNo": "100000002828",
            "errorCode": "OrderLocked",
            "message": "指定された受注はロックされています",
            "status": "failed"
        }
    ]
}

サンプル（成功時）

{
  "status": "success",
  "results": [
    {
    "orderNo": "100000067730",
    "status": "success"
    },
    {
    "orderNo": "100000066248",
    "status": "success"
    }
  ]
  }

サンプル（一部失敗/一部成功時）

{
  "status": "failed",
  "errors": [
    {
    "code": "ErrorsPresent",
    "message": "エラーが発生しました"
    }
  ],
  "results": [
    {
    "orderNo": "100000067730",
    "status": "success"
    },
    {
    "orderNo": "100000002828",
    "errorCode": "OrderLocked",
    "message": "指定された受注はロックされています",
    "status": "failed"
    }
  ]
  }