签名规则

所有需要签名的接口均遵循以下签名规则。

  1. 将所有非空参数(标明不参与签名的除外)按参数名 ASCII 码从小到大排序(字典序),使用 key=value 格式拼接为 stringA
    注意:空值不参与签名;参数名区分大小写;sign 参数本身不参与签名。
  2. 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")

发起代收 POST

POST /payment/create

请求 Body 支持 form-data 和 JSON 格式。

请求参数

参数 类型 必填 描述
parterstringYes接口调用 ID
valuestringYes代收金额(单位:元)
typestringYes支付类型
orderidstringYes订单号
notifyurlstringYes异步通知地址(最长 200 字符)
ipstringNo客户端 IP不签名
remarkstringNo回调携带参数不签名
callbackurlstringYes支付成功后跳转页面
signstringYes签名
成功 200
失败 400
{
  "code": 200,
  "info": "success",
  "param": {
    "payment_url": "https://xxxxxx.com/?id=xxxx"
  }
}

代收查询 POST

POST /pay/query

请求参数

参数类型必填描述
parterstringYes商户 ID
orderidstringYes订单 ID

响应字段

字段类型描述
codestring状态码(同 state):200=支付成功,300=未支付,400=订单/商户不存在
statestring状态码(同 code):200=支付成功,300=未支付,400=订单/商户不存在
msgstring状态描述:payment success / unpaid / Order number does not exist
pricestring实际支付金额(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

GET {notifyurl}?parter=&orderid=&remark=&opstate=&ovalue=&sign=
验证成功后必须返回字符串 success

签名方式:opstate=值&orderid=值&ovalue=值&parter=商户ID&key=密钥

请求参数

参数类型必填描述
parterstringYes接口调用 ID
orderidstringYes订单号
remarkstringNo回调携带参数,非空时参与签名
opstatestringYes交易状态:0=未支付,1=已支付
ovaluestringYes支付金额
signstringYes签名
成功
失败
success

发起代付 POST

POST /pay/transfer
如果超时无响应或响应中缺少 code 字段,一律视为卡单,请联系客服确认。

请求参数

参数类型必填描述
parterstringYes接口调用 ID
order_nostringYes付款订单号
typestringYes支付类型
namestringYes收款人名称
account_numberstringYes收款账号
moneystringYes支付金额
notify_urlstringYes支付成功回调地址
signstringYes签名
成功 200
失败 400
{
  "code": "200",
  "info": "提交成功"
}

代付查询 V1 POST

POST /pay/transfer/query

请求参数

参数类型必填描述
parterstringYes接口调用 ID
order_nostringYes付款订单号

响应字段

字段类型描述
codenumber接口状态码:200=查询成功,404=订单/商户不存在
infostringsuccess 或失败原因(status=4 时为代付失败原因)
param.statusnumber代付订单状态,详见下方状态码表
param.pricenumber代付金额

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

POST /pay/transfer/query/detail

V2 在 V1 基础上额外返回 fee(手续费)、uporder(上游订单号)、completion_time(完成时间),且 info 字段会随状态返回 NOT_PROCESSED / PROCESSED / success / 失败原因。

请求参数

参数类型必填描述
parterstringYes接口调用 ID
order_nostringYes付款订单号

响应字段

字段类型描述
codenumber接口状态码:200=查询成功,404=订单/商户不存在
infostring状态描述,随 status 变化(见下表)
param.statusnumber代付订单状态,详见下方状态码表
param.pricestring代付金额
param.feestring代付手续费
param.uporderstring上游订单号(未提交时可能为空)
param.completion_timestring最近一次更新时间(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

GET {notify_url}?parter=&orderid=&opstate=&ovalue=&sign=&info=
验证成功后必须返回字符串 success

签名方式:opstate=值&orderid=值&ovalue=值&parter=商户ID&key=密钥

请求参数

参数类型必填描述
parterstringYes接口调用 ID
orderidstringYes订单号
opstatestringYes交易状态:0=支付失败,1=已支付
ovaluestringYes支付金额
signstringYes签名
infostringYes代付备注,不参与签名。失败返回原因,成功为空不签名
成功
失败
success

商户余额 POST

POST /payment/query/balance

请求参数

参数类型必填描述
parterstringYes接口调用 ID

响应字段

字段类型描述
codenumber200 为成功,其他为失败
infostring详情
param.balancenumber余额
成功 200
失败 400
{
  "code": 200,
  "info": "success",
  "param": {
    "balance": 63
  }
}

获取代付凭证 POST

POST /credentials?uorderid={uorderid}

请求参数

参数类型必填描述
uorderidstringYes代付订单号(Query 参数)

代收支付类型

发起代收时 type 字段可用的支付类型列表。

名称 银行代码
GCash扫码 / GCash QRGCashWAP
PayMayaMaya
Gotyme扫码 / Gotyme QRGotyme
MayaBusinessgcashwap-2

代付银行类型

发起代付时 type 字段可用的银行类型列表。

银行名称 银行代码
GCashGCash
PayMayamaya
Queen City Development Bank, Inc.QCDF
Rizal Commercial Banking Corp.rcbc
Metrobankmb
Producers Savings BankPSCO
Own BankOWNB
Banco Laguna, Inc. / Seabank Philippines, Inc.LAUI
G-Xchange Inc. / GCashGXCH
Zybi Tech Inc. / JuanCashGW_ZTI
Wealth Development BankGW_WDB
UCPB Savings BankGW_USB
UNObankGW_UNO
USSC Money ServicesGW_UMS
UnionDigital BankGW_UDB
United Coconut Planters BankGW_UCPB
Union Bank of the PhilippinesGW_UBP
TraxionPay/DigiCOOP/COOPNETGW_TPI
Tonik BankGW_TDB
TayoCashGW_TCI
Sun Savings Bank, Inc.GW_SSB
StarpayGW_SPY
ShopeePayGW_SPP
SpeedyPay/eMango PayGW_SPI
CARD SME BankGW_SME
Security Bank CorporationGW_SEC
SeabankGW_SEA
Standard Chartered BankGW_SCB
Sterling Bank of Asia, Inc (A Savings Bank)GW_SBA
RCBC/DiskarTechGW_RCI
Robinsons Bank CorporationGW_RBN
Rural Bank of Guinobatan / AsensoGW_RBG
Quezon Capital Rural BankGW_QRB
QueenbankGW_QCB
Veterans BankGW_PVB
Philippine Trust CompanyGW_PTC
Philippine Savings BankGW_PSB
Producers BankGW_PRB
PalawanPayGW_PPS
Maya Philippines, Inc./Maya WalletGW_PPI
PNB Savings BankGW_PNS
Philippine National Bank (PNB)GW_PNB
PDAXGW_PDX
Philippine Bank of CommunicationsGW_PBC
Philippine Business Bank, Inc., A Savings BankGW_PBB
Pacific Ace Savings BankGW_PAS
Partner Rural Bank (Cotabato), Inc.GW_PAR
OmniPay, Inc.GW_OPI
BDO Network BankGW_ONB
NetbankGW_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 CoopBankGW_MCB
Legazpi Savings BankGW_LSB
Luzon Development BankGW_LDB
Land Bank of The PhilippinesGW_LBP
I-Remit / iCASHGW_IRI
Infoserve / NationlinkGW_IEM
ISLA Bank (A Thrift Bank), Inc.GW_IBI
GoTyme BankGW_GOT
GrabPayGW_GBY
East West Rural Bank / KomoGW_EWR
East West Banking CorporationGW_EWB
Entrepreneur Rural Bank, Inc./ENTRPGW_ERB
Equicom Savings Bank, Inc.GW_EQB
DCPay / COINS.PHGW_DCP
DCPay Philippines Inc.GW_DCP
Development Bank of the PhilippinesGW_DBP
Dungganon Bank (A Microfinance Rural Bank), Inc.GW_DBI
CARD Bank Inc.GW_CRD
CIMB Philippines, Inc.GW_CPI
Camalig BankGW_CMG
Cebuana Lhuillier Bank / Cebuana XpressGW_CLB
CIS Bayad Center / BayadGW_CIS
CTBC Bank (Philippines) CorporationGW_CCB
China Bank Savings, Inc.GW_CBS
Cantilan BankGW_CBI
China Banking CorporationGW_CBC
BPI / BPI Family Savings BankGW_BPI
Bank of CommerceGW_BOC
Bangko MabuhayGW_BMB
BanKo, A Subsidiary of BPIGW_BGB
BDO Unibank, Inc.GW_BDO
Bank of ChinaGW_BCH
Asia United Bank CorporationGW_AUB
Alipay / Lazada WalletGW_APY
AllBank (A Thrift Bank), Inc.GW_ALB
Gpay Network Ph, Inc. / GrabPayGHP
Dumaguete City Development BankDCDE
CARD MRICAM
Binangonan Rural Bank / BRBDigitalBIU
Banana Fintech / BananaPayBFB
China Bank Savingscbs
Banco De Oro Unibank, Inc (BDO)bdoui
Bank Of The Philippine Islands (BPI)botpi
MAYABUSINESSGW_MBS