課金: List

このリクエストでは、アプリトークン・シークレット・店舗IDを指定することで、店舗で行われた課金の一覧を取得することができます。
Parametersから条件を指定することで表示するリソースを絞り込むこともできます。
課金・返金などをまとめて表示させたい場合はトランザクション:Listを推奨します。

Request

GET https://api.univapay.com/stores/{storeId}/charges

すべての店舗を表示

GET https://api.univapay.com/charges

Parameters:

Parameters
last_four	number 使用したクレジットカードの下4桁でフィルタリングする。指定する場合は、`name`, `exp_month`, `exp_year` パラメータも含める必要があります
name	string カード所有者の名前でフィルタリングする。指定する場合は、`last_four`, `exp_month`, `exp_year` パラメータも含める必要があります
exp_month	number 使用したカードの有効期限（月）でフィルタリングする。指定する場合は、 `last_four`, `name`, `exp_year` パラメータも含める必要があります
exp_year	number 使用したカードの有効期限（年）でフィルタリングする。指定する場合は、`last_four`, `name`, `exp_month` パラメータも含める必要があります
from	string (ISO-8601) この日付以降に作成された課金を表示する
to	string (ISO-8601) この日付より前に作成された課金を表示する
email	string メールアドレスでフィルタリングする
phone	number 電話番号でフィルタリングする
amount_from	number この金額より大きい課金を表示する
amount_to	number この金額未満の課金を表示する
currency	string (ISO-4217) この通貨でリクエストまたはチャージされた課金をフィルタリングする
mode	string モードでフィルタリングする。 `live` または `test`
metadata	string メタデータでフィルタリングする
transaction_token_id	string (UUID) トランザクショントークンIDでフィルタリングする

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api.univapay.com/stores/af857264-180c-11e7-9be2-276aea4fed28/charges \
--header 'Authorization: Bearer {secret}.{jwt}'

List charges for all stores

curl --request GET \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: `200`

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "a29db148-1851-11e7-9b58-4b8e9d783793",
      "merchant_id": "11d92832-180a-11e7-834d-c3c52381fce7",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "transaction_token_id": "9c3b37f8-1851-11e7-9b58-8b8ddbe8f1d1",
      "requested_amount": 1000,
      "requested_currency": "JPY",
      "requested_amount_formatted": 1000,
      "charged_amount": 1000,
      "charged_currency": "JPY",
      "charged_amount_formatted": 1000,
      "status": "successful",
      "error": null,
      "metadata": {
        "order_id": 12345,
        "shipping_details": "Customer wants it now"
      },
      "mode": "test",
      "created_on": "2018-07-13T02:55:00.07367Z"
    },
    {
      "id": "ae40db48-1855-11e7-bca5-9754449c2401",
      "merchant_id": "b59155a8-1855-11e7-bca5-cf16c088c7f2",
      "store_id": "bb866962-1855-11e7-bca5-e3dde845a0df",
      "transaction_token_id": "bb866962-1855-11e7-bca5-e3dde845a0df",
      "requested_amount": 1000,
      "requested_currency": "JPY",
      "requested_amount_formatted": 1000,
      "charged_amount": 1000,
      "charged_currency": "JPY",
      "charged_amount_formatted": 1000,
      "status": "successful",
      "error": null,
      "metadata": {
        "order_id": 12345,
        "shipping_details": "Customer wants it now"
      },
      "mode": "test",
      "created_on": "2018-07-13T02:55:00.07367Z"
    }
  ],
  "has_more": false
}

課金: List

Request

すべての店舗を表示

Parameters:

Headers:

Body:

List charges for all stores

Response

Code: 200

Headers:

Body:

Code: `200`