消込結果参照

/api/v1.0/clearing/search

消込結果の参照処理を実行します。

アウトライン

リクエスト

Parameters

名前 概要 桁数 種別 必須
user_id ユーザー ID(管理画面へのログイン ID) 100 メール形式 必須
access_key アクセスキー 100 半角英数 必須
limit_count 消込情報取得件数
※0〜200 の数値を設定する。
省略した場合、20 が設定される
3 数値  
page_count 消込情報取得開始インデックス
※0〜99 の数値を設定する。
省略した場合、0 が設定される
2 数値  
clearing 消込情報に属するパラメータ   object  

clearing (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須 一致
payment 入金情報に属するパラメータ   array    
bill 請求書に属するパラメータ   array    
erasure 消込結果に属するパラメータ   array    
erasure_bill 消込請求書に属するパラメータ   array    
clearing_method 消込手段 3 数値    
clearing_date_from 消込処理日(開始日) 10 日付    
clearing_date_to 消込処理日(終了日) 10 日付    
erasure_deposit_recorded_date_from 消込計上日(開始日) 10 日付    
erasure_deposit_recorded_date_to 消込計上日(終了日) 10 日付    
erasure_cancel_recorded_date_from 消込取消計上日(開始日) 10 日付    
erasure_cancel_recorded_date_to 消込取消計上日(終了日) 10 日付    
payment_transfer_date_from 入金日(開始日) 10 日付    
payment_transfer_date_to 入金日(終了日) 10 日付    

payment (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須 一致
payment_id 入金 ID 18 数値    

bill (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須 一致
number 請求書番号 100 文字列   完全一致

erasure (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須 一致
erasure_id 消込結果 ID 18 数値    

erasure_bill (request)

下記のような項目のオブジェクトを持つリスト

名前 概要 桁数 種別 必須 一致
number 消込請求書番号 100 文字列   完全一致

レスポンス

Fields

名前 概要
user_id ユーザー ID string
access_key アクセスキー string
limit_count 消込情報取得件数
※最大件数は、リクエストで指定された「消込情報取得件数」に依存
int
page_count 消込情報取得開始インデックス
※取得した消込情報の開始インデックスを返却する
int
total_page_count 消込情報取得開始インデックス合計
※指定された検索条件によって取得可能な消込情報の全件数/消込情報取得件数によって、算出される値を返却する
int
clearing 消込情報に属するパラメータ array

clearing (response)

下記のような項目のオブジェクトを持つリスト

名前 概要
error_code エラーコード
※正常時は null
int
error_message エラーメッセージ
※正常時は null
string
erasure_id 消込結果 ID int
clearing_date 消込処理日 date
erasure_deposit_recorded_date 消込計上日 date
clearing_method 消込手段 int
clearing_amount 消込金額 int
bill_billing_number 請求書番号 string
bill_amount 請求金額 int
clearing_bill_billing_number 消込請求書番号 string
payment_id 入金 ID int
payment_transfer_date 入金日 date
account_name 振込名義 string
payment_amount 入金金額 int
erasure_cancel_flg 取消フラグ
0:未取消
1:取消済み
int
erasure_cancel_recorded_date 消込取消計上日 string

使用例

リクエスト例

{
  "user_id": "sample@robotpayment.co.jp",
  "access_key": "xxxxxxxxxxxxxxxx",
  "limit_count": "",
  "page_count": "",
  "clearing": {
    "payment": [
      {
        "payment_id": 12
      }
    ],
    "bill": [
      {
        "number": "202005-sample-1"
      }
    ],
    "erasure": [
      {
        "erasure_id": 1
      },
      {
        "erasure_id": 2
      }
    ],
    "erasure_bill": [
      {
        "number": "202005-sample-2"
      }
    ],
    "clearing_method": 0,
    "clearing_date_from": "2020/03/01",
    "clearing_date_to": "2020/04/11",
    "erasure_deposit_recorded_date_from": "2020/03/01",
    "erasure_deposit_recorded_date_to": "2020/04/11",
    "erasure_cancel_recorded_date_from": "",
    "erasure_cancel_recorded_date_to": null,
    "payment_transfer_date_from": "2020/03/01",
    "payment_transfer_date_to": "2020/04/11"
  }
}

レスポンス例

Status: 200 OK

{
  "user_id": "sample@robotpayment.co.jp",
  "access_key": "xxxxxxxxxxxxxxxx",
  "limit_count": 20,
  "page_count": 0,
  "total_page_count": 1,
  "clearing": [
    {
      "error_code": null,
      "error_message": null,
      "erasure_id": 1,
      "clearing_date": "2020/04/01",
      "erasure_deposit_recorded_date": "2020/04/01",
      "clearing_method": 0,
      "clearing_amount": 1080,
      "bill_billing_number": "202005-sample-1",
      "bill_amount": 1080,
      "clearing_bill_billing_number": "",
      "payment_id": 12,
      "payment_transfer_date": "2020/04/01",
      "account_name": "振込名義",
      "payment_amount": 1080,
      "erasure_cancel_flg": 0,
      "erasure_cancel_recorded_date": null
    },
    {
      "error_code": null,
      "error_message": null,
      "erasure_id": 2,
      "clearing_date": "2020/04/01",
      "erasure_deposit_recorded_date": "2020/04/01",
      "clearing_method": 0,
      "clearing_amount": 1080,
      "bill_billing_number": "202005-sample-2",
      "bill_amount": 1080,
      "clearing_bill_billing_number": null,
      "payment_id": 13,
      "payment_transfer_date": "2020/04/01",
      "account_name": "振込名義",
      "payment_amount": 1080,
      "erasure_cancel_flg": 1,
      "erasure_cancel_recorded_date": "2020/04/01"
    }
  ]
}

エラー

共通エラー

個別エラー

エラーコード 内容
3901 入金 ID が不正
3902 請求書番号が不正
3903 消込結果 ID が不正
3904 消込手段が不正
3905 消込処理日の開始日が不正
3906 消込処理日の終了日が不正
3907 消込計上日の開始日が不正
3908 消込計上日の終了日が不正
3909 消込取消計上日の開始日が不正
3910 消込取消計上日の終了日が不正
3911 入金日の開始日が不正
3912 入金日の終了日が不正
3913 消込結果参照に失敗しました
3914 消込結果情報取得件数が不正
3915 消込結果情報取得開始インデックスが不正

TOP へ戻る