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

# Webhook

Webhook/回调功能允许 Localpayment 向您的服务器发送有关交易更新、支付状态变更等事件的实时通知。本指南将引导您完成在 Localpayment Business Portal 中设置和配置 Webhook 的步骤。

## 为什么要使用回调函数？

> [card] 实时交易更新
>
> 实时接收有关付款状态变更、交易确认和处理更新的即时通知。

> [card] 自动化工作流程集成
>
> 根据支付事件触发系统中的自动化流程，实现无缝的订单履行和客户沟通。

> [card] 增强型安全监控
>
> 立即收到可疑活动、交易失败或安全事件的警报，以保护您的企业和客户。

***

## 先决条件

开始之前，请确保您已准备好：

**访问要求**

* [LocalpaymentBusiness Portal](https://ui.v3.localpayment.com/login)的有效凭证。
* 具有[安全设置权限](https://docs.localpayment.com/zh/docs/user-roles-and-permissions.md)的用户帐户。

**技术要求**

* 一个可以公开访问的服务器 endpoint URL，能够接收 HTTP POST 请求。
* 服务器具备处理和响应 webhook 通知的能力。

***

## 导航路径

```
Side Menu → Configurations → Client → Edit → Notifications → Callbacks
```

***

## 分步指南

### URL Webhook

1. 导航至“**配置**”模块。
2. 在“配置”中，选择“**客户端**”部分。
3. 点击“**编辑**”选项打开您的帐户设置。
4. 在您的帐户设置中，找到并选择“**通知**”选项卡。
5. 从“通知”菜单中选择“**回调**”。
6. 选择 **URL** 选项卡，配置向服务器发送实时 webhook 通知。
7. 点击“**添加**”按钮。
8. 输入将接收 webhook 通知的服务器 endpoint **URL**。
9. 选择“**国家/地区**”字段，将显示所有可用的国家/地区。
10. 选择**账户**。此字段列出了您在所选国家/地区的所有 Localpayment 账户。如果您在“**国家/地区**”字段中选择“**全部**”，则还必须在“**账户**”字段中选择“**全部**”。
11. 如果您的集成需要自定义标头，请单击“**添加标头**”按钮。

    11.1 对于每个标头，指定其**键**及其对应的**值**。
12. 点击“**保存**”完成操作，之后会显示确认信息。

导航至“**配置**”模块。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/e0b31e6797aead93d5f3d643acea2d370f242310b5d15c244d018a0149694733-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=702d9cce60ed4a61538a74a7b055ff28)

在“配置”中，选择“**客户端**”部分。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/dcbec917bfb334d8d72674be038956c53bd79126c7b4116c1d3f83f7800e2bff-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=562df275f6933883832b321f01afefce)

点击“**编辑**”选项打开您的帐户设置。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/027aec6709a8f0aac50c7e16fa033d93b4edb231017628644905e8a9f8576309-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=349fe1926b9b871500710d0377d43ce4)

在您的帐户设置中，找到并选择“**通知**”选项卡。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/4d08e9dbc51a8395f2992417b5cfe042de70179130d1016ec0f874d03a74cc22-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=82ff363723c0e33540a7d54044893d64)

从“通知”菜单中选择“**回调**”。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/37f155413c859dab45f093cdfc4d7121fa7070c0473c5d8d8d81931d9845621a-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=1656d1545ed2862e54d1b2b4ddba7775)

选择 **URL** 选项卡，配置向服务器发送实时 webhook 通知。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/ad92d010058af5e0859b44957e83877a3316f5f6bacc1f5b8d9d81d2d4c53985-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=b95574357e4898efcaed28b8483ae2c0)

点击“**添加**”按钮。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/ee764e5c0363c5d6d6b2fce20e119b80634e676b826632a1dbdf20fc4f45d0e8-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=59cd61bc6343f7bf4d9c28492f02f77c)

