トランザクショントークン – LIST
トランザクショントークンオブジェクトに対するLISTリクエストには以下が必要です。（括弧内は入力箇所）
リクエストURLにクエリパラメータを追加することで、表示するリソースを絞り込むこともできます。
課金 / 返金などをまとめて表示させたい場合はトランザクション:Listを推奨します。
- 店舗ID（URLの
{storeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'すべての店舗を表示
curl --request GET \
--url https://api.univapay.com/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| from | string (ISO-8601) | 指定した日付以降に作成されたトランザクショントークンを表示 例： 2024-01-23T00:00:00Z |
| to | string (ISO-8601) | 指定した日付以前に作成されたトランザクショントークンを表示 例： 2024-01-23T00:00:00Z |
| id | string (UUID) | トランザクショントークンID |
| short_id | string | トランザクショントークンの下6桁 |
| type | string | トランザクショントークンの種類をフィルタリングrecurring,subscriptionのいずれか |
| string | メールアドレスでフィルタリング | |
| cardholder | string | トランザクショントークンに登録されたカード名義でフィルタリング ※決済方法がクレジットの場合のみ利用可能 |
| card_exp | number | yyyy-MMの形式でカードの有効期限でフィルタリング例：2024-01 ※決済方法がクレジットの場合のみ利用可能 |
| card_last_four | number | カード番号の下4桁でフィルタリング ※決済方法がクレジットの場合のみ利用可能 |
| phone_number | number | 電話番号でフィルタリング |
| brand | string | 決済事業者のブランドでフィルタリング 例： visa, alipay_china, pay_pay_mpm, seven_eleven, we_chat_online, aozora_bank 等 |
| customer_id | string (UUID) | `univapay-customer-id`を利用して登録されたカスタマーIDのメタデータでフィルタリング |
| mode | string | モードでフィルタリングするliveまたはtest |
| metadata | string | メタデータでフィルタリング |
Bodyの記述例
curl --request GET \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'全ての店舗のトランザクショントークンを表示
curl --request GET \
--url https://api.univapay.com/tokens \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"items": [
{
"id": "11ef32a7-3a71-8662-803f-1bc27702eeec",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"email": "test@test.com",
"payment_type": "card",
"active": true,
"mode": "test",
"type": "recurring",
"usage_limit": null,
"confirmed": null,
"metadata": {},
"created_on": "2024-06-25T03:58:49.321896Z",
"updated_on": "2024-06-25T03:58:49.321896Z",
"last_used_on": null,
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗",
"user_data": {
"cardholder_name": "taro yamada",
"email": "test@test.com",
"brand": "visa",
"gateway": null,
"service_provider": null
}
},
{
"id": "11ef2f91-5611-1c20-8699-273823d9185d",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"email": "demo@demo.com",
"payment_type": "card",
"active": true,
"mode": "test",
"type": "recurring",
"usage_limit": null,
"confirmed": null,
"metadata": {},
"created_on": "2024-06-21T05:44:33.249892Z",
"updated_on": "2024-06-24T07:02:18.28909Z",
"last_used_on": "2024-06-24T07:02:18.067656Z",
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗",
"user_data": {
"cardholder_name": "hanako yamada",
"email": "demo@demo.com",
"brand": "visa",
"gateway": null,
"service_provider": null
}
},
＜中略＞
],
"has_more": true,
"total_hits": 99
}