> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paymentoptions.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhookレスポンスサンプル

> Payment Options Gatewayから送信されるWebhook通知のサンプルを紹介します。対応する決済方法における取引ステータス、決済情報、加盟店情報、ゲートウェイレスポンスコードを確認できます。

## 概要

Payment Options Gatewayは、取引イベントが発生すると、加盟店が設定した `webhook_url` にWebhook通知を送信します。

これらの通知には、取引ステータス、決済情報、加盟店情報、ゲートウェイレスポンスコードが含まれ、加盟店は決済結果を確認し、システムを適切に更新できます。

Webhook通知は、購入、売上確定、返金など、対応するさまざまな決済方法や取引タイプに対して送信される場合があります。

## 主なポイント

> [!NOTE]
>
> **Webhook通知**
>
> * Webhook通知は、決済リクエストで設定された `webhook_url` に送信されます。
> * `success` フィールドは、通知された取引イベントが成功したかどうかを示します。
> * `gateway_response` オブジェクトには、ゲートウェイのレスポンスコード、タイプ、メッセージが含まれます。
> * `payment_details` オブジェクトには決済関連情報が含まれ、その内容は決済方法によって異なる場合があります。
> * `merchant_details` および `transaction_details` オブジェクトには、加盟店および取引の識別情報が含まれます。
>
> **取引の確認**
>
> * 決済開始時のレスポンスは、必ずしも取引の完了を意味しません。
> * 加盟店は決済記録を更新する前に、Webhook通知を検証し、取引ステータスを確認する必要があります。
> * Webhookのフィールドおよび値は、決済方法、取引タイプ、処理結果によって異なる場合があります。

## Webhookレスポンスサンプル

以下は、PayNowを使用した決済成功時のWebhook通知の一例です。レスポンス構造や決済方法固有のフィールドは、取引タイプや決済方法によって異なる場合があります。

```json theme={null}
{
  "is_live": false,
  "success": true,
  "status_code": 200,
  "risk-details": {},
  "payment_details": {
    "card": {
      "name": "",
      "number": "",
      "exp_year": "",
      "exp_month": ""
    },
    "amount": 200,
    "scheme": "",
    "currency": "SGD",
    "auth_code": null,
    "response_code": 0,
    "payment_method": "",
    "additional_data": {
      "payment_data_source": {
        "type": "paynow"
      }
    }
  },
  "gateway_response": {
    "code": "INFO0000",
    "type": "INFO",
    "message": "Payment Successful.",
    "version": "1"
  },
  "merchant_details": {
    "mid": "SG00003085",
    "legal_name": "Merchant Name Pte. Ltd.",
    "device_details": {
      "visited_ip": "",
      "customer_ip": "",
      "merchant_ip": ""
    },
    "billing_details": {
      "billing_address": {
        "city": "Minatoku",
        "email": "customer@example.com",
        "phone": "767676767",
        "state": "Tokyoto",
        "country": "JP",
        "address1": "Chiyoda1-1",
        "postal_code": "1000001",
        "phone_number": "767676767"
      },
      "shipping_address": {
        "city": "Minatoku",
        "email": "customer@example.com",
        "phone": "08012341234",
        "state": "Tokyoto",
        "country": "JP",
        "address1": "Chiyoda1-1",
        "postal_code": "1000001",
        "phone_number": "08012341234"
      }
    },
    "merchant_txn_ref": "TEST00989012878787878787878787"
  },
  "transaction_type": "CAPTURE",
  "transaction_details": {
    "id": "54ba5a90-fdb6-4bed-8af1-9df9e033dec4",
    "ref": 353409,
    "notes": "",
    "timestamp": "2026-10-19T05:13:45.000Z",
    "merchant_txn_ref": "TEST00989012878787878787878787",
    "stored_payment_method_id": "******"
  }
}
```

## レスポンス属性

| **属性** | **説明** |
| :- | :- |
| `is_live` | 取引が本番環境で処理されたかどうかを示します。 |
| `success` | 通知された取引イベントが成功したかどうかを示します。 |
| `status_code` | Webhookペイロードに含まれるステータスコードです。 |
| `risk-details` | 取引に関連するリスク情報を含みます。 |
| `payment_details` | 決済金額、通貨、決済方法に関する情報を含みます。 |
| `payment_details.card` | 該当する場合、カード関連情報を含みます。 |
| `payment_details.amount` | 取引金額です。 |
| `payment_details.currency` | 取引の処理通貨です。 |
| `payment_details.response_code` | 通知に含まれる決済レスポンスコードです。 |
| `payment_details.additional_data` | 利用可能な場合、追加の決済関連情報を含みます。 |
| `payment_details.additional_data.payment_data_source.type` | `paynow` などの使用された決済方法を識別します。 |
| `gateway_response` | ゲートウェイのレスポンス情報を含みます。 |
| `gateway_response.code` | `INFO0000` などのゲートウェイレスポンスコードです。 |
| `gateway_response.type` | ゲートウェイレスポンスの分類です。 |
| `gateway_response.message` | `Payment Successful.` などのゲートウェイレスポンスメッセージです。 |
| `merchant_details` | 加盟店の識別情報および顧客情報を含みます。 |
| `merchant_details.mid` | 加盟店ID（DASMID）です。 |
| `merchant_details.legal_name` | 加盟店の登録法人名です。 |
| `merchant_details.device_details` | 利用可能な場合、デバイス情報およびIPアドレス情報を含みます。 |
| `merchant_details.billing_details` | 顧客の請求先住所および配送先住所の情報を含みます。 |
| `merchant_details.merchant_txn_ref` | 加盟店の取引参照IDです。 |
| `transaction_type` | `CAPTURE` などの取引処理タイプです。 |
| `transaction_details` | 取引識別子および処理情報を含みます。 |
| `transaction_details.id` | ゲートウェイの一意の取引IDです。 |
| `transaction_details.ref` | ゲートウェイの取引参照番号です。 |
| `transaction_details.timestamp` | UTC形式の取引日時です。 |
| `transaction_details.merchant_txn_ref` | 加盟店の取引参照IDです。 |
| `transaction_details.stored_payment_method_id` | 該当する場合、保存された決済方法の識別子です。 |

> [!NOTE]
>
> 上記の例は、開発環境におけるPayNow決済成功時のWebhook通知を示しています。
>
> Webhookのフィールドおよび値は、決済方法、取引タイプ、処理結果によって異なる場合があります。
>
> 加盟店は注文を確定する前に、受信したWebhook通知を検証し、取引ステータスを確認するとともに、重複通知を安全に処理する必要があります。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.