トランザクション – LIST
トランザクションオブジェクトに対するLISTリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/transaction_history \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'すべての店舗を表示する
curl --request GET \
--url https://api.univapay.com/transaction_history \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
全てがand条件で検索され、リストが作成されます。
| フィールド | データ型 | 備考 |
|---|---|---|
| from | string (ISO-8601) | 指定された日時以降でフィルタリングする 例：2024年1月23日の場合 2024-01-23T00:00:00Z |
| to | string (ISO-8601) | 指定された日時以前でフィルタリングする 例：2024年1月23日の場合 2024-01-23T00:00:00Z |
| search | string | 課金ID, 返金ID, メタデータの情報、カード名義人名、カード名義人メールアドレス、カード番号下４桁のいずれかでフィルタリングする |
| type | string | charge,refundのいずれか |
| status | string | 状態でフィルタリングする 課金もしくは返金の状態のいずれか |
| mode | string | 実行モードでフィルタリングするliveまたはtest |
記述例
curl --request GET \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/transaction_history?from=2024-06-01T00:00:00Z&to=2024-06-25T00:00:00Z \
--header 'Authorization: Bearer {secret}.{jwt}'すべての店舗を表示する
curl --request GET \
--url https://api.univapay.com/transaction_history?from=2024-06-01T00:00:00Z&to=2024-06-25T00:00:00Z \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記は記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"items": [
{
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"resource_id": "11ef327b-f037-10ce-b891-9b43076af963",
"charge_id": null,
"amount": 100,
"currency": "JPY",
"amount_formatted": 100,
"type": "charge",
"status": "successful",
"metadata": {},
"created_on": "2024-06-24T22:48:56.42805Z",
"mode": "test",
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗",
"payment_type": "card",
"user_data": {
"type": "charge",
"cardholder_name": "taro yamada",
"cardholder_email_address": "test@test.com",
"brand": "visa",
"gateway": "test",
"service_provider": "test",
"refunds": []
},
"bank_transfer_payment_status": null,
"bank_transfer_latest_deposit_date": null
},
{
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"resource_id": "11ef327b-efeb-2efc-adc5-ff26c8964860",
"charge_id": null,
"amount": 100,
"currency": "JPY",
"amount_formatted": 100,
"type": "charge",
"status": "successful",
"metadata": {},
"created_on": "2024-06-24T22:48:55.930755Z",
"mode": "test",
"merchant_name": "管理画面ガイド",
"store_name": "管理画面ガイド_TEST店舗",
"payment_type": "card",
"user_data": {
"type": "charge",
"cardholder_name": "hanako yamada",
"cardholder_email_address": "demo@demo.com",
"brand": "master",
"gateway": "test",
"service_provider": "test",
"refunds": []
},
"bank_transfer_payment_status": null,
"bank_transfer_latest_deposit_date": null
},
＜中略＞
],
"has_more": true,
"total_hits": 99
}