支払ステータス更新(DGFT)
OpenAPI説明
当該OpenAPIは、支払ステータスを更新する際に利用します。
OpenAPI権限
当該OpenAPIはテナント権限が必要です。
リクエストURI
/api/openapi/btob/dgft/payment/batch/status
リクエスト形式
PUT
リクエスト例
{
"invoiceID": "123456789",
"paymentStatus": "1",
"processingTime":"2024-11-13 17:40:26",
"processingSystem":"DGFT",
"processingOperatorID":"A001",
"processingOperatorName":"従業員A"
}
リクエスト項目
項目 | タイプ | 必須 | キー | 制限 | 説明 |
---|---|---|---|---|---|
invoiceID | String | ◯ | 最大19文字 | 請求書ID | |
paymentStatus | String | ◯ | 最大1文字 | 支払結果 1:カード支払申請完了 2:修正依頼中 3:審査完了 4:審査NG 5:申込キャンセル 6:振込完了 | |
processingTime | Date | ◯ | 処理実行時間 日付フォーマット:YYYY-MM-DD HH:MM:SS | ||
processingSystem | String | ◯ | 最大20文字 | 処理実行システム | |
processingOperatorID | String | ◯ | 最大20文字 | 処理実行者ID | |
processingOperatorName | String | ◯ | 最大40文字 | 処理実行者名 |
OpenAPIリターン例
成功例
{
"message": "success",
"errorCode": "0000"
}
失敗例
{
"message": "パラメータ:invoiceIDは指定必須の項目です",
"errorCode": "120003"
}
項目説明
項目 | タイプ | 説明 |
---|---|---|
message | String | エラーメッセージ |
errorCode | String | エラーコード |
エラーコード説明
errorCode | message | 説明 |
---|---|---|
120003 | パラメータ:{0}は指定必須の項目です | |
0013 | パラメータ:{0}は{1}文字以内で指定してください | |
spd.32874.001 | {0}:{1} は存在しません | |
spd.32874.002 | 更新対象の支払データのステータスは操作不可です | |
120001 | テナントの権限がありません |