課金 – LIST
課金オブジェクトのLISTリクエストには以下が必要です。（括弧内は入力箇所）
リクエストURLにクエリパラメータを追加することで、表示するリソースを絞り込むこともできます。
課金・返金などをまとめて表示させたい場合はトランザクション:Listを推奨します。
- 店舗ID（URLの
{storeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/charges \
--header 'Authorization: Bearer {secret}.{jwt}'すべての店舗を表示する場合
curl --request GET \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| 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) | この日付より前に作成された課金を表示 |
| 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でフィルタリング |
記述例
curl --request GET \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/charges \
--header 'Authorization: Bearer {secret}.{jwt}'すべての店舗を表示する場合
curl --request GET \
--url https://api.univapay.com/charges \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記は記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"items": [
{
"id": "11ef32c4-9ea8-169c-a6c8-bfc29867a226",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"transaction_token_id": "11ef32c4-9e89-0cac-bd63-17b9a26af61b",
"transaction_token_type": "one_time",
"subscription_id": null,
"merchant_transaction_id": null,
"requested_amount": 1000,
"requested_currency": "JPY",
"requested_amount_formatted": 1000,
"charged_amount": 1000,
"charged_currency": "JPY",
"charged_amount_formatted": 1000,
"fee_amount": null,
"fee_currency": null,
"fee_amount_formatted": null,
"only_direct_currency": false,
"capture_at": null,
"descriptor": null,
"descriptor_phone_number": null,
"status": "successful",
"error": null,
"metadata": {
"univapay-name": "taro yamada",
"univapay-phone-number": 8029854583
},
"mode": "test",
"created_on": "2024-06-25T07:29:12.854865Z",
"redirect": {},
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗"
},
{
"id": "11ef32c3-3cfe-3bc0-abed-0bb96f792078",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"transaction_token_id": "11ef32c3-3cdd-df92-9dce-c346b9fdf088",
"transaction_token_type": "one_time",
"subscription_id": null,
"merchant_transaction_id": null,
"requested_amount": 1000,
"requested_currency": "JPY",
"requested_amount_formatted": 1000,
"charged_amount": 1000,
"charged_currency": "JPY",
"charged_amount_formatted": 1000,
"fee_amount": null,
"fee_currency": null,
"fee_amount_formatted": null,
"only_direct_currency": false,
"capture_at": null,
"descriptor": null,
"descriptor_phone_number": null,
"status": "successful",
"error": null,
"metadata": {},
"mode": "test",
"created_on": "2024-06-25T07:19:19.507637Z",
"redirect": {
"shipping_details": "Customer wants it now",
"order_id": 12345
},
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗"
},
＜中略＞
],
"has_more": true,
"total_hits": 99
}