帮助中心 – Omopay

支付请求接口说明
1，接口标准
在代收接口中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	对接参数里查询
请求方式	POST 请不要用 GET 方式提交，Content-Type:application/json和Content-Type:application/x-www-form-urlencoded都支持

参数名称	参数含义	参与签名	必填	说明
pay_memberid	商户号	是	是	平台分配商户号
pay_orderid	商户订单号	是	是	上送订单号唯一, 字符长度20
pay_amount	订单金额	是	是	订单金额如：100
pay_applydate	提交时间	是	是	时间格式：2023-12-28 18:18:18
pay_md5sign	MD5签名	否	是	请看MD5签名处理
pay_bankcode	通道编码	是	是	开发文档[附件]银行编码参考，或通道费率中查看
pay_notifyurl	异步回调	是	是	请给出有效的地址,地址后可以携带自定义get(?a=1&b=2)参数。（POST返回数据）
pay_callbackurl	同步回调	否	否	请给出有效的地址,地址后可以携带自定义get(?a=1&b=2)参数。（POST返回数据）
pay_productname	商品名称	否	否	商品名称
pay_attach	附加字段	否	否	此字段在返回时按原样返回 (中文需要url编码)。菲律宾必填客户真实IP地址

默认返回数据：json
{
    "status":"1",
    "msg":"success",
    "pay_amount":"100",
    "pay_orderid":"20210928114755985410",
    "payUrl":"http://xxx.xxx.cc/index/index/cashier.html?osn=20210928114755985410"
}
如果失败返回:
{
    "status":"error",
    "msg":"错误原因",
    "data":[]
}
如果type不为json或其他值，则系统直接将转跳至支付页面

支付异步通知说明
1，接口标准
在代收异步回调接口中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	此回调不需要网关，根据你传递异步回调地址传参,只回调交易成功的订单信息。
返回方式	POST返回json数据

参数名称	参数含义	参与签名	参数说明
memberid	商户编号	是	平台分配商户号
orderid	平台订单号	是	订单号唯一, 字符长度20
amount	订单金额	是	订单金额
true_amount	实际付款金额	是	订单金额，新增参数，参与签名,回调的实际付款金额，以此参数为准
transaction_id	交易流水号	是	交易流水号
datetime	交易成功时间	是	时间格式：2018-12-28 18:18:18
returncode	交易状态	是	“00” 为成功
attach	扩展返回	否	商户附加数据返回
sign	签名	否	请看MD5签名处理

返回数据格式：string
返回文本均为小写不能有任何其它字符。
处理完成返回:ok

支付订单查询说明
1，接口标准
在代收查询中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	对接参数里查询
请求方式	POST 请不要用 GET 方式提交，Content-Type:application/json和Content-Type:application/x-www-form-urlencoded都支持

参数名称	参数含义	是否必填	参与签名	参数说明
pay_memberid	商户号	是	是	平台分配商户号
pay_orderid	商户订单号	是	是	上送订单号唯一, 字符长度20
pay_md5sign	数据签名	否	否	请看MD5签名处理

默认返回数据：json
{
     "memberid":"商户编号",
     "orderid":"商户订单号",
     "amount":"订单金额",
     "true_amount":"实付金额",
     "time_end":"支付成功时间",
     "transaction_id":"交易流水号",
     "returncode":"交易状态",
     "trade_state":"支付状态:SUCCESS=已支付，NOTPAY=未支付",
     "sign":"签名",
}

代付接口说明
1，接口标准
在代付接口中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	对接参数里查询
请求方式	POST 请不要用 GET 方式提交，Content-Type:application/json和Content-Type:application/x-www-form-urlencoded都支持

