課金 – GET
課金オブジェクトに対するGETリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - 課金ID（URLの
{chargeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request GET \
--url https://api.univapay.com/stores/{storeId}/charges/{chargeId} \
--header 'Authorization: Bearer {secret}.{jwt}'利用できるパラメータ
リクエストURLに追加できるクエリパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| polling | boolean | 値をtrueと指定することで、ステータスが pending（初期ステータス）から別のステータスに変更されるまで、課金のステータスを内部でポーリングするようにAPIに指示する詳細はこちら |
記述例
curl --request GET \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/charges/11ef32c2-4010-a312-aaff-4b63e4d5f92d \
--header 'Authorization: Bearer {secret}.{jwt}'レスポンス
下記は記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"id": "11ef32c2-4010-a312-aaff-4b63e4d5f92d",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"transaction_token_id": "11ef32a7-3a71-8662-803f-1bc27702eeec",
"transaction_token_type": "recurring",
"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": {
"shipping_details": "Customer wants it now",
"order_id": 12345
},
"mode": "test",
"created_on": "2024-06-25T07:12:15.16452Z",
"redirect": {
"endpoint": "https://test.url/",
"redirect_id": "11ef32c2-40cf-f772-8325-1798abb1110d"
}
}