签名规则
所有需要签名的接口均遵循以下签名规则。
-
将所有非空参数(标明不参与签名的除外)按参数名 ASCII 码从小到大排序(字典序),使用
key=value格式拼接为stringA。
注意:空值不参与签名;参数名区分大小写;sign参数本身不参与签名。 -
在
stringA末尾拼接&key=YourSecretKey,对结果执行 MD5 并转为小写,即为sign值。
sign = MD5( K1=V1&K2=V2&...&Kn=Vn&key=SecretKey ).toLowerCase()
示例
参数: parter=11111111111111, type=2222222222222222222, key=333333333333333333333333333
stringA = "parter=11111111111111&type=2222222222222222222"
sign = MD5(stringA + "&key=333333333333333333333333333")
sign = MD5(stringA + "&key=333333333333333333333333333")
发起代收 POST
请求 Body 支持 form-data 和 JSON 格式。
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| value | string | Yes | 代收金额(单位:元) |
| type | string | Yes | 支付类型 |
| orderid | string | Yes | 订单号 |
| notifyurl | string | Yes | 异步通知地址(最长 200 字符) |
| ip | string | No | 客户端 IP不签名 |
| remark | string | No | 回调携带参数不签名 |
| callbackurl | string | Yes | 支付成功后跳转页面 |
| sign | string | Yes | 签名 |
成功 200
失败 400
{
"code": 200,
"info": "success",
"param": {
"payment_url": "https://xxxxxx.com/?id=xxxx"
}
}
代收查询 POST
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 商户 ID |
| orderid | string | Yes | 订单 ID |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
| code | string | 状态码(同 state):200=支付成功,300=未支付,400=订单/商户不存在 |
| state | string | 状态码(同 code):200=支付成功,300=未支付,400=订单/商户不存在 |
| msg | string | 状态描述:payment success / unpaid / Order number does not exist |
| price | string | 实际支付金额(200/300 时返回) |
状态码
| code / state | 含义 | msg |
|---|---|---|
| 200 | 支付成功 | payment success |
| 300 | 订单存在但未支付(待支付/处理中) | unpaid |
| 400 | 订单不存在或商户校验失败 | Order number does not exist |
支付成功 200
未支付 300
失败 400
{
"code": "200",
"state": "200",
"msg": "payment success",
"price": "100.00"
}
代收通知 GET
验证成功后必须返回字符串 success。
签名方式:opstate=值&orderid=值&ovalue=值&parter=商户ID&key=密钥
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| orderid | string | Yes | 订单号 |
| remark | string | No | 回调携带参数,非空时参与签名 |
| opstate | string | Yes | 交易状态:0=未支付,1=已支付 |
| ovalue | string | Yes | 支付金额 |
| sign | string | Yes | 签名 |
成功
失败
success
发起代付 POST
如果超时无响应或响应中缺少 code 字段,一律视为卡单,请联系客服确认。
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| order_no | string | Yes | 付款订单号 |
| type | string | Yes | 支付类型 |
| name | string | Yes | 收款人名称 |
| account_number | string | Yes | 收款账号 |
| money | string | Yes | 支付金额 |
| notify_url | string | Yes | 支付成功回调地址 |
| sign | string | Yes | 签名 |
成功 200
失败 400
{
"code": "200",
"info": "提交成功"
}
代付查询 V1 POST
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| order_no | string | Yes | 付款订单号 |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
| code | number | 接口状态码:200=查询成功,404=订单/商户不存在 |
| info | string | success 或失败原因(status=4 时为代付失败原因) |
| param.status | number | 代付订单状态,详见下方状态码表 |
| param.price | number | 代付金额 |
param.status 状态码
| status | 含义 | 说明 |
|---|---|---|
| 1 | 未处理 | 订单已创建,尚未提交至上游 |
| 2 | 处理中 | 已提交上游,等待结果 |
| 3 | 代付成功 | 终态:上游已成功打款 |
| 4 | 代付失败 | 终态:失败原因见 info 字段 |
成功 200
失败 404
{
"code": 200,
"info": "success", // status=4 时为失败原因
"param": {
"status": 3, // 1=未处理 2=处理中 3=成功 4=失败
"price": 100
}
}
代付查询 V2 POST
V2 在 V1 基础上额外返回 fee(手续费)、uporder(上游订单号)、completion_time(完成时间),且 info 字段会随状态返回 NOT_PROCESSED / PROCESSED / success / 失败原因。
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| order_no | string | Yes | 付款订单号 |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
| code | number | 接口状态码:200=查询成功,404=订单/商户不存在 |
| info | string | 状态描述,随 status 变化(见下表) |
| param.status | number | 代付订单状态,详见下方状态码表 |
| param.price | string | 代付金额 |
| param.fee | string | 代付手续费 |
| param.uporder | string | 上游订单号(未提交时可能为空) |
| param.completion_time | string | 最近一次更新时间(ISO 8601 / UTC) |
param.status 状态码
| status | 含义 | info | 说明 |
|---|---|---|---|
| 1 | 未处理 | NOT_PROCESSED | 订单已创建,尚未提交至上游 |
| 2 | 处理中 | PROCESSED | 已提交上游,等待结果 |
| 3 | 代付成功 | success | 终态:上游已成功打款 |
| 4 | 代付失败 | 失败原因 | 终态:info 返回具体失败原因 |
成功 200
失败 404
{
"code": 200,
"info": "success", // 根据 status 返回 NOT_PROCESSED / PROCESSED / success / 失败原因
"param": {
"status": 3, // 1=未处理 2=处理中 3=成功 4=失败
"price": "100.00",
"fee": "0.00",
"uporder": "000001",
"completion_time": "2025-01-07T05:22:33.000000Z"
}
}
代付通知 GET
验证成功后必须返回字符串 success。
签名方式:opstate=值&orderid=值&ovalue=值&parter=商户ID&key=密钥
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
| orderid | string | Yes | 订单号 |
| opstate | string | Yes | 交易状态:0=支付失败,1=已支付 |
| ovalue | string | Yes | 支付金额 |
| sign | string | Yes | 签名 |
| info | string | Yes | 代付备注,不参与签名。失败返回原因,成功为空不签名 |
成功
失败
success
商户余额 POST
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| parter | string | Yes | 接口调用 ID |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
| code | number | 200 为成功,其他为失败 |
| info | string | 详情 |
| param.balance | number | 余额 |
成功 200
失败 400
{
"code": 200,
"info": "success",
"param": {
"balance": 63
}
}
获取代付凭证 POST
请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| uorderid | string | Yes | 代付订单号(Query 参数) |
代收支付类型
发起代收时 type 字段可用的支付类型列表。
| 名称 | 银行代码 |
|---|---|
| GCash扫码 / GCash QR | GCashWAP |
| PayMaya | Maya |
| Gotyme扫码 / Gotyme QR | Gotyme |
| MayaBusiness | gcashwap-2 |
代付银行类型
发起代付时 type 字段可用的银行类型列表。
| 银行名称 | 银行代码 |
|---|---|
| GCash | GCash |
| PayMaya | maya |
| Queen City Development Bank, Inc. | QCDF |
| Rizal Commercial Banking Corp. | rcbc |
| Metrobank | mb |
| Producers Savings Bank | PSCO |
| Own Bank | OWNB |
| Banco Laguna, Inc. / Seabank Philippines, Inc. | LAUI |
| G-Xchange Inc. / GCash | GXCH |
| Zybi Tech Inc. / JuanCash | GW_ZTI |
| Wealth Development Bank | GW_WDB |
| UCPB Savings Bank | GW_USB |
| UNObank | GW_UNO |
| USSC Money Services | GW_UMS |
| UnionDigital Bank | GW_UDB |
| United Coconut Planters Bank | GW_UCPB |
| Union Bank of the Philippines | GW_UBP |
| TraxionPay/DigiCOOP/COOPNET | GW_TPI |
| Tonik Bank | GW_TDB |
| TayoCash | GW_TCI |
| Sun Savings Bank, Inc. | GW_SSB |
| Starpay | GW_SPY |
| ShopeePay | GW_SPP |
| SpeedyPay/eMango Pay | GW_SPI |
| CARD SME Bank | GW_SME |
| Security Bank Corporation | GW_SEC |
| Seabank | GW_SEA |
| Standard Chartered Bank | GW_SCB |
| Sterling Bank of Asia, Inc (A Savings Bank) | GW_SBA |
| RCBC/DiskarTech | GW_RCI |
| Robinsons Bank Corporation | GW_RBN |
| Rural Bank of Guinobatan / Asenso | GW_RBG |
| Quezon Capital Rural Bank | GW_QRB |
| Queenbank | GW_QCB |
| Veterans Bank | GW_PVB |
| Philippine Trust Company | GW_PTC |
| Philippine Savings Bank | GW_PSB |
| Producers Bank | GW_PRB |
| PalawanPay | GW_PPS |
| Maya Philippines, Inc./Maya Wallet | GW_PPI |
| PNB Savings Bank | GW_PNS |
| Philippine National Bank (PNB) | GW_PNB |
| PDAX | GW_PDX |
| Philippine Bank of Communications | GW_PBC |
| Philippine Business Bank, Inc., A Savings Bank | GW_PBB |
| Pacific Ace Savings Bank | GW_PAS |
| Partner Rural Bank (Cotabato), Inc. | GW_PAR |
| OmniPay, Inc. | GW_OPI |
| BDO Network Bank | GW_ONB |
| Netbank | GW_NBK |
| Maya Bank, Inc. | GW_MYA |
| Malayan Bank Savings and Mortgage Bank, Inc. | GW_MSB |
| Maybank Philippines, Inc. | GW_MPI |
| Metropolitan Bank and Trust Co. | GW_MET |
| Mindanao Consolidated CoopBank | GW_MCB |
| Legazpi Savings Bank | GW_LSB |
| Luzon Development Bank | GW_LDB |
| Land Bank of The Philippines | GW_LBP |
| I-Remit / iCASH | GW_IRI |
| Infoserve / Nationlink | GW_IEM |
| ISLA Bank (A Thrift Bank), Inc. | GW_IBI |
| GoTyme Bank | GW_GOT |
| GrabPay | GW_GBY |
| East West Rural Bank / Komo | GW_EWR |
| East West Banking Corporation | GW_EWB |
| Entrepreneur Rural Bank, Inc./ENTRP | GW_ERB |
| Equicom Savings Bank, Inc. | GW_EQB |
| DCPay / COINS.PH | GW_DCP |
| DCPay Philippines Inc. | GW_DCP |
| Development Bank of the Philippines | GW_DBP |
| Dungganon Bank (A Microfinance Rural Bank), Inc. | GW_DBI |
| CARD Bank Inc. | GW_CRD |
| CIMB Philippines, Inc. | GW_CPI |
| Camalig Bank | GW_CMG |
| Cebuana Lhuillier Bank / Cebuana Xpress | GW_CLB |
| CIS Bayad Center / Bayad | GW_CIS |
| CTBC Bank (Philippines) Corporation | GW_CCB |
| China Bank Savings, Inc. | GW_CBS |
| Cantilan Bank | GW_CBI |
| China Banking Corporation | GW_CBC |
| BPI / BPI Family Savings Bank | GW_BPI |
| Bank of Commerce | GW_BOC |
| Bangko Mabuhay | GW_BMB |
| BanKo, A Subsidiary of BPI | GW_BGB |
| BDO Unibank, Inc. | GW_BDO |
| Bank of China | GW_BCH |
| Asia United Bank Corporation | GW_AUB |
| Alipay / Lazada Wallet | GW_APY |
| AllBank (A Thrift Bank), Inc. | GW_ALB |
| Gpay Network Ph, Inc. / GrabPay | GHP |
| Dumaguete City Development Bank | DCDE |
| CARD MRI | CAM |
| Binangonan Rural Bank / BRBDigital | BIU |
| Banana Fintech / BananaPay | BFB |
| China Bank Savings | cbs |
| Banco De Oro Unibank, Inc (BDO) | bdoui |
| Bank Of The Philippine Islands (BPI) | botpi |
| MAYABUSINESS | GW_MBS |