Logoelepay
Charge

List charges

決済に関する情報を一覧で取得します。

GET
/charges

Authorization

AuthorizationBearer <token>

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

In: header

Query Parameters

paymentMethod?array<PaymentMethodType>

決済方法(複数の指定が可能です)

from?integer

開始時間（UTC）。指定した時間以降に作成されたデータを取得します。

Formatint64
to?integer

終了時間（UTC）。指定した時間以前に作成されたデータを取得します

Formatint64
dateField?string

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

  • paid_time 払う時間
  • create_time 決済新規時間
Default"create_time"
Value in"paid_time" | "create_time"
status?string

支払状況

Value in"pending" | "waiting" | "notified" | "uncaptured" | "captured" | "partially_refunded" | "refunded" | "amount_mismatch" | "revoked" | "failed"
limit?integer

最大件数

Default20
Rangevalue <= 100
offset?integer

検索開始位置

Default0
sort?string

ソート項目

  • paid_time 払う時間
  • create_time 決済新規時間
Default"create_time"
Value in"paid_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/charges"
{
  "total": 0,
  "charges": [
    {
      "id": "string",
      "appId": "string",
      "object": "charge",
      "liveMode": true,
      "amount": 0,
      "authorizeAmount": 0,
      "currency": "JPY",
      "authorize": true,
      "paymentMethod": "alipay",
      "resource": "web",
      "orderNo": "string",
      "description": "string",
      "extra": {
        "property1": "string",
        "property2": "string"
      },
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "cardInfo": {
        "brand": "string",
        "last4": "string",
        "expMonth": 0,
        "expYear": 0,
        "name": "string",
        "wallet": "string",
        "walletApp": "string",
        "repaymentType": "string",
        "approvalCode": "string",
        "threeDSecure": true,
        "threeDSecureVersion": "string",
        "threeDSecureDetail": "string",
        "businessType": "string",
        "konbiniScanTime": 0,
        "konbiniType": "string",
        "receivedAmount": 0,
        "receivedTime": 0,
        "bankUserCode": "string",
        "bankUserName": "string",
        "bankName": "string",
        "bankBranchName": "string",
        "bankAccountNo": "string"
      },
      "voucherNo": "string",
      "clientIp": "string",
      "paid": true,
      "refunded": true,
      "disputed": true,
      "refunds": {
        "amount": 0,
        "totalCount": 0,
        "data": [
          {
            "id": "string",
            "object": "refund",
            "chargeId": "string",
            "liveMode": true,
            "amount": 0,
            "currency": "string",
            "metadata": {
              "property1": "string",
              "property2": "string"
            },
            "reason": "string",
            "status": "pending",
            "refundedTime": 0,
            "createTime": 0
          }
        ]
      },
      "status": "pending",
      "codeContent": "string",
      "credential": "string",
      "paidTime": 0,
      "refundTime": 0,
      "expiryTime": 0,
      "settleTime": 0,
      "createTime": 0
    }
  ]
}