定期課金 – 課金 – LIST
定期課金オブジェクトに対する課金LISTリクエストには以下が必要です。（括弧内は入力箇所）
課金のデータモデルの詳細は課金オブジェクトを参照してください。
- 店舗ID（URLの
{storeId}部分） - 定期課金ID（URLの
{subscriptionId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/subscriptions/{subscriptionId}/charges \
--header 'Authorization: Bearer {secret}.{jwt}'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
全てがand条件で検索され、リストが作成されます。
| フィールド | データ型 | 備考 |
|---|---|---|
| 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も含める必要あり |
| card_number | number | クレジットカード番号でフィルタリングする |
| from | string (ISO-8601) | この日付以降に作成された課金を表示する |
| to | string (ISO-8601) | この日付より前に作成された課金を表示する |
| string | メールアドレスでフィルタリングする | |
| phone | string | 電話番号でフィルタリングする |
| 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/23f45c5e-18ef-11e7-96ee-d756c0178178/subscriptions/25d0fb2c-18ef-11e7-9dd3-db8fb7b820e7/charges \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記は記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"items": [
{
"id": "26f9059e-18ef-11e7-a74f-173cf0f9475a",
"store_id": "23f45c5e-18ef-11e7-96ee-d756c0178178",
"transaction_token_id": "259e9240-18ef-11e7-94da-97e85c2e269c",
"requested_amount": 483200,
"requested_currency": "EUR",
"requested_amount_formatted": 4832,
"charged_amount": 483200,
"charged_currency": "EUR",
"charged_amount_formatted": 4832,
"status": "successful",
"error": null,
"metadata": {},
"mode": "test",
"created_on": "2018-07-13T02:55:00.07367Z"
},
{
"id": "270858e6-18ef-11e7-adfa-6ff75ea1c202",
"store_id": "23f45c5e-18ef-11e7-96ee-d756c0178178",
"transaction_token_id": "259f4a8c-18ef-11e7-b8fe-17e053dc5c54",
"requested_amount": 2491,
"requested_currency": "JPY",
"requested_amount_formatted": 2491,
"charged_amount": 2491,
"charged_currency": "JPY",
"charged_amount_formatted": 2491,
"status": "successful",
"error": null,
"metadata": {},
"mode": "test",
"created_on": "2018-07-13T02:55:00.07367Z"
}
],
"has_more": false
}