> 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-shou/ge-lun-bi-ya/cash.md).

# Cash

### 支付流程

<figure><img src="/files/UGWqRnrNMavQeChEGuaG" alt=""><figcaption></figcaption></figure>

1、用户在商户网站进行下单选择Cash付款；

&#x20;2、商户向Supefina发起Cash支付请求；

&#x20;3、Supefina返回Cash付款URL信息。

&#x20;4、商户将该支付URL展示给用户；

&#x20;5、用户按照页面提示进行付款；

6、付款成功；

&#x20;7、Supefina通知商户订单成功。

### 请求地址

<table data-full-width="true"><thead><tr><th width="138">环境名称</th><th width="607">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/payin</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/payin</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="220">变量名</th><th width="102">类型</th><th width="89">必填</th><th>描述</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>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>orderAmount</td><td>String</td><td>是</td><td><p>订单金额<br>3000 >= <code>orderAmount</code> &#x3C;= 2000000</p><p>不支持小数</p></td></tr><tr><td>payProduct</td><td>String</td><td>是</td><td><a href="/pages/17IKBEvxR4cpZue8BRdD#mfocd">支付类型</a><br>Cash：<code>03</code></td></tr><tr><td>merId</td><td>String</td><td>是</td><td>商户ID<br>商户ID获取路径：Supefina商户后台-商户管理-基本信息-商户ID</td></tr><tr><td>merOrderNo</td><td>String</td><td>是</td><td>商户订单号</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><p>用户邮箱<br>邮箱用户名不能只有数字（例如31231234@gmail.com）且</p><p>同一个邮箱一天支付请求不能超过20次。</p></td></tr><tr><td>customerName</td><td>String</td><td>是</td><td>用户名字</td></tr><tr><td>customerPhone</td><td>String</td><td>是</td><td>用户电话<br>需以3开头的十位数</td></tr><tr><td>customerIdentification</td><td>String</td><td>是</td><td>用户证件号</td></tr><tr><td>checkOut</td><td>Boolean</td><td>是</td><td>收银台<br><code>true</code>：需要收银台<br><code>false</code>：不需要收银台<br>建议传<code>true</code></td></tr><tr><td>customerAccount</td><td>String</td><td>否</td><td>用户账户<br><code>checkOut</code>为<code>false</code>时必传</td></tr><tr><td>lastName</td><td>String</td><td>否</td><td>用户姓氏<br><code>checkOut</code>为<code>false</code>时必传</td></tr><tr><td>customerIdentificationType</td><td>String</td><td>否</td><td><p>用户证件类型<br><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><p><code>checkOut</code>为<code>false</code>时必传</p></td></tr><tr><td>customerAddress</td><td>String</td><td>否</td><td>用户地址<br><code>checkOut</code>为<code>false</code>时必传</td></tr><tr><td>tipo_persona</td><td>String</td><td>否</td><td>付款主体<br><code>checkOut</code>为<code>false</code>时必传</td></tr><tr><td>bankId</td><td>String</td><td>否</td><td>银行编码</td></tr><tr><td>expireTimeL</td><td>Long</td><td>否</td><td>过期时间<br>单位：秒；默认值：10分钟，最大值：10分钟</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>description</td><td>String</td><td>是</td><td><p>描述 </p><p>不能带特殊符号,长度不超过200字符</p></td></tr></tbody></table>

### 请求示例

{% code fullWidth="true" %}

```json
{
	"callbackUrl": "https://d3vf2zxd9jv8rh.cloudfront.net/apigate/v6sx2i/api/pay_notice/in_payback/payId/CDEA3CA37DBC4C2CB6301AED14011122",
	"checkOut": true,
	"countryId": "COL",
	"currency": "COP",
	"customerAccount": "60872832",
	"customerEmail": "eaawxmn@gmail.com",
	"customerIdentification": "9145652857",
	"customerName": "Aaliyah Rogers",
	"customerPhone": "3073030686",
	"description": "Supefina",
	"lastName": "cith",
	"merId": "8302490290654651",
	"merOrderNo": "2025072510514243602509134",
	"nonceStr": "b2e310b6b06f49b8a1a01da0e1ed0357",
	"orderAmount": "20000",
	"payProduct": "03",
	"sign": "758402CA9039D41F2F884A5285039621"// 大写
}
```

{% endcode %}

签名组装字符串

callbackUrl=<https://d3vf2zxd9jv8rh.cloudfront.net/apigate/v6sx2i/api/pay\\_notice/in\\_payback/payId/CDEA3CA37DBC4C2CB6301AED14011122\\&checkOut=true\\&countryId=COL\\&currency=COP\\&customerAccount=60872832\\&customerEmail=eaawxmn@gmail.com\\&customerIdentification=9145652857\\&customerName=Aaliyah> Rogers\&customerPhone=3073030686\&description=Supefina\&lastName=cith\&merId=8302490290654651\&merOrderNo=2025072510514243602509134\&nonceStr=b2e310b6b06f49b8a1a01da0e1ed0357\&orderAmount=20000\&payProduct=03\&key=e8548e70a8ba4a658b0da4ef50600d42