输入将接收 webhook 通知的服务器 endpoint **URL**。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/d2de9c6ee624ec6f1c7f118ca3ff36b91ced9edcd967cbf3442a9d2ce83b5d05-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=dd948f89a12fb3ad0cb47d24eb559d3b)

选择“**国家/地区**”字段，将显示所有可用的国家/地区。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/87891b9ea3dabc9297cbb52d36fa16cf1b7fc534a6f6a6713518ae3cbafe86ca-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=c136bcc4cb02404a8624ecac70c7d806)

选择**账户**。此字段列出了您在所选国家/地区的所有 Localpayment 账户。如果您在“**国家/地区**”字段中选择“**全部**”，则还必须在“**账户**”字段中选择“**全部**”。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/7cd3ccf505405c240392bcf845f1ac5432fdb5d5133de80679835ed2bbc4ceed-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=70674180597e9c8534fcd641a3a13728)

如果您的集成需要自定义标头，请单击“**添加标头**”按钮。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/b321a49b21bb9001c0cac332ac9ca6e23f6a9b0aabad95d847fd461c460c19dd-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=b1233c2a4dfbf392ef01c93afe0cd3d0)

对于每个标头，指定其**键**及其对应的**值**。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/aa92b2b6181eb5ea8cbb134201e568de9f4040b00b84ddea53ec3fdcbb5e42ad-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=cc68f9515bd2067ecb02c3a77877512f)

点击“**保存**”完成操作，之后会显示确认信息。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/b08e2c0f9072fcc37108bd56987959c85c6f0de8a33f2d582e696b90b9eb2bf7-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=ceae7f2e3b7e5d91ce4d44132bb93b40)

### 电子邮件 Webhook

1. 导航至“**配置**”模块。
2. 在“配置”中，选择“**客户端**”部分。
3. 点击“**编辑**”选项打开您的帐户设置。
4. 在您的帐户设置中，找到并选择“**通知**”选项卡。
5. 从“通知”菜单中选择“**回调**”。
6. 选择“**电子邮件**”选项卡以配置基于电子邮件的通知。
7. 点击“**添加**”按钮。
8. 请输入将接收 webhook 通知的**电子邮件**地址。
9. 选择“**国家/地区**”字段，将显示所有可用的国家/地区。
10. 选择**账户**。此字段列出了您在所选国家/地区的所有 Localpayment 账户。如果您在“**国家/地区**”字段中选择“**全部**”，则还必须在“**账户**”字段中选择“**全部**”。
11. 请从可用选项中选择**交易类型**：汇入或汇出。
12. 点击“**保存**”完成操作，之后会显示确认信息。

导航至“**配置**”模块。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/e0b31e6797aead93d5f3d643acea2d370f242310b5d15c244d018a0149694733-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=702d9cce60ed4a61538a74a7b055ff28)

在“配置”中，选择“**客户端**”部分。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/dcbec917bfb334d8d72674be038956c53bd79126c7b4116c1d3f83f7800e2bff-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=562df275f6933883832b321f01afefce)

点击“**编辑**”选项打开您的帐户设置。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/027aec6709a8f0aac50c7e16fa033d93b4edb231017628644905e8a9f8576309-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=349fe1926b9b871500710d0377d43ce4)

在您的帐户设置中，找到并选择“**通知**”选项卡。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/4d08e9dbc51a8395f2992417b5cfe042de70179130d1016ec0f874d03a74cc22-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=82ff363723c0e33540a7d54044893d64)

从“通知”菜单中选择“**回调**”。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/37f155413c859dab45f093cdfc4d7121fa7070c0473c5d8d8d81931d9845621a-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=1656d1545ed2862e54d1b2b4ddba7775)

选择“**电子邮件**”选项卡以配置基于电子邮件的通知。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/b6580eb5673b98b773e24c6099ae878e8584d606b8eb76315df29a62bb5fa4bf-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=4ec8e97aeb8c92418bdcc823c9d79dc0)

点击“**添加**”按钮。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/8acfbe0b701e036b065fc4576d1dea5c9025340e23475bccaac07686126e61fa-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=da433d25d78c5cfd9f9703f57420041f)

