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

# 通过钱包转账

使用 Localpayment 的 API 通过钱包发送资金。本指南涵盖您需要了解的关于创建付款、处理响应、管理交易状态以及满足特定国家/地区要求的所有信息。

钱包付款允许您将资金直接发送到收款人的数字钱包。您可以通过以下两种方式发起转账：

* **Localpayment Business Portal**：用户友好的界面，方便[手动交易管理](https://docs.localpayment.com/zh/docs/internal-transfers)。
* **API 集成**：通过程序化方式实现自动支付处理。

本指南重点介绍 API 实现，涵盖从初始化到完成的完整流程。

## 开始之前

请确保您已备好：

* 有效的 [API 凭证](https://docs.localpayment.com/zh/docs/api-keys-and-environments.md)（访问令牌）。
* 完整的受益人信息。
* 为目标国家/地区正确[设置](https://docs.localpayment.com/zh/docs/setup-guide.md)账户。
* 了解特定国家/地区的要求（见下文[“国家/地区要求”](#country-specific-requirements)）。

***

## 步骤 1：初始化支付交易

要创建银行转账付款，请向 **[Create a Payout](https://docs.localpayment.com/zh/reference/create-a-payout.md)** endpoint 发送 `POST` 请求，并将 `paymentMethod.type` 设置为 `Wallet`。

### endpoint

```
POST https://api.stage.localpayment.com/api/payout/
```

### 必需的标头

```http theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
Authorization: Bearer <your_access_token>
```

### 关键请求参数

该请求需要几个关键对象：

| 对象 | 描述 | 必需的 |
| - | - | - |
| `beneficiary` | 收款人详细信息，包括银行信息 | ✅ |
| `sender` | 发件人信息（用于合规性） | ✅ |
| `merchant` | 商家/企业详情 | ✅ |
| `paymentMethod` | 支付方式配置 | ✅ |
| `amount` | 交易金额 | ✅ |
| `currency` | 交易货币代码 | ✅ |
| `country` | 目标国家/地区代码 | ✅ |

### 示例请求（玻利维亚）

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request POST \
     --url https://api.stage.localpayment.com/api/payout/ \
     --header 'Authorization: Bearer <your_access_token>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "value": {
    "externalId": "07e80cf6-b11b-479c-ad9a-b952ec256cdb",
    "country": "BOL",
    "currency": "BOB",
    "amount": 1000,
    "paymentMethod": {
      "type": "Wallet",
      "code": "0021",
      "flow": "direct"
    },
    "beneficiary": {
      "name": "John",
      "lastName": "Doe",
      "type": "INDIVIDUAL",
      "document": {
        "type": "CI",
        "id": "7794986"
      },
      "bank": {
        "name": "Yape",
        "code": "990",
        "account": {
          "alias": "+59112345678"
        }
      }
    },
    "sender": {
      "type": "INDIVIDUAL",
      "name": "David",
      "lastName": "Doe",
      "document": {
        "type": "CI",
        "id": "4812012-1B"
      }
    },
    "merchant": {
      "type": "COMPANY",
      "name": "Company Name"
    },
    "accountNumber": "{{accountNumber}}",
    "conceptCode": "0039"
  }
}
'
```

***

## 步骤 2：处理响应

### 成功响应

成功的响应应包含详细的交易信息和跟踪标识符：

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "externalId": "07e80cf6-b11b-479c-ad9a-b952ec256cdb3",
  "internalId": "9cbdb959-acb0-49e5-a52a-a8f9dddcde15",
  "paymentMethod": {
    "code": "0021",
    "name": "BCP",
    "description": "Yape",
    "paymentMethodType": "Wallet"
  },
  "country": "BOL",
  "currency": "BOB",
  "amount": 1000,
  "accountNumber": "{{accountNumber}}",
  "clientCode": "0001",
  "clientName": "Acme",
  "status": {
    "code": "100",
    "description": "Received",
    "detail": "The payout was received"
  },
  "beneficiary": {
    "bank": {
      "name": "Yape",
      "code": "990",
      "countryISOCode3": null,
      "branch": null,
      "account": {
        "number": null,
        "type": null,
        "alias": "+59112345678",
        "pixKey": null,
        "phone": null
      }
    },
    "type": "INDIVIDUAL",
    "name": "John",
    "lastname": "Doe",
    "document": {
      "type": "CI",
      "id": "7794986"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00Z",
    "nationality": null,
    "address": null
  },
  "merchant": {
    "type": "COMPANY",
    "name": "Company Name",
    "lastname": null,
    "document": null,
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00Z",
    "nationality": null,
    "address": null
  },
  "sender": {
    "type": "INDIVIDUAL",
    "name": "David",
    "lastname": "Doe",
    "document": {
      "type": "CI",
      "id": "4812012-1B"
    },
    "userReference": null,
    "email": null,
    "phone": null,
    "birthdate": "0001-01-01T00:00:00Z",
    "nationality": null,
    "address": null
  },
  "comment": null,
  "exchangeRateToken": null,
  "date": {
    "creationDate": "2025-10-10T22:03:25.5138845Z",
    "processedDate": "2025-10-10T22:03:25.5140817Z"
  },
  "errors": null,
  "internalLoteID": "151880"
}
```

### 关键响应字段

| 字段 | 描述 | 用例 |
| - | - | - |
| `internalId` | Localpayment 的唯一交易标识符 | 交易跟踪和支持 |
| `externalId` | 您的参考编号 | 内部对账 |
| `status.code` | 当前交易状态代码 | 状态监控 |
| `date.creationDate` | 交易创建时 | 审计跟踪 |
| `date.processedDate` | 交易开始处理时 | 处理时间计算 |

### 错误响应

请求失败时，您将收到详细的错误信息：

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
[
  {
    "externalId": "1736488884",
    "internalId": "cd052d8c-8406-45f8-98aa-aff9876c3285",
    "status": {
      "code": "801",
      "description": "Rejected",
      "detail": "Params error"
    },
    "errors": [
      {
        "code": "300",
        "description": "Invalid param + [paymentMethod.code] + doesn't exist for PAYMENT_METHOD_TYPE BankTransf"
      },
      {
        "code": "300",
        "description": "Invalid param + [beneficiary.document.id] + doesn´t match regex ^(20|23|24|25|26|27|30|33|34)-?\\d{2}[.]?\\d{3}[.]?\\d{3}-?\\d$"
      }
    ],
    "comment": "Addicional informetion"
  }
]
```

***

## 步骤 3：跟踪交易状态

提交付款申请后，可通过以下方式监控付款进度：

> [card] [Webhooks（推荐）](https://docs.localpayment.com/zh/docs/webhooks.md)
>
> 交易状态变更时接收实时通知。最适用于生产环境。

> [card] [状态 API endpoint](https://docs.localpayment.com/zh/reference/get-transaction-status.md)
>
> 以编程方式查询交易状态。可用于轮询或恢复丢失的 webhook 通知。

> [card] [Business Portal 视图](https://docs.localpayment.com/zh/docs/dashboard-overview.md)
>
> 用于监控交易的可视化界面。非常适合人工监督和详细的交易分析。

### 常用状态码

| 代码 | 状态 | 描述 |
| :- | :- | :- |
| `100` | `Received` | 已收到款项。 |
| `101` | `Locked` | 款项已确认支付，并通过了反洗钱验证。 |
| `102` | 进行中 | 款项已汇入银行账户。 |
| `104` | `PendingAuth` | 款项尚待客户授权后方可支付。 |
| `200` | `Completed` | 款项已从账户中扣除。 |
| `300` | `Rejected` | 无效参数 + \[参数名称] + \[原因]。 |

> [!NOTE]
>
> **完整参考**
>
> 请查看我们的[交易状态文档](https://docs.localpayment.com/zh/reference/transaction-status-error-codes)，了解所有状态代码。

***

## 第四步：交易审批

为了提高安全性，某些交易需要[两人批准](https://docs.localpayment.com/zh/docs/approvals-and-double-signature.md)：

1. **发起人**：提交付款请求。
2. **审批人**：审核并确认交易。

该流程可通过[Business Portal](https://docs.localpayment.com/zh/docs/dashboard-review-payout.md)或 [API endpoint](https://docs.localpayment.com/zh/reference/authorize-payout.md)进行管理。

> [!NOTE]
>
> **安全须知**
>
> 审批要求有助于防止未经授权的交易，并确保符合当地法规。

***

## 各国具体要求

具体实施方案因国家/地区而异。未明确提及的国家/地区均遵循标准流程，无需特殊要求。集成前请仔细阅读以下要求：

> [tab] 玻利维亚
>
> **YAPE 付款：**
>
> * `paymentMethod.code`：设置为 0021。
> * `beneficiary.bank.code`：设置为 990。
> * `beneficiary.bank.account.alias`：必须包含收款人的电话号码，格式为 +591XXXXXXXX（完整国际格式）。
> * 请省略以下字段：`beneficiary.bank.account.type` 和 `beneficiary.bank.account.number`。

> [tab] 秘鲁
>
> **特殊要求：**
>
> * `paymentMethod.code`：设置为 0171。
> * `beneficiary.bank.account.alias`：设置为以 9 开头的 9 位手机号码（例如 987654321）。
> * 请省略以下字段：`beneficiary.bank.account.type` 和 `beneficiary.bank.account.number`。
> * `beneficiary.bank.code`：
>   * YAPE：设置为 901。
>   * PLIN：设置为 902。
>   * LIGO：设置为 921。
>   * DALE：设置为 922。

> [tab] 哥斯达黎加
>
> **SINPE Móvil 付款：**
>
> * `paymentMethod.code`：设置为 0071。
> * `beneficiary.bank.account.alias`：设置为收款人的电话号码，格式为 +506XXXXXXXX（完整国际格式）。
> * `beneficiary.bank.name` 和 `beneficiary.bank.code`：设置为收款人银行（该电话号码所注册的银行）的名称和代码，请参阅[银行代码表](https://docs.localpayment.com/zh/docs/costa-rica.md#bank-codes)。
> * 请省略以下字段：`beneficiary.bank.account.type` 和 `beneficiary.bank.account.number`。
>
> 全天候 24 小时可用，包括周末和公共假日。

***

## 测试您的集成

### 沙盒环境

使用测试环境：

```
https://api.stage.localpayment.com/api/payout/
```

### 测试场景

请确认您的集成方案能够处理以下场景：

1. **交易成功**：标准支付流程
2. **验证错误**：无效的银行账户，缺少字段
3. **处理延迟**：需要时间处理的事务
4. **交易失败**：资金不足、收款人被冻结
5. **状态更新**：Webhook 处理和状态轮询

***

## 资源与后续步骤

利用这些关键资源，最大限度地提高您的集成成功率。

> [card] [Webhook 集成](https://docs.localpayment.com/zh/docs/webhooks.md)
>
> 设置交易状态更新的实时通知。

> [card] [报告 Business Portal](https://docs.localpayment.com/zh/docs/balance-report.md)
>
> 获取详细的分析、报告工具和对账功能。

> [card] [交易监控](https://docs.localpayment.com/zh/reference/transaction-status-error-codes)
>
> 学习查询交易状态并实现全面跟踪。

> [card] [API 参考](https://docs.localpayment.com/zh/reference/exchange-bulk.md)
>
> 提供包含交互式示例的完整 endpoint 文档。

> [!NOTE]
>
> **专业提示**
>
> 在部署到生产环境之前，务必先在我们的沙盒环境中测试您的工作流程。这可以确保您的错误处理、Webhook 处理和状态跟踪在所有场景下都能正常工作。

***

> [!NOTE]
>
> **需要帮助吗？**
>
> 如果您遇到任何问题或需要集成方面的帮助，请联系我们的[支持团队](mailto:support@localpayment.com)。


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