### 响应参数

<table data-full-width="true"><thead><tr><th width="261">变量名</th><th width="179">类型</th><th width="396">描述</th></tr></thead><tbody><tr><td>code</td><td>String</td><td>响应编码<br>具体参照：<a href="/pages/j56ENY9y4TEhx8ssOv8a">响应状态码</a></td></tr><tr><td>msg</td><td>String</td><td>响应信息</td></tr><tr><td>data</td><td>Object</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>supefinaOrderId</td><td>String</td><td>supefina订单号</td></tr><tr><td>amount</td><td>BigDecimal</td><td>订单金额</td></tr><tr><td>fee</td><td>String</td><td>预收手续费</td></tr><tr><td>identifier</td><td>String</td><td>付款参考标识符</td></tr><tr><td>transactionStatus</td><td>String</td><td>下单状态<br>该笔订单的的发起状态是否成功，与订单真正的交易状态无关。<br><code>00</code>：下单成功<br><code>04</code>：下单失败</td></tr><tr><td>url</td><td>String</td><td>交易链接</td></tr><tr><td>orderExpirationTime</td><td>String</td><td>订单过期时间 （UTC 0时区时间）</td></tr></tbody></table>

#### 响应示例

{% code fullWidth="true" %}

```json
{
	"code": "200",
	"msg": "success ",
	"data": {
		"merCode": "8302490290654651",
		"merOrderNo": "2025072510514243602509134",
		"supefinaOrderNo": "20250725025143001000038155",
		"amount": 20000,
		"fee": 5.0,
		"transactionStatus": "00",
		"url": "https://docs.supefina.net/huan-ying-shi-yong-supefina-de-api-wen-dang/dai-shou/ge-lun-bi-ya",
		"referenceCode": "",
		"channelName": "rickipay",
		"orderExpirationTime": "2025-07-27T02:51:53.03"
	}
}
```

{% endcode %}

### 回调通知

提交方式：`POST`

<table data-full-width="true"><thead><tr><th width="234">变量名</th><th width="158">类型</th><th width="396">描述</th></tr></thead><tbody><tr><td>amount</td><td>String</td><td>订单金额</td></tr><tr><td>countryId</td><td>String</td><td>国家编号<br>参照：<a href="/pages/17IKBEvxR4cpZue8BRdD#afwzp">字典表-国家编号</a><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><a href="/pages/17IKBEvxR4cpZue8BRdD#kxzkj">交易状态</a><br>具体参照：<a href="/pages/17IKBEvxR4cpZue8BRdD#kxzkj">字典表——交易订单状态</a></td></tr><tr><td>successTime</td><td>Date</td><td>交易成功时间<br>UTC时间</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": "20000.00",
	"countryId": "COL",
	"customerName": "Aaliyah Rogers",
	"fee": "5.00",
	"identifier": "a696e0ad-61c1-44",
	"merId": "8302490290654651",
	"merOrderId": "2025072510514243602509134",
	"msg": "SUCCESS",
	"nonceStr": "9312c568-8854-42dd-adc8-a4d9b5",
	"payerIdNumber": "9145652857",
	"payerName": "test",
	"realityAmount": "20000",
	"realityFee": "5.00",
	"sign": "A962FB48ECF86530AA42CAE859125987",// 大写
	"status": "01",
	"successTime": 1753411908000,
	"supefinaOrderId": "20250725025143001000038155",
	"transactionType": "01"
}
```

{% endcode %}

签名组装字符串

amount=20000.00\&countryId=COL\&customerName=Aaliyah Rogers\&fee=5.00\&identifier=a696e0ad-61c1-44\&merId=8302490290654651\&merOrderId=2025072510514243602509134\&msg=SUCCESS\&nonceStr=9312c568-8854-42dd-adc8-a4d9b5\&payerIdNumber=9145652857\&payerName=test\&realityAmount=20000\&realityFee=5.00\&status=01\&successTime=1753411908000\&supefinaOrderId=20250725025143001000038155\&transactionType=01\&key=e8548e70a8ba4a658b0da4ef50600d42

**回调通知响应**

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

{% code fullWidth="true" %}

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

{% endcode %}

{% hint style="info" %}
**注意**

重复支付：Cash可能会出现多次支付的情况，请注意处理收到多次支付通知。发生多次支付时，Supefina后台会创建多笔订单,并多次通知商户,商户可以通过通知中的<mark style="color:red;">**`supefinaOrderId`**</mark> 判断是否是同一订单。多次付款时，merOrderId保持不变，但每次的<mark style="color:red;">**supefinaOrderId**</mark>都会不同。
{% endhint %}


---

# 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-shou/ge-lun-bi-ya/cash.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.