Logoelepay
Dispute

List disputes

不審請求情報を一覧で取得します

GET
/disputes

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。 秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Query Parameters

chargeId?string

Charge ID

from?integer

開始時間（エポックミリ秒）、指定した時間以降に作成されたデータを取得します

Formatint64
to?integer

終了時間（エポックミリ秒）、指定した時間以前に作成されたデータを取得します

Formatint64
dateField?string

開始時間と終了時間の項目を指定します。

  • resolved_time 不審請求解決時間
  • create_time 不審請求発生時間
Default"create_time"
Value in"resolved_time" | "create_time"
status?string

不審請求ステータス

Value in"new" | "won" | "lost"
limit?integer

最大件数

Default20
Rangevalue <= 100
offset?integer

検索開始位置

Default0
sort?string

ソート項目

  • resolved_time 不審請求解決時間
  • create_time 決済新規時間
Default"create_time"
Value in"resolved_time" | "create_time"
order?string

ソート順

  • desc 降順
  • asc 昇順
Default"desc"
Value in"desc" | "asc"

Response Body

application/json;charset=utf-8

curl -X GET "https://api.elepay.io/disputes"
{
  "total": 0,
  "disputes": [
    {
      "id": "string",
      "object": "dispute",
      "chargeId": "string",
      "liveMode": true,
      "amount": 0,
      "currency": "str",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "reason": "string",
      "status": "new",
      "resolvedTime": 0,
      "createTime": 0
    }
  ]
}