出账/代付
出账下单
接口地址
https://{$api_host}/api/remit
请求参数
| 字段名 | 变量名 | 必填 | 签名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|---|
| 商户号 ID | merid | 是 | 是 | string | 10086 | 平台创建商户分配给商户 id |
| 商户订单号 | tno | 是 | 是 | string | tno1234578910jqk | 商户提交的订单号,限 32 位以内,数字字母组合. |
| 总金额 | amt | 是 | 是 | string | 126.35 | 订单总金额,单位为元。 |
| 货币类型 | cur | 是 | 是 | string | PHP | 其他见货币列表。注意大写 |
| 通知地址 | notify_url | 是 | 是 | string | http://www.baidu.com | 异步通知。(在订单成功支付的时候回调 5s/10s/30s/180s/600s) |
| 出款账户信息 | acct | 是 | 是 | json | { "type": "bankcard", "code": "PH_GCASH", "name": "GCash", "number": "09959350888", "user": "BAOJUNTANG" } | 不同出账方式。数据不一样。请参考账户(Acct)说明 |
| 附加参数 | extra | 否 | 是 | string | 特定渠道发起交易时需要的额外参数 | |
| 签名 | sign | 是 | 否 | string | c380bec2bfd727a4..... | 签名,详见签名生成算法 |
!! 特别注意:
- 上述非必填字段空的时候签名需要过滤掉
- url签名的时候是需要进行urlencode的
- 金额单位保留两位小数。特别注意".00"会被省略。签名时候特被注意。
- 如果提交了acct数据则签名的时候需要进行“展开处理”. 详细见签名acct处理。
- acct数据字段见最后“acct类型示例”。如果不清楚则可以忽略这个。
!!!特别注意签名时,对于出款账户信息的处理!!!
参数示例
{
"merid": "10086",
"tno": "sn1234578910jqk",
"amt": "500.26",
"cur": "CNY", // 货币类型
"notify_url": "https://www.baidu.com", // 异步通知
"extra": "", // 附加参数 可为空值
"acct": {
"type": "bankcard",
"code": "PH_GCASH",//其他银行注意参考最下方银行代码
"name": "GCash",
"number": "09959350888",
"user": "BAOJUNTANG",//银行出款此项信息必须真实。不能包含特殊字符
}, // gcash demo
"sign": "9a9cba23f9075ff01b2ed2050f52f42d" // 签名
}
成功返回示例
http状态不是200或者拿到了类似{"code": 506800,"message": "商户信息错误"}包含code的信息表示下单失败。 偶尔上游会异常,下单可能会失败,请注意处理
{
"data":{
"sn": "sn123456",
"tno": "tno12345678910jqk",
"amt": "100.00",
"fee": "2.00",
"cur": "CNY",
"ctm": "2008-08-08 08:08:08",
"sts": "submit",
}
}
tips:
- 出款提交。只要http状态正常(200),一般都会是成功的。
- 测试期间,如果想模拟出款失败的情况,可以提交金额 123.45。
- 测试期间,你的出款并不会真的到账。但只要提单正常,就表示流程正常了。
- 测试完毕需要通知客服人员切换正式出款通道
请参考账户(Acct)说明
出账查询
接口地址
https://{$api_host}/api/remit/query
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 商户号 | merid | 是 | string | 10086 | 创建分配给商户的数字号。非登录账号 |
| 平台单号 | sn | 是 | string | sn1234578910jqk | 我方的单号。不是贵公司的业务单号 |
| 商户单号 | tno | 是 | string | tno1234578910jqk | 商户提交的订单号 |
| 签名 | sign | 是 | string | c380bec2bfd727a4..... | 签名,详见签名生成算法 |
!!!
- 平台单号、商户单号。至少要提供一个。商户单号只能查询到近3日数据
请求参数示例
{
"merid": "10086",
"sn": "sn1234578910jqk",
"sign":"9a9cba2119075ff01b2ed2050f52f42d"
}
返回参数说明
| 字段名 | 变量名 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
| 商户号 | merid | string | 10086 | 创建分配给商户的数字号。非登录账号 |
| 平台订单号 | sn | string | sn12345678 | 返回的订单号 |
| 商户订单号 | tno | string | tno1234578910jqk | 商户提交的订单号 |
| 创建交易时间 | ctm | string | 2008-08-08 08:08:08 | 订单创建时间时间戳 |
| 订单金额 | amt | string | 126.35 | 订单总金额,单位为元,详见支付金额 |
| 货币类型 | cur | string | CNY | 符合 ISO4217 标准的三位字母代码, |
| 应结订单金额 | sett_amt | float | 5.20 | 应结订单金额 |
| 订单状态 | sts | string | success | success-处理成功 其他情况见 出账订单状态说明 |
| 签名 | sign | string | 1d48ac07237fa.. | 验证信息是否正确 |
成功返回示例
{
"data":{
"sn": "sn123456",
"tno": "tno12345678910jqk",
"amt": "100.00",
"fee": "2.00",
"cur": "CNY",
"ctm": "2008-08-08 08:08:08",
"sts": "submit",
}
}
出账订单状态说明
| 状态值 | 说明 |
|---|---|
| submit | 提交成功 |
| process | 处理中 |
| success | 成功 |
| fail | 失败 |
出账银行代码
菲律宾银行(PH-PHP)
| 代码 | 描述 |
|---|---|
| PH_ALB | AllBank (A Thrift Bank), Inc. |
| PH_APY | Alipay / Lazada Wallet |
| PH_AUB | Asia United Bank Corporation |
| PH_BCH | Bank of China |
| PH_BDO | BDO Unibank |
| PH_BGB | BanKo, A Subsidiary of BPI |
| PH_BMB | Bangko Mabuhay |
| PH_BOC | Bank of Commerce |
| PH_BPI | BPI / BPI Family Savings Bank |
| PH_BRB | Binangonan Rural Bank (BRBDigital) |
| PH_CBC | China Banking Corporation |
| PH_CBS | China Bank Savings, Inc. |
| PH_CCB | CTBC Bank (Philippines) Corporation |
| PH_CIS | Bayad |
| PH_CLB | Cebuana Lhuillier Bank / Cebuana Xpress |
| PH_CMG | Camalig Bank |
| PH_CPI | CIMB Philippines, Inc. |
| PH_CRD | CARD Bank Inc. |
| PH_DBI | Dungganon Bank (A Microfinance Rural Bank), Inc. |
| PH_DBP | Development Bank of the Philippines |
| PH_DCB | Dumaguete City Development Bank |
| PH_DCP | Coins.ph (DCPay) |
| PH_EQB | Equicom Savings Bank, Inc. |
| PH_ERB | Entrepreneur Rural Bank, Inc./ENTRP |
| PH_EWB | East West Banking Corporation |
| PH_EWR | Komo / EastWest Rural Bank |
| PH_GBY | GrabPay |
| PH_GCASH | GCash |
| PH_GOT | GoTyme Bank |
| PH_IEM | Infoserve / Nationlink |
| PH_ING | ING Bank N.V. |
| PH_IRI | I-Remit / iCASH |
| PH_ISL | ISLA Bank (A Thrift Bank), Inc. |
| PH_LBP | LANDBANK / OFBank |
| PH_LDB | Luzon Development Bank |
| PH_LSB | Legazpi Savings Bank |
| PH_MCB | Mindanao Consolidated CoopBank |
| PH_MET | Metropolitan Bank and Trust Co. |
| PH_MPI | Maybank Philippines, Inc. |
| PH_MSB | Malayan Bank Savings and Mortgage Bank, Inc. |
| PH_MYA | Maya Bank, Inc. |
| PH_NBK | Netbank |
| PH_ONB | BDO Network Bank |
| PH_OPI | OmniPay, Inc. |
| PH_PAR | Partner Rural Bank (Cotabato), Inc. |
| PH_PAS | Pacific Ace Savings Bank |
| PH_PBB | Philippine Business Bank, Inc., A Savings Bank |
| PH_PBC | Philippine Bank of Communications |
| PH_PNB | Philippine National Bank (PNB) |
| PH_PPI | PayMaya Philippines, Inc. |
| PH_PPS | PalawanPay |
| PH_PRB | Producers Bank |
| PH_PSB | Philippine Savings Bank |
| PH_PTC | Philippine Trust Company |
| PH_PVB | Philippine Veterans Bank |
| PH_QCB | Queenbank |
| PH_QRB | Quezon Capital Rural Bank |
| PH_RBG | Asenso |
| PH_RBN | Robinsons Bank Corporation |
| PH_RCI | RCBC/DiskarTech |
| PH_SBA | Sterling Bank of Asia, Inc (A Savings Bank) |
| PH_SCB | Standard Chartered Bank |
| PH_SEA | Seabank |
| PH_SEC | Security Bank Corporation |
| PH_SME | CARD SME Bank |
| PH_SPP | ShopeePay |
| PH_SPY | Starpay |
| PH_SSB | Sun Savings Bank, Inc. |
| PH_TCI | TayoCash |
| PH_TDB | Tonik Bank |
| PH_TPI | TraxionPay/DigiCOOP/COOPNET |
| PH_UBP | Union Bank of the Philippines |
| PH_UCP | United Coconut Planters Bank (UCPB) |
| PH_UDB | UnionDigital Bank |
| PH_UMS | USSC Money Services |
| PH_UNO | UNObank |
| PH_USB | UCPB Savings Bank |
| PH_WDB | Wealth Development Bank |
| PH_ZTI | JuanCash (Zybi Tech Inc.) |
巴基斯坦银行(PK-PKR)
| 代码 | 描述 |
|---|---|
| PK_EASYPAISA | Easypaisa |
| PK_UPAISA | Upaisa |
| PK_JAZZCASH | JazzCash |