接口文档

下单接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/placeOrderByServer

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由平台分配
orderId	商户订单号	是	是	商户订单号,需唯一(只允许数字、字母、中划线、下划线的组合)
payType	支付类型	是	是	详见支付类型说明
amount	金额	是	是	保留两位小数
requestCurrency	请求货币	是	是	详见货币说明
asyncUrl	异步通知地址	是	是	异步通知的请求地址
syncUrl	同步通知地址	是	是	同步通知的请求地址
requestTime	请求时间	是	是	时间格式：yyyyMMddHHmmss
apiVersion	版本号	是	是	固定值：2
attach	备注	否	否	通知过程中会原样返回 ; 若不为空，需参与签名;
sign	签名	是	否	采用MD5签名，小写

支付类型说明

类型名	类型编码	类型名	类型编码	类型名	类型编码
easypaisa	70	jazzcash	71

货币说明

巴基斯坦卢比: 8

响应样例

下单异步回调接口

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: 下单参数 asyncUrl 值

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	下单时商户的订单号
amount	金额	是	是	保留两位小数
requestCurrency	请求货币	是	是	与下单请求货币一致
payType	支付类型	是	是	支付类型
apiVersion	版本号	是	是	与下单时的版本号一致
status	订单状态	是	是	详见订单状态说明
attach	备注	否	否	下单中attach值原样返回 ; 若不为空，需参与签名
sign	签名	是	否	采用MD5签名，小写

响应协议参数

商户系统收到异步通知后，需返回 success (小写)
若返回结果非 success ，会重复多次发送支付结果

订单状态

未支付: 0

支付成功: 2

失败: 3

下单查询接口支持 https

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/queryOrder

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户系统订单号
requestTime	请求时间	是	是	请求时间，格式为 yyyyMMddHHmmss
apiVersion	接口版本号	是	是	固定值： 2
sign	签名	是	否	采用MD5签名, 小写

响应协议参数

参数

参数名

必填

签名

说明

code

状态码

是

否

状态码（ 0：处理成功；非0：处理失败）

msg

状态描述

是

否

状态描述

content

请求时间

是

否

主体信息内容

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户订单号
amount	订单金额	是	是	保留2位小数
requestCurrency	请求货币	是	是	与下单请求货币一致
payType	支付类型	是	是	支付类型
attach	备注信息	否	否	下单中attach值原样返回 ; 若不为空，需参与签名
status	订单状态	是	是	订单状态
sign	签名	是	否	采用MD5签名，小写

响应实例

订单状态

未支付: 0

支付成功: 2

失败: 3

余额查询接口支持 https

