ウェブフック – UPDATE
ウェブフックオブジェクトに対するUPDATEリクエストには以下が必要です。（括弧内は入力箇所）
通知失敗などによって停止したウェブフックを再開処理する場合はこのリクエストをご利用ください。
店舗を指定したウェブフック情報を取得する場合 merchants/{merchantId} は省略可能です。
- 加盟店ID（URLの
{merchantId}部分） - 店舗ID（URLの
{storeId}部分） - ウェブフックID（URLの
{webhookId}部分） - シークレット（Headerの
{secret}部分） - アプリトークン（Headerの
{jwt}部分）
リクエスト
CommandとHeader
curl --request PATCH \
--url https://api.univapay.com/merchants/{merchantId}/stores/{storeId}/webhooks/{wenbhookId} \
--header 'Authorization: Bearer {secret}.{jwt}'
--header 'Content-type: application/json'利用できるパラメータ
リクエストのbodyに含めることができるパラメータは以下です。
| フィールド | データ型 | 備考 |
|---|---|---|
| active | boolean | ウェブフックのステータスtrueもしくはfalse |
| url | string | ウェブフック通知先のURL |
| triggers | string | イベントのトリガー 詳細はこちら |
| auth_token | string | Authorizationヘッダー |
Bodyの記述例
curl --request PATCH \
--url https://api.univapay.com/stores/11edf541-c42d-653c-8c3d-dfe0a55f95c0/webhooks/11ef1809-ad25-f160-9093-4f3cee241eb0 \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \
--data '{"active": "false"}'レスポンス
下記はBodyの記述例でリクエストした場合の例です。
CodeとHeader
- Code:
200 - Header:
Content-Type: application/json
Body
{
"id": "11ef1809-ad25-f160-9093-4f3cee241eb0",
"platform_id": "11e7a7eb-0ef8-b0c6-bd54-f7a2646e6c47",
"merchant_id": "11edf541-548f-ad70-8bc2-d34ca468c664",
"store_id": "11edf541-c42d-653c-8c3d-dfe0a55f95c0",
"triggers": [
"charge_finished",
"refund_finished"
],
"url": "https://webhook.URL/",
"active": false,
"created_on": "2024-05-22T07:05:31.049021Z",
"updated_on": "2024-06-25T09:41:56.235574Z"
}