> For the complete documentation index, see [llms.txt](https://docs.topay.mobi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.topay.mobi/cn/reference/api-reference/fiat-payments/payout.md).

# 法币代付 API

{% hint style="warning" %}
每个请求都必须包含[公共参数](/cn/reference/api-reference/common-parameters.md)。
{% endhint %}

## 创建代付 <a href="#create-payout" id="create-payout"></a>

提交法币代付请求。

<mark style="color:green;">`POST`</mark> `https://api.topay.mobi/v1/order/payout`

#### 请求体 <a href="#request-body" id="request-body"></a>

| 名称                                                 | 类型     | 说明                                                                                                                                                                                         |
| -------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| request\_id<mark style="color:red;">\*</mark>      | String | 商户提供的外部交易 ID                                                                                                                                                                               |
| account\_type                                      | String | <p>payout\_method 为 wallet\_transfer 时必填，取值为 PHONE、EMAIL、CPF、CNPJ 之一</p><p>秘鲁（country=PE，bank\_transfer）必填，取值为 CURRENT\_ACCOUNT、SAVINGS\_ACCOUNT 之一</p><p>土耳其（country=TR）走 IBAN 直付，无需传</p> |
| account\_no<mark style="color:red;">\*</mark>      | String | 收款人账号                                                                                                                                                                                      |
| account\_name<mark style="color:red;">\*</mark>    | String | <p>收款人姓名<br>长度为 5 至 100 个字符</p>                                                                                                                                                            |
| country<mark style="color:red;">\*</mark>          | String | 国家代码                                                                                                                                                                                       |
| bank\_code                                         | String | payout\_method 为 bank\_transfer 时必填；土耳其（country=TR）固定传 `tr_bank_transfer`（IBAN 直付，无银行列表可选）                                                                                                 |
| wallet\_code                                       | String | payout\_method 为 wallet\_transfer 时必填                                                                                                                                                      |
| payout\_method<mark style="color:red;">\*</mark>   | String | 取以下值之一：\[bank\_transfer \| wallet\_transfer]                                                                                                                                               |
| settle\_currency<mark style="color:red;">\*</mark> | String | 收款币种                                                                                                                                                                                       |
| amount<mark style="color:red;">\*</mark>           | String | 商户代付金额                                                                                                                                                                                     |
| currency<mark style="color:red;">\*</mark>         | String | 商户账户币种                                                                                                                                                                                     |
| remark                                             | String | <p>代付备注</p><p>最大长度：40</p>                                                                                                                                                                  |
| bank\_routing\_code                                | String | <p>银行路由代码</p><p>- 秘鲁（country=PE）必填：20 位 CCI（银行间账户代码，Clave de Cuenta Interbancaria）</p><p>最大长度：100</p>                                                                                      |
| document\_type                                     | String | <p>证件类型</p><p>- 秘鲁（country=PE）：DNI、RUC、CE、PASSPORT、MILITARY、PAR、OTHER</p>                                                                                                                  |
| document\_id                                       | String | 证件号码                                                                                                                                                                                       |
| phone<mark style="color:red;">\*</mark>            | String | 收款人手机号码。                                                                                                                                                                                   |
| email<mark style="color:red;">\*</mark>            | String | 收款人电子邮箱                                                                                                                                                                                    |
| notify\_url                                        | String | Webhook 通知地址                                                                                                                                                                               |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{"code":"200",
 "data":{
   "request_id":"1675157000687",
   "partner_id":"2000051",
   "order_no":"2023013120000600262092321146",
   "currency":"USDT_TRC20",
   "order_amount":"0.3",
   "status":11
 },
 "message":"success"
 }
```

{% endtab %}
{% endtabs %}

## 查询代付渠道 <a href="#query-payout-channels" id="query-payout-channels"></a>

查询支持的银行和钱包代码。

<mark style="color:green;">`POST`</mark> `https://api.topay.mobi/v1/fee/queryPayoutChannel`

#### 请求体 <a href="#query-payout-channels-request-body" id="query-payout-channels-request-body"></a>

| 名称                                         | 类型     | 说明 |
| ------------------------------------------ | ------ | -- |
| country<mark style="color:red;">\*</mark>  | String |    |
| currency<mark style="color:red;">\*</mark> | String |    |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{"code":"200",
     "data":{
       "banks":
          [{"code":"1000120","enName":"Bank BCA","enShortName":"Bank BCA","localName":"Bank BCA","localShortName":"Bank BCA"},
          {"code":"1000153","enName":"Bank BRI","enShortName":"Bank BRI","localName":"Bank BRI","localShortName":"Bank BRI"}
          ],
       "wallets":
            [{"code":"ovo","enName":"ovo","enShortName":"ovo","localName":"ovo","localShortName":"ovo"},
             {"code":"dana","enName":"dana","enShortName":"dana","localName":"dana","localShortName":"dana"},
             {"code":"linkaja","enName":"LinkAja","enShortName":"LinkAja","localName":"LinkAja","localShortName":"LinkAja"},
             {"code":"gopay","enName":"Gopay","enShortName":"Gopay","localName":"Gopay","localShortName":"Gopay"},
             {"code":"shopeepay","enName":"ShopeePay","enShortName":"ShopeePay","localName":"ShopeePay","localShortName":"ShopeePay"}
             ]
      },
 "message":"success"}
```

{% endtab %}
{% endtabs %}

## 示例

* [示例](/cn/reference/api-reference/fiat-payments/payout/country-examples.md)