> For the complete documentation index, see [llms.txt](https://docs.supefina.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.supefina.net/huan-ying-shi-yong-supefina-de-api-wen-dang/dai-fu/ge-lun-bi-ya/bre-b.md).

# Bre-B

### 请求地址

<table data-full-width="true"><thead><tr><th width="114">环境名称</th><th width="619">URL</th></tr></thead><tbody><tr><td>SandBox</td><td><mark style="color:blue;"><code>POST</code></mark><br>https://api.supefina.tech/api/supefina/transactions/payout</td></tr><tr><td><mark style="color:red;">正式环境</mark></td><td><mark style="color:red;"><code>POST</code></mark><br><mark style="color:red;">https://api.supefina.net/api/supefina/transactions/payout</mark></td></tr></tbody></table>

### 请求方式

#### 请求头

<table data-full-width="true"><thead><tr><th>Key</th><th>Value</th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td><code>application/json</code></td></tr></tbody></table>

#### 请求体

<table data-full-width="true"><thead><tr><th width="222">变量名</th><th width="128">类型</th><th width="122">必填</th><th width="542">描述</th></tr></thead><tbody><tr><td>countryId</td><td>String</td><td>是</td><td>国家编号<br>参照：<a href="/pages/17IKBEvxR4cpZue8BRdD#afwzp">字典表-国家编号</a><br>哥伦比亚，<code>COL</code></td></tr><tr><td>orderAmount</td><td>String</td><td>是</td><td>订单金额<br>3,000&#x3C;=  <code>orderAmount</code> &#x3C;= 3,000,000,不支持小数</td></tr><tr><td>payProduct</td><td>String</td><td>是</td><td><a href="/pages/17IKBEvxR4cpZue8BRdD#mfocd">支付类型</a><br>Bre-B：<code>31</code></td></tr><tr><td>merId</td><td>String</td><td>是</td><td>商户ID<br>商户ID获取路径：Supefina商户后台-商户管理-基本信息-商户ID</td></tr><tr><td>currency</td><td>String</td><td>是</td><td>币种<br>参照：<a href="/pages/17IKBEvxR4cpZue8BRdD#huo-bi-currency">字典表-货币</a><br>哥伦比亚比索：<code>COP</code></td></tr><tr><td>merOrderNo</td><td>String</td><td>是</td><td>商户订单号</td></tr><tr><td>customerName</td><td>String</td><td>是</td><td><p>用户名字</p><p>首尾不得包含空格，但姓名之间可以有空格</p></td></tr><tr><td>customerAddress</td><td>String</td><td>否</td><td>用户地址</td></tr><tr><td>customerIdentification</td><td>String</td><td>是</td><td><p>用户证件号</p><p><code>00</code>：身份证（CC/TI）--最多10位<br><code>01</code>：外国人身份证（CE）--6位</p></td></tr><tr><td>sign</td><td>String</td><td>是</td><td>签名<br><a href="/pages/DR0Ieg3d88mBdWrXD882">具体参照：签名算法</a></td></tr><tr><td>nonceStr</td><td>String</td><td>是</td><td>随机字符串<br>长度不能超过32位</td></tr><tr><td>customerEmail</td><td>String</td><td>否</td><td>用户邮箱</td></tr><tr><td>lastName</td><td>String</td><td>否</td><td>用户姓氏</td></tr><tr><td>customerPhone</td><td>String</td><td>否</td><td>用户电话</td></tr><tr><td>customerIdentificationType</td><td>String</td><td>是</td><td><p>用户证件号类型</p><p><code>00</code>：身份证（CC/TI）<br><code>01</code>：外国人身份证（CE）<br><code>02</code>：税号<br><code>03</code>：护照<br><code>06</code>：其他<br><code>07</code>：公民身份证明<br><code>08</code>：居留许可证</p></td></tr><tr><td>accountType</td><td>String</td><td>是</td><td>账户类型<br><code>05</code>：PHONE</td></tr><tr><td>account</td><td>String</td><td>是</td><td>收款方账户号。接受以下三种Bre-B账号，手机号或身份证号（格式为：纯数字），邮箱，还有字母数字标识符（格式为：@后加llave，示例：@TESTABC123）。</td></tr><tr><td>bankName</td><td>String</td><td>是</td><td>银行名称<br>具体参照：<a href="/pages/8YRD2SP9Grp9K4fNoIZS#ge-lun-bi-ya-yin-hang-lie-biao">哥伦比亚银行列表</a><br></td></tr><tr><td>callbackUrl</td><td>String</td><td>是</td><td><p>回调地址</p><p>详见<a href="/pages/mfMq4AmXGJtMyIPchGsF">通知回调说明</a></p></td></tr><tr><td>requestData</td><td>JSONObject</td><td>否</td><td>交易额外参数<br>此字段为json对象，不需要可以不传或者传“null”</td></tr></tbody></table>

#### 请求示例<br>

{% code fullWidth="true" %}

```json
{
	"account": "3234517213",
	"accountType": "05",
	"bankName": "NEQUI",
	"callbackUrl": "https://www.3spicy.bet/api/pay_notice/out_payback/payId/5739B8C9398C4B5494A355B16D0F154C",
	"countryId": "COL",
	"currency": "COP",
	"customerAddress": "EZzpXldfRI",
	"customerEmail": "sebbyhola1@gmail.com",
	"customerIdentification": "45550444",
	"customerIdentificationType": "00",
	"customerName": "soraya",
	"customerPhone": "3234517213",
	"lastName": "cc",
	"merId": "8302490290654651",
	"merOrderNo": "2025072518394772565086215",
	"nonceStr": "d277d76219314c13ad6566b626aadd9d",
	"orderAmount": "190000",
	"payProduct": "31",
	"sign": "15BFDC4D172274EA8808B16FB8D62EB7"// 大写
}
```

{% endcode %}

签名组装字符串

account=3234517213\&accountType=05\&bankName=NEQUI\&callbackUrl=<https://www.3spicy.bet/api/pay\\_notice/out\\_payback/payId/5739B8C9398C4B5494A355B16D0F154C\\&countryId=COL\\&currency=COP\\&customerAddress=EZzpXldfRI\\&customerEmail=sebbyhola1@gmail.com\\&customerIdentification=45550444\\&customerIdentificationType=00\\&customerName=soraya\\&customerPhone=3234517213\\&lastName=cc\\&merId=8302490290654651\\&merOrderNo=2025072518394772565086215\\&nonceStr=d277d76219314c13ad6566b626aadd9d\\&orderAmount=190000\\&payProduct=08\\&key=e8548e70a8ba4a658b0da4ef50600d42>

### 响应参数

<table data-full-width="true"><thead><tr><th width="222">变量名</th><th width="159">类型</th><th width="423">描述</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>响应编码<br>具体参照：<a href="/pages/j56ENY9y4TEhx8ssOv8a">响应状态码</a></td></tr><tr><td>data</td><td>Object</td><td>响应数据</td></tr><tr><td>amount</td><td>BigDecimal</td><td>订单金额</td></tr><tr><td>fee</td><td>BigDecimal</td><td>预收手续费</td></tr><tr><td>merCode</td><td>String</td><td>商户ID</td></tr><tr><td>merOrderNo</td><td>String</td><td>商户订单号</td></tr><tr><td>supefinaOrderNo</td><td>String</td><td>supefina订单号</td></tr><tr><td>transactionStatus</td><td>String</td><td>下单状态<br>该笔订单的的发起状态是否成功，与订单真正的交易状态无关。<br><code>00</code>：下单成功<br><code>04</code>：下单失败</td></tr><tr><td>msg</td><td>String</td><td>响应信息</td></tr></tbody></table>

#### 响应示例

{% code fullWidth="true" %}

```json
{
	"code": "200",
	"msg": "success ",
	"data": {
		"merCode": "8302490290654651",
		"merOrderNo": "2025072518394772565086215",
		"supefinaOrderNo": "20250725103949372000038503",
		"amount": 190000,
		"transactionStatus": "00"
	}
}
```

{% endcode %}

### 回调通知

提交方式：`POST`

<table data-full-width="true"><thead><tr><th width="207">变量名</th><th width="159">类型</th><th width="655">描述</th></tr></thead><tbody><tr><td>amount</td><td>String</td><td>订单金额</td></tr><tr><td>countryId</td><td>String</td><td>国家编号<br>参照：字典表-国家编号<br>哥伦比亚，COL</td></tr><tr><td>customerName</td><td>String</td><td>收款人姓名</td></tr><tr><td>fee</td><td>String</td><td>预收手续费</td></tr><tr><td>identifier</td><td>String</td><td>付款参考<br>Clabe</td></tr><tr><td>merId</td><td>String</td><td>商户ID</td></tr><tr><td>merOrderId</td><td>String</td><td>商户订单号</td></tr><tr><td>msg</td><td>String</td><td>消息</td></tr><tr><td>nonceStr</td><td>String</td><td>随机字符串<br>长度不能超过32位</td></tr><tr><td>realityAmount</td><td>String</td><td>实收金额</td></tr><tr><td>realityFee</td><td>String</td><td>实收手续费</td></tr><tr><td>sign</td><td>String</td><td>签名</td></tr><tr><td>status</td><td>String</td><td>交易状态<br>具体参照：<a href="/pages/17IKBEvxR4cpZue8BRdD#kxzkj">字典表——交易订单状态</a></td></tr><tr><td>successTime</td><td>String</td><td>交易成功时间</td></tr><tr><td>supefinaOrderId</td><td>String</td><td>supefina订单号</td></tr><tr><td>transactionType</td><td>String</td><td>交易类型<br><code>01</code>：代收<br><code>02</code>：代付</td></tr></tbody></table>

#### 回调通知示例

{% code fullWidth="true" %}

```json
{
	"amount": "190000.00",
	"countryId": "COL",
	"customerName": "soraya",
	"fee": "5.00",
	"identifier": "",
	"merId": "8302490290654651",
	"merOrderId": "2025072518394772565086215",
	"msg": "SUCCESS",
	"nonceStr": "bc41d5f8-e628-45c1-862f-2451c9",
	"realityAmount": "190000.00",
	"realityFee": "5.00",
	"reference": "0f211169-f266-4d",
	"sign": "17829110C3136000A18BEAAA0621F511",// 大写
	"status": "01",
	"supefinaOrderId": "20250725103949372000038503",
	"transactionType": "02"
}
```

{% endcode %}

签名组装字符串

amount=190000.00\&countryId=COL\&customerName=soraya\&fee=5.00\&merId=8302490290654651\&merOrderId=2025072518394772565086215\&msg=SUCCESS\&nonceStr=bc41d5f8-e628-45c1-862f-2451c9\&realityAmount=190000.00\&realityFee=5.00\&reference=0f211169-f266-4d\&status=01\&supefinaOrderId=20250725103949372000038503\&transactionType=02\&key=e8548e70a8ba4a658b0da4ef50600d42

**回调通知响应**

商户成功收到回调后需同步返回指定字符串：SUCCESS 不返回或返回其他内容默认通知失败\
如：

{% code fullWidth="true" %}

```java
public String test(){
	return "SUCCESS";
}
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.supefina.net/huan-ying-shi-yong-supefina-de-api-wen-dang/dai-fu/ge-lun-bi-ya/bre-b.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.