キャンセル – UPDATE
キャンセルオブジェクトに対するUPDATEリクエストには以下が必要です。（括弧内は入力箇所）
キャンセルした時に付与したメタデータを編集することができます。
- 店舗ID（URLの
{storeId}部分） - 課金ID（URLの
{chargeId}部分） - キャンセルされた課金ID（URLの
{id}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Header
{jwt}部分）
リクエスト
CommandとHeader
curl --request PATCH \
--url https://api.univapay.com/stores/{storeId}/charges/{chargeId}/cancels/{id} \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド名 | データ型 | 備考 |
|---|---|---|
| metadata | json | キャンセルに紐付けるメタデータ |
Bodyの記述例
curl --request PATCH \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/charges/11ef32ce-c739-9e0a-9ada-37dba0724131/cancels/11ef32ce-ce90-3272-9ec3-c35d8985dfc2 \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'
--data '{"metadata": {"order_id": 1234, "reason": "expired"}}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"id": "11ef32ce-ce90-3272-9ec3-c35d8985dfc2",
"charge_id": "11ef32ce-c739-9e0a-9ada-37dba0724131",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"status": "successful",
"error": null,
"metadata": {
"reason": "expired",
"order_id": 1234
},
"mode": "test",
"created_on": "2024-06-25T08:42:08.198036Z"
}