Docs
API文档
  • 简体中文
  • English
API文档
  • 简体中文
  • English
  • API文档

    • 统一约定
    • 入账/收款
    • 出账/代付
    • 账户余额
    • 交易查询
    • 异步通知(入账/出账)
    • 参数签名
    • 账户(Acct)说明
    • 特别说明/精度对账

出账/代付

出账下单

接口地址

https://{$api_host}/api/remit
请求参数
字段名变量名必填签名类型示例值描述
商户号 IDmerid是是string10086平台创建商户分配给商户 id
商户订单号tno是是stringtno1234578910jqk商户提交的订单号,限 32 位以内,数字字母组合.
总金额amt是是string126.35订单总金额,单位为元。
货币类型cur是是stringPHP其他见货币列表。注意大写
通知地址notify_url是是stringhttp://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是否stringc380bec2bfd727a4.....签名,详见签名生成算法

!! 特别注意:

  • 上述非必填字段空的时候签名需要过滤掉
  • 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:

  1. 出款提交。只要http状态正常(200),一般都会是成功的。
  2. 测试期间,如果想模拟出款失败的情况,可以提交金额 123.45。
  3. 测试期间,你的出款并不会真的到账。但只要提单正常,就表示流程正常了。
  4. 测试完毕需要通知客服人员切换正式出款通道

请参考账户(Acct)说明

出账查询

接口地址
https://{$api_host}/api/remit/query
请求参数
字段名变量名必填类型示例值描述
商户号merid是string10086创建分配给商户的数字号。非登录账号
平台单号sn是stringsn1234578910jqk我方的单号。不是贵公司的业务单号
商户单号tno是stringtno1234578910jqk商户提交的订单号
签名sign是stringc380bec2bfd727a4.....签名,详见签名生成算法

!!!

  • 平台单号、商户单号。至少要提供一个。商户单号只能查询到近3日数据
请求参数示例
{
  "merid": "10086",
  "sn": "sn1234578910jqk", 
  "sign":"9a9cba2119075ff01b2ed2050f52f42d"
}
返回参数说明
字段名变量名类型示例值描述
商户号meridstring10086创建分配给商户的数字号。非登录账号
平台订单号snstringsn12345678返回的订单号
商户订单号tnostringtno1234578910jqk商户提交的订单号
创建交易时间ctmstring2008-08-08 08:08:08订单创建时间时间戳
订单金额amtstring126.35订单总金额,单位为元,详见支付金额
货币类型curstringCNY符合 ISO4217 标准的三位字母代码,
应结订单金额sett_amtfloat5.20应结订单金额
订单状态stsstringsuccesssuccess-处理成功 其他情况见 出账订单状态说明
签名signstring1d48ac07237fa..验证信息是否正确

成功返回示例

{
  "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_ALBAllBank (A Thrift Bank), Inc.
PH_APYAlipay / Lazada Wallet
PH_AUBAsia United Bank Corporation
PH_BCHBank of China
PH_BDOBDO Unibank
PH_BGBBanKo, A Subsidiary of BPI
PH_BMBBangko Mabuhay
PH_BOCBank of Commerce
PH_BPIBPI / BPI Family Savings Bank
PH_BRBBinangonan Rural Bank (BRBDigital)
PH_CBCChina Banking Corporation
PH_CBSChina Bank Savings, Inc.
PH_CCBCTBC Bank (Philippines) Corporation
PH_CISBayad
PH_CLBCebuana Lhuillier Bank / Cebuana Xpress
PH_CMGCamalig Bank
PH_CPICIMB Philippines, Inc.
PH_CRDCARD Bank Inc.
PH_DBIDungganon Bank (A Microfinance Rural Bank), Inc.
PH_DBPDevelopment Bank of the Philippines
PH_DCBDumaguete City Development Bank
PH_DCPCoins.ph (DCPay)
PH_EQBEquicom Savings Bank, Inc.
PH_ERBEntrepreneur Rural Bank, Inc./ENTRP
PH_EWBEast West Banking Corporation
PH_EWRKomo / EastWest Rural Bank
PH_GBYGrabPay
PH_GCASHGCash
PH_GOTGoTyme Bank
PH_IEMInfoserve / Nationlink
PH_INGING Bank N.V.
PH_IRII-Remit / iCASH
PH_ISLISLA Bank (A Thrift Bank), Inc.
PH_LBPLANDBANK / OFBank
PH_LDBLuzon Development Bank
PH_LSBLegazpi Savings Bank
PH_MCBMindanao Consolidated CoopBank
PH_METMetropolitan Bank and Trust Co.
PH_MPIMaybank Philippines, Inc.
PH_MSBMalayan Bank Savings and Mortgage Bank, Inc.
PH_MYAMaya Bank, Inc.
PH_NBKNetbank
PH_ONBBDO Network Bank
PH_OPIOmniPay, Inc.
PH_PARPartner Rural Bank (Cotabato), Inc.
PH_PASPacific Ace Savings Bank
PH_PBBPhilippine Business Bank, Inc., A Savings Bank
PH_PBCPhilippine Bank of Communications
PH_PNBPhilippine National Bank (PNB)
PH_PPIPayMaya Philippines, Inc.
PH_PPSPalawanPay
PH_PRBProducers Bank
PH_PSBPhilippine Savings Bank
PH_PTCPhilippine Trust Company
PH_PVBPhilippine Veterans Bank
PH_QCBQueenbank
PH_QRBQuezon Capital Rural Bank
PH_RBGAsenso
PH_RBNRobinsons Bank Corporation
PH_RCIRCBC/DiskarTech
PH_SBASterling Bank of Asia, Inc (A Savings Bank)
PH_SCBStandard Chartered Bank
PH_SEASeabank
PH_SECSecurity Bank Corporation
PH_SMECARD SME Bank
PH_SPPShopeePay
PH_SPYStarpay
PH_SSBSun Savings Bank, Inc.
PH_TCITayoCash
PH_TDBTonik Bank
PH_TPITraxionPay/DigiCOOP/COOPNET
PH_UBPUnion Bank of the Philippines
PH_UCPUnited Coconut Planters Bank (UCPB)
PH_UDBUnionDigital Bank
PH_UMSUSSC Money Services
PH_UNOUNObank
PH_USBUCPB Savings Bank
PH_WDBWealth Development Bank
PH_ZTIJuanCash (Zybi Tech Inc.)

巴基斯坦银行(PK-PKR)

代码描述
PK_EASYPAISAEasypaisa
PK_UPAISAUpaisa
PK_JAZZCASHJazzCash
Prev
入账/收款
Next
账户余额