与信停止申請
/api/v1.0/marunage_credit/bulk_stop
指定の請求先の与信を停止申請します。既に与信が有効な請求先に対してのみ行えます。
リクエスト上限は3000件です。
アウトライン
リクエスト
- Path:
/api/v1.0/marunage_credit/bulk_stop - Preferred HTTP method:
POST - Accepted content types:
application/json - Encode:
UTF-8
Parameters
| 名前 | 概要 | 桁数 | 種別 | 必須 |
|---|---|---|---|---|
| user_id | ユーザーID(管理画面へのログインID) | 100 | メール形式 | 必須 |
| access_key | アクセスキー | 100 | 半角英数 | 必須 |
| marunage_credit | 与信停止申請に属するパラメータ | array |
marunage_credit (request)
下記のような項目のオブジェクトを持つリスト
| 名前 | 概要 | 桁数 | 種別 | 必須 |
|---|---|---|---|---|
| billing_code | 請求先コード | 20 | 半角英数 + 記号 | 必須 |
| reason | 停止理由 | 255 | 文字列 | 必須 |
レスポンス
- Type:
application/json - Encode:
UTF-8
Fields
| 名前 | 概要 | 型 |
|---|---|---|
| user_id | ユーザーID | string |
| marunage_credit | 与信停止申請に属するパラメータ | array |
marunage_credit (response)
下記のような項目のオブジェクトを持つリスト
| 名前 | 概要 | 型 |
|---|---|---|
| error_code | エラーコード ※正常時はnull |
int |
| error_message | エラーメッセージ ※正常時はnull |
string |
| billing_code | 請求先コード | string |
| reason | 停止理由 | string |
| status | 与信停止申請状態 0: 却下 1: 承認 2: 申請中 |
int |
使用例
リクエスト例
{
"user_id": "sample@robotpayment.co.jp",
"access_key": "xxxxxxxxxxxxxxxx",
"marunage_credit": [
{
"billing_code": "billing_code_001",
"reason": "取引がなくなった請求先の為"
},
{
"billing_code": "billing_code_002",
"reason": "取引がなくなった請求先の為"
}
]
}
レスポンス例
Status: 200 OK
{
"user_id": "sample@robotpayment.co.jp",
"marunage_credit": [
{
"error_code": null,
"error_message": null,
"billing_code": "billing_code_001",
"reason": "取引がなくなった請求先の為",
"status": 2
},
{
"error_code": null,
"error_message": null,
"billing_code": "billing_code_002",
"reason": "取引がなくなった請求先の為",
"status": 2
}
]
}
エラー
個別エラー
| エラーコード | 内容 |
|---|---|
| 5501 | 請求先が存在しません |
| 5502 | 請求先コードが不正 |
| 5503 | 対象の与信が有効でない為停止申請できません |
| 5505 | 同じ請求先に対して2件以上のリクエストはできません |
| 5506 | リクエストパラメータに与信オブジェクトが存在しない |
| 5507 | 他の与信停止申請に失敗しました |
| 5508 | 停止理由が不正 |