まるなげ与信申請参照
/api/v1.0/request_marunage_credit/search
請求先の与信申請情報を返却します。
アウトライン
リクエスト
- Path:
/api/v1.0/request_marunage_credit/search
- Preferred HTTP method:
POST
- Accepted content types:
application/json
- Encode:
UTF-8
Parameters
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
user_id | ユーザーID(管理画面へのログインID) | 100 | メール形式 | 必須 |
access_key | アクセスキー | 100 | 半角英数 | 必須 |
limit_count | まるなげ与信申請情報取得件数 ※0〜200の数値を設定する。省略した場合、20が設定される |
3 | int | |
page_count | まるなげ与信申請情報取得開始インデックス ※0~99の数値を設定する。省略した場合、0が設定される |
2 | int | |
request_marunage_credit | まるなげ与信申請情報に属するパラメータ | object |
request_marunage_credit (request)
下記のような項目のオブジェクト
名前 | 概要 | 桁数 | 種別 | 必須 |
---|---|---|---|---|
id | まるなげ与信申請ID | 18 | 数値 | |
billing_code | 請求先コード | 20 | 半角英数 + 記号 | |
status | まるなげ与信申請状態 0: 却下 1: 承認 2: 申請中 |
1 | 数値 | |
requested_date_from | 申請日時の検索開始日時 ※時刻省略時 00:00:00 で検索します |
19 | 日時 | |
requested_date_to | 申請日時の検索終了日時 ※時刻省略時 23:59:59 で検索します |
19 | 日時 | |
responded_date_from | 回答日時の検索開始日時 ※時刻省略時 00:00:00 で検索します |
19 | 日時 | |
responded_date_to | 回答日時の検索終了日時 ※時刻省略時 23:59:59 で検索します |
19 | 日時 |
レスポンス
- Type:
application/json
- Encode:
UTF-8
Fields
名前 | 概要 | 型 |
---|---|---|
user_id | ユーザーID | string |
limit_count | まるなげ与信申請情報取得件数 ※最大件数は、リクエストで指定された「与信申請情報取得件数」に依存 |
int |
page_count | まるなげ与信申請情報取得開始インデックス ※取得した与信申請情報の開始インデックスを返却する |
int |
total_page_count | まるなげ与信申請情報取得開始インデックス合計 ※指定された検索条件によって取得可能な与信申請情報の全件数/与信申請情報取得件数によって、算出される値を返却する |
int |
request_marunage_credit | まるなげ与信申請情報に属するパラメータ | array |
request_marunage_credit (response)
下記のような項目のオブジェクトを持つリスト
名前 | 概要 | 型 |
---|---|---|
error_code | エラーコード ※正常時はnull |
int |
error_message | エラーメッセージ ※正常時はnull |
string |
id | まるなげ与信申請ID | int |
billing_code | 請求先コード | string |
status | まるなげ与信申請状態 0: 却下 1: 承認 2: 申請中 |
int |
requested_date | 申請日時 | datetime |
responded_date | 回答日時 | datetime |
使用例
リクエスト例
{
"user_id": "sample@robotpayment.co.jp",
"access_key": "xxxxxxxxxxxxxxxx",
"limit_count": 100,
"page_count": 0,
"request_marunage_credit": {
"requested_date_from": "2022/01/11"
}
}
レスポンス例
Status: 200 OK
{
"user_id": "sample@robotpayment.co.jp",
"limit_count": 100,
"page_count": 0,
"total_page_count": 2,
"request_marunage_credit": [
{
"error_code": null,
"error_message": null,
"id": 2,
"billing_code": "billing_code_2",
"status": 1,
"requested_date":"2022/01/12 00:00:00",
"responded_date":"2022/01/12 00:00:00"
},
{
"error_code": null,
"error_message": null,
"id": 1,
"billing_code": "billing_code_1",
"status": 2,
"requested_date":"2022/01/11 00:00:00",
"responded_date": null
}
]
}
エラー
個別エラー
エラーコード | 内容 |
---|---|
5601 | 請求先コードが不正 |
5602 | まるなげ与信申請状態が不正 |
5603 | 申請日時の検索開始日時が不正 |
5604 | 申請日時の検索終了日時が不正 |
5605 | 回答日時の検索開始日時が不正 |
5606 | 回答日時の検索終了日時が不正 |
5607 | まるなげ与信申請情報取得件数が不正 |
5608 | まるなげ与信申請情報取得開始インデックス件数が不正 |
5609 | まるなげ与信申請IDが不正 |