API 文档

# 1、创建收款

用于商户发起收款请求，返回支付链接或二维码，供用户完成支付。

请求方式

  • Method：POST
  • URL：/api/v3/bra/createCollectingOrder
  • Content-Type：
Content-Type: application/json; charset=utf-8

请求头参数（Header）

Param Type Description Sample
access_key String 商户后台获取的访问密钥 pFqV75X3
timestamp int64 Unix 毫秒时间戳（13 位） 1679724896223
nonce String UUID V4 随机字符串 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign String 通过签名算法计算的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

上述参数全部作为 HTTP Header 传入

请求体数据示例

{
  "amount": "21.1",
  "channelType": "PIX",
  "externalOrderId": "389508808434869257",
  "notifyUrl": "http://192.168.135:30002/abc",
  "remark": "123",
  "returnUrl": "http://192.168.135:30002/abc"
}

参数说明：

参数名 类型 是否必填 描述
amount String 是 收款金额，小数点不能超过 2 位。单位：BRL（巴西雷亚尔）
channelType String 是 渠道类型，枚举值：PIX
externalOrderId String(64) 是 商户系统中的唯一订单编号
userInfoType String(64) 否 用户信息类型（如：CPF, PHONE 等）
userInfoNo String(64) 否 用户信息编号（如 CPF 号码）
userInfoName String(255) 否 用户姓名
notifyUrl String 是 支付完成后回调地址（服务端）
remark String 否 商户自定义备注信息
returnUrl String 否 用户支付成功后跳转地址（前端）

响应类型：

Header: { 'Content-Type': 'application/json;charset=utf-8'}

创建收款响应说明：

正常响应数据示例（HTTP 200）

{
  "code": "200",
  "success": true,
  "msg": "成功",
  "msgEn": "SUCCESS",
  "data": {
    "cashierCurrencyAmount": "21.1",
    "cashierExpireTime": 1690431343212,
    "cashierId": "OCURRPAID202307270345411690429541853DOCKER020000000200000775",
    "cashierUrl": "http://192.168.1.74:88/OCURRPAID202307270345411690429541853DOCKER020000000200000775?...",
    "currency": "BRL",
    "currencyOrderVo": {
      "amount": "21.1",
      "currency": "BRL",
      "externalOrderId": "828905760411449635",
      "orderId": "OCURRPAID202307270345431690429543531DOCKER020000000400000776",
      "orderStatus": "Wait pay",
      "orderStatusCode": 1,
      "orderTime": 1690429543571,
      "payParam": "...",
      "payType": 101,
      "tradeNote": "123"
    },
    "isCreateOrder": true,
    "isHiddenMerchantLogo":null,
    "isHiddenMerchantName":null,
    "payType": 101,
    "returnUrl": "http://192.168.135:30002/abc",
    "userInfoName": "Alisha Lovetinsky",
    "userInfoNo": "00828761000",
    "userInfoType": "CPF",
    "version":null,
    "payTypeCode": "PIX"
  }
}

响应参数说明

参数名 类型 描述
cashierCurrencyAmount String 收款金额（展示用，与订单金额一致）
cashierExpireTime int64 收银台过期时间（时间戳）
cashierId String 收银台订单 ID
cashierUrl String 跳转收银台支付链接
currency String 币种编码（如：BRL）
amount String 订单原始金额，创建订单时发起的金额。
externalOrderId String 商户订单号
orderId String 系统订单 ID
orderStatus String 订单状态描述（如：Wait pay）
orderStatusCode int64 订单状态码： 1=待支付； 2=支付成功（终态）
orderTime int64 订单创建时间（时间戳）
payParam String 支付参数（符合巴西 PIX 标准的支付码，可直接用于生成二维码），可通过该参数进行支付页面的自建
tradeNote String 交易备注信息
isCreateOrder bool 是否成功创建订单，true/false
payType int64 支付类型编码（如：101=PIX）
returnUrl String 支付完成后跳转地址（前端）
userInfoName String 用户姓名
userInfoNo String 用户信息编号（如 CPF 号码）
userInfoType String 用户信息类型（如：CPF, PHONE 等）
payTypeCode String 支付通道标识（如：PIX, TED）
isHiddenMerchantLogo bool 是否隐藏商户标志
isHiddenMerchantName bool 是否隐藏商户名称
version String 版本

← 2、创建代付 →