支払ステータス更新（DENSAI）

OpenAPI説明

当該OpenAPIは、でんさいの支払ステータスを更新する際に利用します。

OpenAPI権限

当該OpenAPIはB2B専用のトークン権限が必要です。

リクエストURI

/api/openapi/btob/densai/payment/batch/status

リクエスト形式

PUT

リクエスト例

{
  "tenantId": "1214732595705114600",
  "paymentBatchList": [
    {
      "paymentBatchNumber": "202406130116080000000000000001368",
      "notifyType":"1",
      "temporaryRegistrationInfo": 
      {
        "resultCode": "01",
        "requestsNumber": "S016920XX09240000001",
        "approvalDeadline": "2026-02-26",
        "recordRequestsDate": "2026-02-26"
      },
      "recordStatus":"03",
      "recordInfo": 
      {
        "recordNumber": "000000XYZ90000S00047",
        "resultCreateDate": "2026-02-28",
        "cancellationDeadline": "2026-03-06"
      },
      "gyomuErrorMessageInfo": [
        {
          "gyomuErrorCd":"00000031",
          "gyomuErrorMessage":"指定された記録番号の債権は、譲渡取引中、または、譲渡取引済みのため譲渡できません。別の譲渡対象でんさいを指定してください。"
        }
      ],
      "errorInfo": 
      {
        "errorType":"XXXXX",
        "errorCodeDetail1":"XXXXX",
        "errorMessageDetail1":"XXXXX",
        "errorCodeDetail2":"XXXXX",
        "errorMessageDetail2":"XXXXX"
        }
    }
  ]
}

リクエスト項目

項目	タイプ	必須	キー	制限	説明
tenantId	String	◯	◯	最大19文字	テナントID
paymentBatchList	paymentBatchDTO[]	◯			支払一括処理番号リスト

paymentBatchDTO

項目	タイプ	必須	キー	制限	説明
paymentBatchNumber	String	◯	◯	最大33文字	支払一括処理番号 DX-PFで支払情報を一意に特定するためのキー
notifyType	Int	◯		1桁	通知種別 1:仮登録結果 2:でんさい記録状態
temporaryRegistrationInfo	temporaryRegistDTO	△			仮登録結果情報通知種別が1の場合、必須
recordStatus	String	△		2桁	でんさい記録状態 01:仮登録中 02:承認期限超過 03:記録請求失敗 04:予約中 05:予約取消 06:記録済（確認期間中） 07:記録済 08:記録取消仮登録結果が03以外場合、必須
recordInfo	recordInfoDTO				でんさい記録情報通知種別が1の場合、設定不要
gyomuErrorMessageInfo	gyomuErrorMessageInfoDTO[]				業務エラー情報
errorInfo	errorInfoDTO				エラー情報

temporaryRegistDTO

項目	タイプ	必須	制限	説明
resultCode	String	△	2桁	仮登録結果 01:仮登録成功 02:仮登録成功（警告あり） 03:仮登録失敗通知種別が1の場合、必須
requestsNumber	String	△	20桁	請求番号通知種別が1、かつ、仮登録結果が03以外の場合、必須
approvalDeadline	String		日付フォマット：yyyy-mm-dd	承認期限通知種別が1、かつ、仮登録結果が03以外の場合、必須
recordRequestsDate	String		日付フォマット：yyyy-mm-dd	記録請求日通知種別が1、かつ、仮登録結果が03以外の場合、必須

recordInfoDTO

項目	タイプ	必須	制限	説明
recordNumber	String	△	20桁	記録番号通知種別が2、かつ、でんさい記録状態が04〜08の場合、必須
resultCreateDate	String	△	日付フォマット：yyyy-mm-dd	結果作成日通知種別が2、かつ、でんさい記録状態が03〜08の場合、必須
cancellationDeadline	String	△	日付フォマット：yyyy-mm-dd	取消期限通知種別が2、かつ、でんさい記録状態が06の場合、必須

gyomuErrorMessageInfoDTO

項目	タイプ	必須	キー	制限	説明
gyomuErrorCd	String			最大256文字	業務エラーコード
gyomuErrorMessage	String			最大256文字	業務エラーメッセー

errorInfoDTO

項目	タイプ	制限	説明
errorType	String	最大2文字	エラー区分 01:エラー 02:エラー（連鎖）
errorCodeDetail1	String	最大256文字	エラーコード詳細1
errorMessageDetail1	String	最大256文字	エラーメッセージ詳細1
errorCodeDetail2	String	最大256文字	エラーコード詳細2
errorMessageDetail2	String	最大256文字	エラーメッセージ詳細2

OpenAPIリターン例

成功例

{
  "message": "success",
  "errorCode": "0000"
}

失敗例

{
  "message": "パラメータ:invoiceIDは指定必須の項目です",
  "errorCode": "120003"
}

項目説明

項目	タイプ	説明
message	String	エラーメッセージ
errorCode	String	エラーコード

エラーコード説明

errorCode	message	説明
120003	{0}は指定必須の項目です
0010	{0} のフォーマットが不正です。
0013	{0}は{1}文字以内で指定してください
120016	パラメータ:{0}は{1}文字で指定してください
spd.32874.001	{0}:{1} は存在しません
spd.32874.002	更新対象の支払データのステータスは操作不可です
120001	テナントの権限がありません

← 支払ステータス更新（DGFT）口座残高情報取込 →