キャンセル – CREATE
キャンセルオブジェクトに対するCREATEリクエストには以下が必要です。（括弧内は入力箇所）awaiting もしくは authorized 状態の課金に対してキャンセルを作成することができます。
- 店舗ID（URLの
{storeId}部分） - 課金ID（URLの
{chargeId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request POST \
--url https://api.univapay.com/stores/{storeId}/charges/{chargeId}/cancels \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド名 | データ型 | 備考 |
|---|---|---|
| metadata | json | キャンセルに紐付けるメタデータ |
Bodyの記述例
curl --request POST \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/charges/11ef32c2-eecd-ed24-abb8-cf4e336a1340/cancels \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'
--data '{"metadata": {"order_id": 1234}}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
201 - Header:
Content-Type: application/json
Body
{
"id": "11ef32cc-e895-655e-8e33-e36629277b4f",
"charge_id": "11ef32c2-eecd-ed24-abb8-cf4e336a1340",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"status": "pending",
"error": null,
"metadata": {
"order_id": 1234
},
"mode": "test",
"created_on": "2024-06-25T08:28:32.859366Z"
}