> ## 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.

# API基础知识

欢迎阅读 Localpayment API 文档。我们的 REST API 使您能够将支付处理功能直接集成到您的应用程序、网站和平台中，并在拉丁美洲提供全面的收款和付款功能。

Localpayment API 提供了一个强大且符合 RESTful 规范的接口，用于处理支付和管理财务运营。我们的 API 在设计时充分考虑了开发者体验，采用面向资源的 URL、JSON 请求/响应格式以及标准的 HTTP 约定，以确保在所有平台和编程语言中实现无缝集成。

> [card] RESTful 设计
>
> 遵循 REST 原则的清晰、可预测的 endpoint，便于集成

> [card] JSON 格式
>
> 所有 endpoint 采用一致的 JSON 请求/响应格式

> [card] HTTP标准
>
> 标准 HTTP 方法、状态码和身份验证

***

## API基础知识

了解Localpayment API 的核心概念和组件，以构建强大的集成。

> [card] [验证](https://docs.localpayment.com/zh/reference/authentication-overview.md)
>
> 了解如何生成访问令牌，并使用
> Bearer 令牌认证对 API 请求进行身份验证

> [card] [请求与回复](https://docs.localpayment.com/zh/docs/error-handling.md)
>
> 了解 API 请求格式、响应结构和常见响应模式

> [card] [错误代码](https://docs.localpayment.com/zh/reference/transaction-status-error-codes)
>
> 提供全面的 API 故障错误代码和处理策略参考

> [card] [Webhooks](https://docs.localpayment.com/zh/docs/webhooks.md)
>
> 实现交易事件和状态变更的实时通知

***

## 环境

> [tab] Stage
>
> 使用我们的沙箱环境进行测试和开发，无需处理真实交易。
>
> ### 基本网址
>
> | 组件 | URL |
> | - | - |
> | **API 基本 URL** | `https://api.stage.localpayment.com` |
> | **仪表板** | `https://ui.stage.localpayment.com` |
>
> ### 功能
>
> * 测试卡号和银行账户
> * 模拟支付处理
> * Webhook 测试
> * 没有真正的资金流动
> * 完整的 API 功能
>
> ### 入门
>
> 1. 注册 Stage 帐户
> 2. 从控制面板中获取您的 API 凭据。
> 3. 配置 IP 白名单以确保安全
> 4. 开始测试您的集成

> [tab] 生产
>
> 完成测试和认证后，即可访问正式环境。
>
> ### 基本网址
>
> | 组件 | URL |
> | - | - |
> | **API 基本 URL** | `https://api.v3.localpayment.com` |
> | **仪表板** | `https://ui.v3.localpayment.com` |
>
> ### 要求
>
> * 已在 Stage 中完成集成测试
> * 安全审查和认证
> * 已批准的企业验证
> * 实时交易处理
>
> ### 上线流程
>
> 1. 在 Stage 环境中进行全面彻底的测试
>
> 2. 提交集成方案以进行安全审查
>
> 3. 完成业务验证
>
> 4. 获取生产凭证
>
> 5. 请更新您的应用程序以使用生产环境 URL。
>
> > [!TIP]
> >
> > **准备好投入生产了吗？**
> >
> > Stage 测试完成后，请联系我们的支持团队，开始认证流程。

***

## 快速入门

利用我们提供的入门必备资源，快速上手。

> [card] [支付您的首笔测试费用](https://docs.localpayment.com/zh/docs/make-your-first-test-payment.md)
>
> 分步指南，通过示例代码在 Stage
> 环境中创建您的首笔测试支付

> [card] [Postman 集合](https://docs.localpayment.com/zh/reference/postman-collection.md)
>
> 下载我们预配置的 Postman 集合，其中包含所有 API endpoint 和
> 测试场景

***

> [card] [支持资源](https://docs.localpayment.com/zh/docs)
>
> * [**集成指南：**](https://docs.localpayment.com/zh/docs) 常见集成场景的分步教程。
> * [**支持：**](mailto:support@localpayment.com) 提供 API 集成问题的技术支持。


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