API 收款交易

请求

收款交易 API 使商户能够通过多种支付方式向客户发起收款。此 API 支持多种支付渠道，包括现金支付、银行转账和秘鲁可用的其他本地支付方式。

请求路径：

沙盒环境：https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
生产环境：https://gateway.smilepayz.com/v2.0/transaction/pay-in

请求头参数

字段	必填	类型	描述
Content-Type	是	String	HTTP 内容类型规范固定值：application/json 用于正确解析请求
X-TIMESTAMP	是	String	ISO 8601 日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-05:00 注意：必须是当前服务器时间，误差在 ±5 分钟内
X-SIGNATURE	是	String	请求认证的数字签名参见签名生成
X-PARTNER-ID	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由请输入 merchantID

请求体参数

字段	必填	类型	描述
orderNo	是	String(32)	唯一交易标识符格式：字母数字字符串（仅数字和字母）长度：6-32 个字符必须在商户的所有交易中保持唯一
purpose	是	String(64)	交易目的或描述格式：UTF-8 编码字符串最大长度：64 个字符用于交易识别和报告
merchant	是	Object	商户信息容器包含商户识别和业务详情参见商户模型
merchantId	是	String	平台分配的主要商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	否	String	商户业务名称，用于显示格式：UTF-8 编码字符串用于交易识别和客户显示
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于复杂的商户层级结构
subMerchantName	否	String	子商户业务名称，用于显示格式：UTF-8 编码字符串用于多级结构中的交易识别
money	是	Object	交易金额和货币规范包含支付金额和货币详情参见货币模型
currency	是	String	ISO 4217 货币代码规范固定值：PEN（秘鲁索尔）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000 表示 PEN 20000 范围：100-999999999
payer	是	Object	客户信息容器包含付款人识别和联系详情参见付款人模型
name	是	String	客户全名，用于交易识别格式：UTF-8 编码字符串用于交易记录和客户服务
paymentMethod	是	String	交易处理的支付方式格式：预定义支付方式代码固定值：CASHIER_PE 参见支付方式列表
expiryPeriod	否	Number	交易过期时间（秒）格式：整数值默认值：3600（1 小时）范围：300-86400（5 分钟到 24 小时）
redirectUrl	否	String(256)	支付完成后客户重定向 URL 格式：有效的 HTTP/HTTPS URL 最大长度：256 个字符用于支付后客户体验
callbackUrl	否	String(256)	交易状态更新的 Webhook 通知 URL 格式：有效的 HTTP/HTTPS URL 最大长度：256 个字符用于异步交易通知

重要说明

1. 交易唯一性： orderNo 必须在您的商户账户的所有交易中保持唯一
2. 金额格式： 所有金额都以最小货币单位指定（例如，20000 = PEN 200.00）
3. 时区： 所有时间戳使用 UTC-5（秘鲁时区）
4. 支付方式： 目前支持 CASHIER_PE 用于现金收款
5. 过期： 如果未在指定时间内完成，交易将自动过期

请求体示例 – 交易请求：

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-05:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "merchant": {
        "merchantId": "20011"
    },
    "payer": {
        "idType": "DNI",
        "identity": "48982488880",
        "name": "Carlos Rodriguez Mendoza",
        "phone": "51987654321",
        "email": "[email protected]"
    },
    "money": {
        "amount": 20000,
        "currency": "PEN"
    },
    "orderNo": "200110edbb466abb04682968b40",
    "paymentMethod": "CASHIER_PE",
    "purpose": "在线购买支付",
    "redirectUrl": "https://www.example.com/success"
}

响应

HTTP 响应

字段	必填	类型	描述
Content-Type	是	String	HTTP 响应内容类型规范固定值：application/json 表示 JSON 响应格式
X-TIMESTAMP	是	String	ISO 8601 日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-05:00

响应体参数