接入方式: POST请求(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/balance/queryBalance

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由商户系统分配
requestCurrency	请求货币	是	是	8：巴基斯坦卢比
requestTime	请求时间	是	是	请求时间，格式为 yyyyMMddHHmmss
apiVersion	接口版本号	是	是	固定值： 2
sign	签名	是	否	采用MD5签名, 小写

响应协议参数

参数	参数名	必填	签名	说明
code	状态码	是	否	状态码（ 0：处理成功；非0：处理失败）
msg	状态描述	是	否	状态描述
balance	余额	是	否	余额
requestCurrency	币种	是	否	币种（8：巴基斯坦卢比）

响应实例

MD5签名说明

参数列表中，除去sign外，其他所有非空的参数都要参与签名，值为空的参数不用参与签名。
签名顺序按照参数名的字典顺序排序，若遇到相同的首字母，则看第二个字母，以此类推
将第2步组装成的字符串末尾添加 &secretKey=商家秘钥
组成规则如下：
参数名1=参数值1 & 参数名2=参数值2 …… 参数名n=参数值n & secretKey=商家秘钥
所有参与签名的参数值均不进行urlencode编码，都是使用原始值进行签名
secretKey为商户密钥，可从"商户后台->首页->查看秘钥"自行获取
MD5加密后需转换为小写
MD5前的字符串a=aa&b=bb&c=cc&secretKey=key
MD5加密后为3a6001d8ac3c91e75bc44c5c15bdcc3f

代付下单接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/placeCash

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由平台分配
orderId	商户订单号	是	是	商户订单号,需唯一(只允许数字、字母、中划线、下划线的组合)
amount	金额	是	是	保留两位小数
tradeType	交易类型	是	是	1：钱包；2：银行；
account	收款账户名	是	是	银行卡持有人名字
cardNo	银行卡号	是	是	银行卡号
bankName	银行编码	是	是	JAZZCASH 或 EASYPAISA 或者银行名称
depositBank	开户支行	是	是	开户支行
asyncUrl	异步通知地址	是	是	异步通知地址
timestamp	时间戳	是	是	请求时间，格式为 yyyyMMddHHmmss
cashType	下发类型(下发通道)	是	是	8：巴基斯坦卢比
requestCurrency	请求货币	是	是	8：巴基斯坦卢比
apiVersion	接口版本号	是	是	固定值： 2
attach	备注	否	否	通知过程中会原样返回 ; 若不为空，需参与签名;
sign	签名	是	否	采用MD5签名

响应协议参数 响应格式为 json

参数

参数名

必填

签名

说明

sign

签名

是

否

采用MD5签名

responseContent

主体信息内容

是

否

主体信息内容

参数	参数名	必填	签名	说明
code	状态码	是	是	详见响应状态码
msg	状态描述	是	是	状态描述
timestamp	时间戳	是	是	请求格式：yyyyMMddHHmmss
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户订单号
orderNo	平台订单号	是	是	平台订单号（下单失败，则为空）
status	订单状态	是	是	订单状态

响应样例

状态码

编码说明	编码值	编码说明	类型编码	编码说明	编码值
成功	0	系统错误	500	参数不能为空	550
无效参数	551	非法参数	552	不支持的参数	553
不存在的商户	560	商户已禁用	561	尚未初始化公钥	562
ip受限	563	签名错误	564	订单号重复	565
金额小于最低限制	566	金额大于最高限制	567	交易类型不支持	568
通道维护	569	余额不足	570	不存在的订单	580

订单状态

已受理: 0

成功: 1

失败: 2

银行编码

银行编码	银行名称	银行编码	银行名称
ACEH	Bank Aceh Syariah	ACEH_UUS	Bank Agris UUS
AGRIS	Bank IBK Indonesia	AGRONIAGA	Bank Agroniaga
ANDARA	Bank Andara	ANGLOMAS	Anglomas International Bank
ANZ	Bank ANZ Indonesia	ARTA_NIAGA_KENCANA	Bank Arta Niaga Kencana
ARTHA	Bank Artha Graha Internasional	ARTOS	Bank ARTOS/ Bank Jago
BALI	BPD Bali	BISNIS_INTERNASIONAL	Bank Bisnis Internasional
BANGKOK	Bangkok Bank	BANTEN	BPD Banten
BCA	Bank Central Asia(BCA)	BCA_SYR	Bank Central Asia (BCA) Syariah
BENGKULU	Bank Bengkulu	BJB	Bank Jawa Barat(BJB)
BJB_SYR	Bank BJB Syariah	BNI	Bank Negara Indonesia(BNI)
BNI_SYR	Bank BNI Syariah	BOC	BANK OF CHINA LIMITED
BRI	Bank Rakyat Indonesia(BRI)	BRI_SYR	Bank BRI Syariah
BNP_PARIBAS	Bank BNP Paribas	BSI	Bank Syariah Indonesia(BSI)
BTN	Bank Tabungan Negara (BTN)	BTN_UUS	Bank Tabungan Negara (BTN) UUS
BTPN	Bank BTPN	BTPN_SYARIAH	BTPN Syariah
BTPN_SYR	Bank BTPN Syariah	BUKOPIN	Wokee/Bukopin
BUKOPIN_SYR	Bank Bukopin Syariah	BUMI_ARTA	Bank Bumi Arta
CAPITAL	Bank Capital Indonesia	CHINATRUST	CTBC Indonesia
CNB	Centratama Nasional Bank(CNB)	CIMB	Bank CIMB Niaga
CIMB_UUS	Bank CIMB Niaga UUS	CITIBANK	Citibank
COMMONWEALTH	Bank Commonwealth	BPD_DIY	BPD DIY
DANAMON	Bank Danamon	DANAMON_UUS	Bank Danamon UUS
DBS	Bank DBS Indonesia	DINAR_INDONESIA	Bank Dinar Indonesia
DKI	Bank DKI	DKI_UUS	Bank DKI UUS
FAMA	Bank Fama International	EKA	Bank EKA
GANESHA	Bank Ganesha	HANA	LINE Bank/KEB Hana
HARDA_INTERNASIONAL	Allo Bank/Bank Harda Internasional	HIMPUNAN_SAUDARA	Bank Himpunan Saudara 1906
HSBC	HSBC	ICBC	Bank ICBC Indonesia
INA_PERDANA	Bank Ina Perdana	INDEX_SELINDO	Bank Index Selindo
INDIA	Bank of India Indonesia	JAMBI	Bank Jambi
JASA_JAKARTA	Bank Jasa Jakarta	JAWA_TENGAH	Bank Jateng
JATIM	Bank Jatim	JTRUST	Bank JTrust Indonesia
KALIMANTAN_BARAT	BPD Kalimantan Barat/Kalbar	KALIMANTAN_BARAT_UUS	BPD Kalimantan Barat UUS
KALIMANTAN_SELATAN	BPD Kalimantan Selatan/Kalsel	KALIMANTAN_SELATAN_UUS	BPD Kalimantan Selatan UUS
KALIMANTAN_TENGAH	BPD Kalimantan Tengah (Kalteng)	KALIMANTAN_TIMUR	BPD Kalimantan Timur
KALIMANTAN_TIMUR_UUS	BPD Kalimantan Timur UUS	KESEJAHTERAAN_EKONOMI	Seabank/Bank Kesejahteraan Ekonomi(BKE)
LAMPUNG	BPD Lampung	MALUKU	Bank Maluku
MANDIRI	Bank Mandiri	MANTAP	Bank MANTAP
MULTI_ARTA_SENTOSA	Bank Multi Arta Sentosa(MAS)	MAYBANK	Bank Maybank
MASPION	Bank Maspion Indonesia	MAYAPADA	Bank Mayapada
MAYBANK_SYR	Bank Maybank Syariah Indonesia	MAYORA	Bank Mayora Indonesia
MEGA	Bank Mega	MEGA_SYR	Bank Mega Syariah
MESTIKA_DHARMA	Bank Mestika Dharma	MNC_INTERNASIONAL	Motion/Bank MNC Internasional
MUAMALAT	Bank Muamalat Indonesia	MITRA_NIAGA	Bank Mitra Niaga
MIZUHO	Bank Mizuho Indonesia	NATIONALNOBU	Bank National Nobu
NUSA_TENGGARA_BARAT	BPD Nusa Tenggara Barat(NTB)	NUSA_TENGGARA_BARAT_UUS	BPD Nusa Tenggara Barat (NTB) UUS
NUSA_TENGGARA_TIMUR	BPD Nusa Tenggara Timur(NTT)	NUSANTARA_PARAHYANGAN	Bank Nusantara Parahyangan
OCBC	Bank OCBC NISP	OCBC_UUS	Bank OCBC NISP UUS
PANIN	Bank Panin	PANIN_SYR	Panin Dubai Syariah
PAPUA	Bank Papua	PERMATA	Bank Permata
PERMATA_UUS	Bank Permata UUS	PRIMA_MASTER	Bank Prima Master
QNB_KESAWAN	QNB KESAWAN	QNB_INDONESIA	QNB Indonesia
OKE	Bank Oke Indonesia	RABOBANK	Rabobank International Indonesia
RESONA	Bank Resona Perdania	RIAU_DAN_KEPRI	BPD Riau Dan Kepri
RIAU_DAN_KEPRI_UUS	BPD Riau Dan Kepri UUS	SAHABAT_SAMPOERNA	Bank Sahabat Sampoerna
SBI_INDONESIA	Bank SBI Indonesia	SHINHAN	Bank Shinhan Indonesia
SINARMAS	Bank Sinarmas	STANDARD_CHARTERED	Standard Chartered Bank
SULAWESI	Bank Sulteng	SULAWESI_TENGGARA	Bank Sultra
SULSELBAR	Bank Sulselbar	SULSELBAR_UUS	Bank Sulselbar UUS
SULUT	BPD Sulawesi Utara(SulutGo)	LINKAJA	LINKAJA
MUTIARA	Bank MUTIARA	SUMATERA_BARAT	BPD Sumatera Barat
SUMATERA_BARAT_UUS	BPD Sumatera Barat UUS	SUMSEL_DAN_BABEL	BPD Sumsel Babel
SUMSEL_DAN_BABEL_UUS	Bank Sumsel Babel UUS	SUMUT	Bank Sumut
SUMUT_UUS	Bank Sumut UUS	SINARMAS_UUS	Bank Sinarmas UUS
MITSUI	Bank Sumitomo Mitsui Indonesia	MANDIRI_SYR	Bank Syariah Mandiri(BSM)
TOKYO	Bank of Tokyo	UOB	TMRW/Bank UOB Indonesia
VICTORIA_INTERNASIONAL	Bank Victoria International	VICTORIA_SYR	Bank Victoria Syariah
WOORI	Bank Woori Saudara	YUDHA_BHAKTI	Neo Commerce/Bank Yudha Bhakti(BNC)
DAERAH_ISTIMEWA_UUS	BPD_Daerah_Istimewa_Yogyakarta_(DIY)	CENTRATAMA	Bank Centratama
CCB	CCB Indonesia	DEUTSCHE	Deutsche Bank
JPMORGAN	JPMORGAN CHASE BANK	MANDIRI_TASPEN	Bank Mandiri Taspen Pos
RBS	Royal Bank of Scotland (RBS)	OVO	OVO
DANA	DANA	GOPAY	GOPAY
MULTICOR	Bank MULTICOR	SHOPEEPAY	SHOPEEPAY

代付异步通知接口

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: 下单参数的asyncUrl值

参数信息

参数	参数名	必填	签名	说明
timestamp	时间戳	是	是	请求时间，格式为 yyyyMMddHHmmss
orderNo	平台订单号	是	是	平台订单号
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户订单号
amount	金额	是	是	保留两位小数
tradeType	交易类型	是	是	1：钱包；2：银行；
account	收款账户名	是	是	银行卡持有人名字
cardNo	银行卡号	是	是	银行卡号
bankName	银行编码	是	是	JAZZCASH 或 EASYPAISA 或者银行名称
depositBank	开户支行	是	是	开户支行
cashType	下发类型(下发通道)	是	是	8：巴基斯坦卢比
requestCurrency	请求货币	是	是	8：巴基斯坦卢比
apiVersion	接口版本号	是	是	接口版本号
attach	备注	否	否	通知过程中会原样返回 ; 若不为空，需参与签名
sign	签名	是	否	采用MD5签名
status	订单状态	是	是	订单状态

响应协议参数

商户系统收到异步通知后，需返回 success (小写)
若返回结果非 success ，会重复多次发送支付结果

订单状态

已受理: 0

成功: 1

失败: 2

代付查询接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/queryCash

参数信息

参数	参数名	必填	签名	说明
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户系统订单号
timestamp	时间戳	是	是	请求时间，格式为 yyyyMMddHHmmss
apiVersion	接口版本号	是	是	固定值： 2
sign	签名	是	否	采用MD5签名

响应协议参数 响应格式为json

参数

参数名

必填

签名

说明

sign

签名

是

否

采用MD5签名

responseContent

主体信息内容

是

否

主体信息内容

参数	参数名	必填	签名	说明
code	状态码	是	是	详见响应状态码
msg	状态描述	是	是	状态描述
timestamp	时间戳	是	是	请求格式：yyyyMMddHHmmss
merchno	商户号	是	是	商户号，由商户系统分配
orderId	商户订单号	是	是	商户订单号
orderNo	平台订单号	是	是	平台订单号（下单失败，则为空）
amount	订单金额	是	是	保留两位小数
account	收款账户名	是	是	银行卡持有人名字
tradeType	交易类型	是	是	1：对私；2：对公；（目前只支持对私交易）
cardNo	银行卡号	是	是	银行卡号
depositBank	开户支行	是	是	开户支行【IFSC CODE】
requestCurrency	请求货币	是	是	8：巴基斯坦卢比
attach	备注	否	否	下单中attach值原样返回;若不为空，需参与签名
status	订单状态	是	是	订单状态

响应样例

状态码

编码说明	编码值	编码说明	类型编码	编码说明	编码值
成功	0	系统错误	500	参数不能为空	550
无效参数	551	非法参数	552	不支持的参数	553
不存在的商户	560	商户已禁用	561	尚未初始化公钥	562
ip受限	563	签名错误	564	订单号重复	565
金额小于最低限制	566	金额大于最高限制	567	交易类型不支持	568
通道维护	569	余额不足	570	不存在的订单	580

下单接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/placeOrderByServer

下单异步回调接口

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: 下单参数 asyncUrl 值

下单查询接口支持 https

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/queryOrder

响应实例

余额查询接口支持 https

接入方式: POST请求(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/balance/queryBalance

响应实例

MD5签名说明

代付下单接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/placeCash

代付异步通知接口

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: 下单参数的asyncUrl值

代付查询接口支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/queryCash

DEMO下载

下单DEMO: java demo php demo

代付DEMO: java demo

下单接口 支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/placeOrderByServer

下单异步回调接口

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: 下单参数 asyncUrl 值

下单查询接口 支持 https

接入方式: POST请求 (application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/order/queryOrder

响应实例

余额查询接口 支持 https

接入方式: POST请求(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/balance/queryBalance

响应实例

MD5签名说明

代付下单接口 支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/placeCash

代付异步通知接口

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: 下单参数的asyncUrl值

代付查询接口 支持 https

接入方式: POST表单(application/x-www-form-urlencoded)

接入URL: https://www.xxxxxxxx.com/api/cash/queryCash

DEMO下载

下单DEMO: java demo php demo

代付DEMO: java demo

下单接口支持 https

下单查询接口支持 https

余额查询接口支持 https

代付下单接口支持 https

代付查询接口支持 https