返金 – CREATE
返金オブジェクトに対するCREATEリクエストには以下が必要です。（括弧内は入力箇所）
- 店舗ID（URLの
{storeId}部分） - 課金ID（URLの
{chargeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request POST \
--url https://api.univapay.com/stores/{storeId}/charges/{chargeId}/refunds \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド 赤字は必須 ※は条件付き必須 | データ型 | 備考 |
|---|---|---|
| amount | number | 課金金額以下の返金金額 |
| currency | string (ISO-4217) | ISO 4217の通貨コードで指定 |
| reason | string | 返金理由fraud, duplicate, customer_requestのいずれか |
| message | string | 返金の詳細理由 |
| metadata | json | 自由に設定可能 詳細はメタデータを参照 |
Bodyの記述例
curl --request POST \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/charges/11ef32c3-3cfe-3bc0-abed-0bb96f792078/refunds \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \
--data '{
"amount": 250,
"currency": "JPY",
"reason": "customer_request",
"message": "15 percent off",
"metadata": {
"coupon": "VIP007"
}
}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
201 - Header:
Content-Type: application/json
Body
{
"id": "11ef32c8-c721-823a-ba45-77212da778fa",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"charge_id": "11ef32c3-3cfe-3bc0-abed-0bb96f792078",
"status": "pending",
"amount": 250,
"currency": "JPY",
"amount_formatted": 250,
"reason": "customer_request",
"message": "15 percent off",
"error": null,
"metadata": {
"coupon": "VIP007"
},
"mode": "test",
"created_on": "2024-06-25T07:58:58.748326Z"
}