billing-robo-apispec

API一覧

開発中のAPI一覧

非推奨のAPI一覧

Webhook一覧

注釈

種別

種別 入力可能値
メール形式 正規表現 : /^([a-z0-9\+_\-]+)(\.[a-z0-9\+_\-]+)*@([a-z0-9\-]+\.)+[a-z]+$/ix
(例) robot_payment@example.com
アルファベット ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
半角英数 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
半角英数 + 記号 ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
口座名義 半角英数 + 半角カタカナ + ,.()\/「」-
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789ヲァィゥェォャュョッ-アイウエオカキクケコサシスセソタチツテトナニヌネノハヒツヘホマミムメモヤユヨラリルレロワンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポ,. )(\/「」-
口座名義(RP口座振替) 半角英数 + 半角カタカナ + ().-/
(RP口座振替)口座名義使用可能文字について
銀行名等 半角英数(半角英小文字除く) + 半角カタカナ
ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789ヲァィゥェォャュョッ-アイウエオカキクケコサシスセソタチツテトナニヌネノハヒツヘホマミムメモヤユヨラリルレロワンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポ
日付形式 正規表現 : @^([0-9]{4}(-|/)(0?[1-9]|1[012])(-|/)(0?[1-9]|[12][0-9]|3[01]))$@
(例) 2020-01-01 または 2020/01/01 など

決済手段

数値 決済手段名
0 銀行振込
1 クレジットカード
2 バンクチェック
3 RP口座振替
4 RL口座振替
5 その他口座振替
6 コンビニ払込票(A4)
7 コンビニ払込票(ハガキ)
8 その他コンビニ払込票
9 バーチャル口座
10 その他決済1
11 その他決済2
12 その他決済3
13 その他決済4
14 その他決済5

消込手段

数値 消込手段名
0 銀行振込
1 クレジットカード
2 バンクチェック
3 RP口座振替
4 RL口座振替
5 その他口座振替
6 コンビニ払込票(A4)
7 コンビニ払込票(ハガキ)
8 その他コンビニ払込票
9 バーチャル口座
10 その他決済手段1
11 その他決済手段2
12 その他決済手段3
13 その他決済手段4
14 その他決済手段5
98 相殺
101 貸倒
102 確認済み
103 手数料
104 請求書明細相殺
106 現金
107 長期滞留債権
108 破産更生等債権
109 売上取消
110 繰越
201 入金確認済み

必須

種別 説明
必須 全てのリクエストに対して必要
(追加時) 登録・更新両方ができるAPIに存在し、追加時のリクエストに対して必要
(更新時) 登録・更新両方ができるAPIに存在し、更新時のリクエストに対して必要
({条件})^n {条件}時に、同じnの必須条件があるパラメータのなかでいずれかが必要

共通エラー

APIによる操作が失敗した場合、サーバは可能な限りエラーについての情報を application/json 形式でレスポンスします。その際、HTTPステータスは 400 Bad Request が使われます。ログインIDやアクセスキー、接続IPに不正があった場合は、HTTPステータスは、 401 Unauthorized が使われます。メンテナンス中の場合は、HTTPステータスは、 503 Service Unavailable で返却します。

エラー情報のレスポンスができないケースの例

エラーコード

エラーコード 内容
1 内部エラー
10 不明なURI
11 ログインIDが不正
12 アクセスキーが不正
13 接続IPが不正
14 店舗IDが不正
15 外部システムとの連携に失敗
16 ログイン失敗
17 権限が不正
18 利用企業が不正
19 メンテナンス中
20 リクエスト数が不正

レスポンス例

{
    "error": {
        "code": 11,
        "message": "Invalid 'user_id'."
    }
}

決済システムエラーコード

決済システムエラーコード一覧

その他の特殊なエラーコード

エラーコード 内容
21 まるなげ請求書編集不可

推奨SSL/TLSバージョン

請求管理ロボAPIを、正常かつ快適にご利用いただくために、以下を推奨しております。

TLS 1.2

SSL/TLSバージョンをご確認いただき、推奨バージョンでのご利用をお願いいたします。


改訂履歴