# PayPay

`POST /your-endpoint-on-paypay-payment`

- operationId: `receiveWebhookOfPayPayPayment`
- tags: Webhook_通知仕様

PayPayによる決済に関するイベント（`payments.paypay.*`）で通知されるリクエストのボディの仕様です。


## リクエストボディ

Content-Type: `application/json`

| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `shop_id` | Shop_properties-id |  |  |
| `order_id` | Payment_properties-id |  |  |
| `access_id` | access_id |  |  |
| `pay_type` | PayType |  | 決済種別 |
| `status` | PaymentStatus |  | 決済ステータス |
| `customer_id` | id |  |  |
| `process_date` | Payment_properties-process_date |  |  |
| `job_code` | properties-job_code |  |  |
| `client_field_1` | client_field_n |  | 加盟店自由項目 1 |
| `client_field_2` | client_field_n |  | 加盟店自由項目 2 |
| `client_field_3` | client_field_n |  | 加盟店自由項目 3 |
| `amount` | amount |  | 利用金額 |
| `tax` | tax |  | 税送料 |
| `code_expiry_date` | code_expiry_date |  |  |
| `auth_max_date` | auth_max_date |  |  |
| `order_description` | order_description |  |  |
| `code_id` | code_id |  |  |
| `payment_id` | payment_id |  |  |
| `payment_date` | properties-payment_date |  |  |
| `merchant_payment_id` | merchant_payment_id |  |  |
| `merchant_update_id` | merchant_update_id |  |  |
| `merchant_revert_id` | merchant_revert_id |  |  |
| `merchant_refund_id` | merchant_refund_id |  |  |
| `error_code` | error_code |  | この決済において発生したエラーのうち、一番最新のエラーのエラーコードです。 |
| `event` | FincodeEvent |  |  |

## レスポンス

### 200 fincodeに正常にWebhookを受信した旨をレスポンスしてください。

| パラメータ | 型 | 必須 | 説明 |
| --- | --- | --- | --- |
| `receive` | enum(0 | 1) |  | Webhook通知受信 |

### 400 4xx系、5xx系または上記以外のレスポンスを返却した場合、fincodeはエラーと判断しWebhook通知のリトライを行います。