参数名称	参数含义	是否必填	参与签名	参数说明
mchid	商户号	是	是	平台分配商户号
out_trade_no	商户订单号	是	是	上送订单号唯一, 字符长度32以内
currency	币种	是	是	详细请参考可交易币种
money	代付金额	是	是
bankname	收款银行编号	是	是	联系业务人员印度IMPS 巴西代付可随意固定此参数秘鲁上传银行卡账户菲律宾gcash填gcash 菲律宾maya填maya 菲律宾bank填银行编号巴基斯坦JAZZCASH钱包填JAZZCASH 巴基斯坦EASYPAISA钱包填EASYPAISA
accountname	收款人姓名	是	是	lizi （一般为字母）
cardnumber	收款人账号	是	是	账号巴西TED格式应为(账号-账号digit) 例如453532-2 肯尼亚填9位真实手机号土耳其网银填IBAN账户土耳其钱包填IBAN/PAPARA 账户
notifyurl	通知回调地址	是	是	通知回调地址
pay_md5sign	数据签名	是	否	请看MD5签名处理
province	省份	否	否	印度BANK填IFSC号码巴西填CPF号码哥伦比亚填身份证号(8-11 位) 菲律宾BANK填IFSC号码秘鲁上传CCI账号巴基斯坦填身份证号
city	城市	否	否	巴西BANK填银行账号确认码巴基斯坦填银行iban，需要PK开头，也可以PK+身份证
subbranch	支行	否	否	巴西TED、BANK填支行号码墨西哥BANK填支行号码
acc_phone	收款人电话	否	否	部分印度账户必填哥伦比亚必填（10位电话）
acc_email	收款人邮箱	否	否	部分印度账户必填，具体联系客服墨西哥BANK填支行号码
otherpara1	其他参数1	否	否	巴西TED填账号类型 (CC – conta corrente or CP – conta poupança) 巴西BANK填账号类型(CHECKING，SAVINGS) 巴西PIX填账号类型(CPF，CNPJ，PHONE，EMAIL，EVP )
otherpara2	其他参数2	否	否	巴西填TED，PIX，PICPAY ，BANK 墨西哥填 BANK，CLABE 印度填账号类型 BANK,UPI,PAYTM,默认为BANK 巴基斯坦填账号类型 BANK,WALLET,默认为WALLET

返回数据：json
{
     "status":"成功:success 失败：error",
     "msg":"状态描述",
     "transaction_id":"平台流水号,成功时返回",
}

代付异步通知接口说明
1，接口标准
在代付异步回调接口中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	此回调不需要网关，根据你传递异步回调地址传参,只回调交易成功的订单信息。
返回方式	POST返回json数据

属性	内容
版本	1.0
网关	此回调不需要网关，根据你传递异步回调地址传参,只回调交易成功的订单信息。
返回方式	POST返回json数据

参数名称	参数含义	参与签名	参数说明
memberid	商户编号	是	平台分配商户号
orderid	平台订单号	是	订单号唯一, 字符长度20
amount	订单金额	是	订单金额
true_amount	实际付款金额	是	订单金额，新增参数，参与签名,回调的实际付款金额，以此参数为准
transaction_id	交易流水号	是	交易流水号
returncode	交易状态	是	'2':出款成功 '3':出款失败 '1':处理中
sign	签名	否	请看MD5签名处理

返回数据格式：string
返回文本均为小写不能有任何其它字符。
处理完成返回:ok

代付订单查询说明
1，接口标准
在代付订单查询中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	对接参数里查询
请求方式	POST 请不要用 GET 方式提交，Content-Type:application/json和Content-Type:application/x-www-form-urlencoded都支持

请求参数名称	参数含义	参与签名	参数说明
out_trade_no	商户代付订单号	是	代付订单号唯一, 字符长度20
mchid	商户号	是	平台分配商户号
pay_md5sign	签名	否	请看MD5签名处理

代付结果查询返回字段：参数名称	参数含义	参与签名	参数说明
status	提现状态	是	success：请求成功,不代表业务成功 error：请求失败
msg	状态描述	是	代付结果描述
mchid	商户号	是	status=success时返回
out_trade_no	商户代付订单号	是	status=success时返回
amount	代付金额	是	status=success时返回
transaction_id	平台流水号	是	status=success时返回
refCode	业务状态	是	status=success时返回 refCode返回值：1 成功 2 失败
refMsg	业务描述	是	status=success时返回
success_time	代付成功时间	是	status=success，refCode=1时返回
pay_md5sign	签名	否	请看MD5签名处理

默认返回数据：json
注：当status=success和refCode=1同时成立时才表示转账成功
refCode返回值：返回值含义 1 成功 2 失败 3 处理中 4 待处理
5 审核驳回 6 待审核 7 交易不存在 8 未知状态

余额查询说明
1，接口标准
在代收查询中，数据通信是使用HTTP协议，请求数据以POST形式提交。
2，MD5签名处理
签名生成的通用步骤如下：第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
[1]. stringSignTemp="out_trade_no={value}&mchid={value}&key=key"
[2]. sign=MD5(stringSignTemp).toUpperCase(); pay_md5sign=$sign;

属性	内容
版本	1.00
网关	对接参数里查询
请求方式	POST 请不要用 GET 方式提交，Content-Type:application/json和Content-Type:application/x-www-form-urlencoded都支持

参数名称	参数含义	是否必填	参与签名	参数说明
pay_memberid	商户号	是	是	平台分配商户号
currency	货币	是	是	货币单位
pay_md5sign	数据签名	否	否	请看MD5签名处理

默认返回数据：json
{
     "memberid":"商户编号",
     "currency":"货币",
     "amount":"余额",
     "sign":"签名",
}