トランザクショントークン: List

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

Request

GET https://api.univapay.com/stores/{storeId}/tokens
すべての店舗を表示
GET https://api.univapay.com/tokens

Parameters:

Parameters
fromstring (ISO-8601)
この日付以降に作成されたトランザクショントークンを表示する

例）2024年1月23日の場合
2024-01-23T00:00:00Z
tostring (ISO-8601)
この日付より前に作成されたトランザクショントークンを表示する

例）2024年1月23日の場合
2024-01-23T00:00:00Z
idstring (UUID)
トランザクショントークンID
short_idstring
トランザクショントークンの下6桁
typestring
recurring か subscriptionでトランザクショントークンの種類をフィルタリングする
emailstring
メールアドレスでフィルタリングする
cardholderstring
トランザクショントークンに登録されたカード名義でフィルタリングする
※決済方法がクレジットの場合のみ利用できます
card_expnumber
 yyyy-MMの形式でカードの有効期限でフィルタリングする 例：2024-01
※決済方法がクレジットの場合のみ利用できます
card_last_fournumber
カード番号の下4桁でフィルタリングする
※決済方法がクレジットの場合のみ利用できます
phone_numbernumber
電話番号でフィルタリングする
brandstring
決済事業者のブランドでフィルタリングする
例： visa, alipay_china, pay_pay_mpm, seven_eleven, we_chat_online, aozora_bank 等
customer_idstring (UUID)
`univapay-customer-id`を利用して登録されたカスタマーIDのメタデータでフィルタリングする
modestring
モードでフィルタリングする。 live または test
metadatastring
メタデータでフィルタリングする

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api.univapay.com/stores/af857264-180c-11e7-9be2-276aea4fed28/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'
全ての店舗のトランザクショントークンを表示
curl --request GET \
--url https://api.univapay.com/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "11eeb430-ac66-575c-af2d-bbca651dd414",
      "merchant_id": "11e746a0-d62d-7174-a46d-538bfebf4322",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "email": "token@univapay.com",
      "payment_type": "card",
      "active": true,
      "mode": "test",
      "type": "recurring",
      "metadata": {},
      "created_on": "2024-01-16T05:32:43.886685Z",
      "updated_on": "2024-01-16T05:32:43.886685Z",
      "last_used_on": null,
      "merchant_name": "サンプルショップ",
      "store_name": "test store",
      "user_data": {
        "cardholder_name": "test test",
        "brand": "visa",
        "gateway": null,
        "service_provider": null
      }
    },
    {
      "id": "11eeb42f-f08c-0e14-b72f-bf4af680988d",
      "merchant_id": "11e746a0-d62d-7174-a46d-538bfebf4322",
      "store_id": "af857264-180c-11e7-9be2-276aea4fed28",
      "email": "token@univapay.com",
      "payment_type": "card",
      "active": true,
      "mode": "test",
      "type": "subscription",
      "metadata": {},
      "created_on": "2024-01-16T05:27:28.723026Z",
      "updated_on": "2024-01-16T05:27:33.627696Z",
      "last_used_on": "2024-01-16T05:27:33.665821Z",
      "merchant_name": "サンプルショップ",
      "store_name": "test store",
      "user_data": {
        "cardholder_name": "takahiro nasu",
        "brand": "visa",
        "gateway": null,
        "service_provider": null
      }
    }
  ],
  "has_more": false
}