请输入将接收 webhook 通知的**电子邮件**地址。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/40633b8b00291715a00124c7c526077c76b81569fa564afc760c9e60fd0bcf8f-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=ea91bbdfbb921846baa36c616ce0fdd6)

选择“**国家/地区**”字段，将显示所有可用的国家/地区。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/87891b9ea3dabc9297cbb52d36fa16cf1b7fc534a6f6a6713518ae3cbafe86ca-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=c136bcc4cb02404a8624ecac70c7d806)

选择**账户**。此字段列出了您在所选国家/地区的所有 Localpayment 账户。如果您在“**国家/地区**”字段中选择“**全部**”，则还必须在“**账户**”字段中选择“**全部**”。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/6e42b87ea452de4e2bc3e1e323cad37b4079961ce6174d30c96fd32cc729d614-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=4d5da253b9b964f119b3a26baefc289c)

如果您的集成需要自定义标头，请单击“**添加标头**”按钮。

![](https://mintcdn.com/localpayment-1fee3d41/R2R5JIQRe6pRQ97b/images/docs/b321a49b21bb9001c0cac332ac9ca6e23f6a9b0aabad95d847fd461c460c19dd-image.png?fit=max\&auto=format\&n=R2R5JIQRe6pRQ97b\&q=85\&s=b1233c2a4dfbf392ef01c93afe0cd3d0)

请从可用选项中选择**交易类型**：汇入或汇出。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/5ef53ce2b19d348525e45b65602cf0ca36256dc1ef3070c9bfda2b10a3c34986-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=08f3891e1ba19c33382f5381f012fb23)

点击“**保存**”完成操作，之后会显示确认信息。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/d225ed44e2106e2422465c1443ba3c246eabfbdf5175405fdba52d6aeec5a18b-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=1922be4d8df82f6c1c9032ace801a1b5)

***

## 管理您的 Webhook

### 修改现有 Webhook

1. 点击**编辑**图标，进行所需的 webhook 配置。
2. 更新 webhook 的 URL/电子邮件、身份验证标头（键/值对）、通知设置或交易类型。
3. 点击“**保存**”以应用更改。

![](https://mintcdn.com/localpayment-1fee3d41/x0nXcqwNUmbD9R8W/images/docs/8334fe244d3c16d0dd99bf45fd1f144019a93ce209018e6b78c2ca1fc48f8b45-image.png?fit=max\&auto=format\&n=x0nXcqwNUmbD9R8W\&q=85\&s=480d29e8170d5250123b61f363e43999)

### Webhook 的历史记录

1. 点击所需 webhook 的**历史**记录图标。
2. 将显示 webhook 的详细信息和更改历史记录，包括编辑者、操作和日期。

![](https://mintcdn.com/localpayment-1fee3d41/thasGykLOKju8tM0/images/docs/0fb0055d633782722a106200d2896fb36f073cb14cbe496b3adf515a72efcce8-image.png?fit=max\&auto=format\&n=thasGykLOKju8tM0\&q=85\&s=1104278283b1a6df80ef0b870e9cdeae)

### 移除 Webhook

1. 点击要删除的 webhook 旁边的**删除**图标。
2. 点击“**确定**”确认操作。
3. 该 webhook 将立即停用并从您的配置中移除。

![](https://mintcdn.com/localpayment-1fee3d41/oFZuSE0fcOk5ECyA/images/docs/dfa5e6a4b4f83d82a89b33ddddd80e8a9f5a74c202def80466a843eb7d4d5138-image.png?fit=max\&auto=format\&n=oFZuSE0fcOk5ECyA\&q=85\&s=9dd74d0d95872d0c1bd32a58b648225f)

***

> **需要帮助？** 如果您对本流程或其他任何功能有任何疑问，我们的[支持团队](mailto:support@localpayment.com)随时为您提供帮助。我们可以协助您进行故障排除、集成规划和优化。


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