字段	必填	类型	描述
code	是	String	API 响应状态码，表示操作结果格式：两位数字字符串成功："00"，错误：其他代码用于程序化响应处理
message	是	String	人类可读的响应状态描述格式：UTF-8 编码字符串提供操作结果的详细信息根据请求语言进行本地化
orderNo	是	String	商户交易标识符格式：字母数字字符串与请求中提供的 orderNo 相同用于交易跟踪和对账
merchant	是	Object	商户信息容器包含商户识别和账户详情参见商户模型
merchantId	是	String	平台分配的主要商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	否	String	商户业务名称，用于显示格式：UTF-8 编码字符串用于交易识别和客户显示
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于复杂的商户层级结构
subMerchantName	否	String	子商户业务名称，用于显示格式：UTF-8 编码字符串用于多级结构中的交易识别
accountNo	否	String	交易处理的商户账户号格式：字母数字字符串用于账户识别和余额管理
money	是	Object	交易金额和货币规范包含确认的交易金额和货币参见货币模型
currency	是	String	ISO 4217 货币代码规范固定值：PEN（秘鲁索尔）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000 表示 PEN 20000 范围：100-999999999
transactionTime	是	String	交易处理时间戳格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-05:00 时区：UTC-5（秘鲁时区）
channel	是	Object	支付渠道信息容器包含支付方式和处理详情参见渠道模型
paymentMethod	是	String	用于交易处理的支付方式格式：预定义支付方式代码示例：CASHIER_PE 表示实际使用的支付渠道
paymentUrl	是	String	客户完成支付的支付处理 URL 格式：有效的 HTTP/HTTPS URL 用于重定向客户完成支付
additionalInfo	否	Object	额外的支付渠道信息格式：JSON 对象包含补充的支付处理详情
paymentUrl	否	String	特定支付方式的替代支付 URL 格式：有效的 HTTP/HTTPS URL 用于专门的支付处理流程
tradeNo	否	String	内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
status	否	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING, SUCCESS, FAILED 表示交易的当前状态参见状态模型

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-05:00

{
    "channel": {
        "additionalInfo": {
            "paymentUrl": "https://pay-met.pe:8080/#/metodo-pago/VE9LRU4gR0VORVJBIFJFQ1VETzg5OTc0MA=="
        },
        "paymentMethod": "CASHIER_PE",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1512001125042115424463245"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11520011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "成功",
    "money": {
        "amount": 20000,
        "currency": "PEN"
    },
    "orderNo": "20011563d9094aa7d4d9e9b933bb",
    "status": "处理中",
    "tradeNo": "1512001125042115424463245",
    "transactionTime": "2025-04-21T03:42:47-05:00"
}

通知

HTTP 请求

字段	必填	类型	描述
Content-Type	是	String	HTTP 内容类型规范固定值：application/json 用于正确解析请求
X-TIMESTAMP	是	String	ISO 8601 日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-05:00 注意：必须是当前服务器时间，误差在 ±5 分钟内
X-SIGNATURE	是	String	请求认证的数字签名参见回调签名验证

请求体参数

字段	必填	类型	描述
orderNo	是	String	商户交易标识符格式：字母数字字符串与原始请求中提供的 orderNo 相同用于交易跟踪和对账
tradeNo	是	String	内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
merchantId	是	String	平台分配的主要商户标识符格式：字母数字字符串用于商户认证和交易路由
merchantName	是	String	商户业务名称，用于显示格式：UTF-8 编码字符串用于交易识别和客户显示
subMerchantId	否	String	多级商户结构的子商户标识符格式：字母数字字符串用于复杂的商户层级结构
subMerchantName	否	String	子商户业务名称，用于显示格式：UTF-8 编码字符串用于多级结构中的交易识别
paymentMethod	是	String	用于交易处理的支付方式格式：预定义支付方式代码示例：CASHIER_PE 表示实际使用的支付渠道参见支付方式列表
transactionTime	是	String	交易处理时间戳格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-05:00 时区：UTC-5（秘鲁时区）
status	是	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING, SUCCESS, FAILED, CANCELLED 表示交易的当前状态参见状态模型
money	是	Object	交易金额和货币规范包含确认的交易金额和货币参见货币模型
currency	是	String	ISO 4217 货币代码规范固定值：PEN（秘鲁索尔）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000 表示 PEN 20000 范围：100-999999999
payer	否	Object	客户信息容器包含付款人识别和联系详情参见付款人模型

重要响应要求

通知响应： 请仅返回字符串 SUCCESS 以确认收到通知

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 20000,
    "currency": "PEN"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "151200012410241325417215",
  "transactionTime": "2020-12-17T10:55:00-05:00"
}

SUCCESS

API 收款交易

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

# 请求体示例 – 交易请求：

# 响应

# HTTP 响应

# 响应体参数

# 通知

# HTTP 请求

# 请求体参数

# 返回

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 交易请求：

响应

HTTP 响应

响应体参数

通知

HTTP 请求

请求体参数

返回