API开发文档简介
本文阅读对象：使用 196PAY 商户自服务系统的技术架构师、研发工程师、系统运维工程师。通过本文档，商户可了解 196PAY 接入的技术、接入的产品业务、接入的流程、接入规范等信息，以便于商户顺利完成接入工作。
接入网关
请登录商户中心，API管理 开发文档中 查看网关地址和API对接参数。
代收下单接口
提交方式：POST
地址： 接入网关/Pay_Index.html
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| pay_memberid |
商户号 |
是 |
是 |
平台分配商户号 |
| pay_orderid |
订单号 |
是 |
是 |
上送订单号唯一, 字符长度20 |
| pay_applydate |
提交时间 |
是 |
是 |
时间格式：2016-12-26 18:18:18 |
| pay_bankcode |
通道编码 |
是 |
是 |
在商户中心/API管理查询 |
| pay_notifyurl |
服务端通知 |
是 |
是 |
服务端返回地址.（POST返回数据） |
| pay_callbackurl |
页面跳转通知 |
是 |
是 |
页面跳转返回地址（POST返回数据） |
| pay_amount |
订单金额 |
是 |
是 |
单位：元 |
| pay_md5sign |
MD5签名 |
是 |
否 |
请查看签名算法 |
| pay_productname |
商品名称 |
是 |
否 |
土耳其填入真实的姓名 |
| pay_format |
返回数据格式 |
否 |
否 |
固定传入值"json",为空时直接跳转付款界面 |
| pay_productnum |
商户品数量 |
否 |
否 |
|
| pay_productdesc |
商品描述 |
否 |
否 |
|
| pay_producturl |
商户链接地址 |
否 |
否 |
|
签名算法
第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。
第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
MD5运算前字符串拼接顺序：pay_amount=pay_amount&pay_applydate=pay_applydate&pay_bankcode=pay_bankcode&pay_callbackurl=pay_callbackurl&pay_memberid=pay_memberid&pay_notifyurl=pay_notifyurl&pay_orderid=pay_orderid&key=key
json返回值
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| code |
状态 |
是 |
成功:0 失败：非0（不代表业务成功） |
| msg |
状态描述 |
是 |
成功:success 失败：fail |
| data |
订单数据 |
是 |
成功时返回，具体返回信息参看《data订单数据》表 |
data订单数据
| 参数名称 |
参数含义 |
是否必填 |
参数说明 |
| pay_url |
支付地址 |
是 |
支付跳转地址 |
异步通知
提交方式：POST
接收到服务器点对点通讯时，在页面输出“OK”（ 没有双引号，OK 两个字母大写 ) ，否则会重复5次发送点对点通知.
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| memberid |
商户编号 |
是 |
是 |
平台分配商户号 |
| orderid |
订单号 |
是 |
是 |
上送订单号唯一, 字符长度20 |
| amount |
订单金额 |
是 |
是 |
|
| transaction_id |
交易流水号 |
是 |
是 |
|
| datetime |
交易时间 |
是 |
是 |
|
| returncode |
交易状态 |
是 |
是 |
00表示成功，其它表示失败 |
| attach |
扩展返回 |
否 |
否 |
商户附加数据返回 |
| sign |
MD5签名 |
是 |
否 |
|
签名算法
第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。
第二步，在stringA最后拼接上key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
MD5运算前字符串拼接顺序：amount=amount&datetime=datetime&memberid=memberid&orderid=orderid&returncode=returncode&transaction_id=transaction_id&key=key
订单查询接口
提交方式：POST
地址： 接入网关/Pay_Trade_query.html
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| pay_memberid |
商户编号 |
是 |
是 |
|
| pay_orderid |
商户订单号 |
是 |
是 |
|
| pay_md5sign |
MD5签名 |
是 |
否 |
|
返回值
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| memberid |
商户编号 |
是 |
是 |
|
| returncode |
请求状态 |
是 |
是 |
00表示成功，其它表示失败 |
| orderid |
商户订单号 |
是 |
是 |
|
| transaction_id |
平台订单号 |
是 |
是 |
|
| amount |
订单金额 |
是 |
是 |
单位：元 |
| time_end |
支付成功时间 |
是 |
是 |
|
| trade_state |
支付状态 |
是 |
是 |
SUCCESS：支付成功，NOTPAY：未支付 |
| sign |
MD5签名 |
是 |
否 |
|
代付提交接口
提交方式：POST
提交地址：网关地址+/Payment_Dfpay_add.html
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| mchid |
商户编号 |
是 |
是 |
平台分配商户号 |
| out_trade_no |
商户订单号 |
是 |
是 |
保证唯一值 |
| money |
代付订单金额 |
是 |
是 |
|
| bankname |
开户行名称 |
是 |
是 |
印度BANK填IFSC号码,格式：ABCD0123456其他地区请查看附录：代付银行编码 |
| bankcode |
银行编码 |
是 |
是 |
印度BANK填IFSC号码,格式：ABCD0123456其他地区请查看附录：代付银行编码 |
| accountname |
开户名 |
是 |
是 |
|
| cardnumber |
银行卡号 |
是 |
是 |
账号，巴西TED格式应为(账号-账号digit)例如453532-2肯尼亚填9位真实手机号 |
| province |
省份 |
是 |
是 |
巴西填CPF号码哥伦比亚填身份证号(8-11 位)其他地区，请传入非空任意值 |
| city |
城市 |
是 |
是 |
巴西BANK填银行账号确认码其他地区，请传入非空任意值 |
| notifyurl |
服务端通知 |
是 |
是 |
服务端返回地址.（POST返回数据） |
| extends |
附加字段 |
否 |
是 |
为空时不参与签名 |
| pay_md5sign |
MD5签名 |
是 |
否 |
|
注：extends字段具体需要上送哪些字段以及字段的含义，对接时请咨询平台方，如果不需要扩展字段则不传。不为空时，格式：先转化为JSON，接着进行Base64加密
例如：扩展字段为phone和idno，extends[phone]=13800138000，extends[idno]=111111111111111111。首先将extends转化为JSON格式得到{"phone":"13800138000","idno":"111111111111111111"}，然后将此JSON字符串进行base64加密得到eyJwaG9uZSI6IjEzODAwMTM4MDAwIiwiaWRubyI6IjExMTExMTExMTExMTExMTExMSJ9，最终得到extends=eyJwaG9uZSI6IjEzODAwMTM4MDAwIiwiaWRubyI6IjExMTExMTExMTExMTExMTExMSJ9。
返回值
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| status |
状态 |
是 |
否 |
成功:success 失败：error（不代表业务成功） |
| msg |
状态描述 |
是 |
否 |
|
| transaction_id |
平台流水号 |
是 |
否 |
成功时返回 |
代付异步通知
提交方式：POST
接收到服务器点对点通讯时，在页面输出“OK”（ 没有双引号，OK 两个字母大写 ) ，否则会重复5次发送点对点通知.
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| status |
状态 |
是 |
是 |
success：请求成功（不代表业务成功），error：请求失败 |
| msg |
状态描述 |
是 |
是 |
|
| mchid |
商户号 |
是 |
是 |
status=success时返回 |
| out_trade_no |
商户订单号 |
是 |
是 |
status=success时返回 |
| amount |
金额 |
是 |
是 |
status=success时返回 |
| transaction_id |
平台流水号 |
是 |
是 |
status=success时返回 |
| refCode |
业务状态 |
是 |
是 |
status=success时返回 |
| refMsg |
业务描述 |
是 |
是 |
status=success时返回 |
| success_time |
成功时间 |
否 |
是 |
只有当status=success，refCode=1时返回 |
| sign |
MD5签名 |
是 |
否 |
|
refCode返回值
注：当status=success和refCode=1同时成立时才表示转账成功
代付查询接口
提交方式：POST
提交地址：网关地址+/Payment_Dfpay_query.html
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| out_trade_no |
商户订单号 |
是 |
是 |
|
| mchid |
商户号 |
是 |
是 |
|
| pay_md5sign |
签名 |
是 |
否 |
|
返回值
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| status |
状态 |
是 |
是 |
success：请求成功（不代表业务成功），error：请求失败 |
| msg |
状态描述 |
是 |
是 |
|
| mchid |
商户号 |
是 |
是 |
status=success时返回 |
| out_trade_no |
商户订单号 |
是 |
是 |
status=success时返回 |
| amount |
金额 |
是 |
是 |
status=success时返回 |
| transaction_id |
平台流水号 |
是 |
是 |
status=success时返回 |
| refCode |
业务状态 |
是 |
是 |
status=success时返回 |
| refMsg |
业务描述 |
是 |
是 |
status=success时返回 |
| success_time |
成功时间 |
否 |
是 |
只有当status=success，refCode=1时返回 |
| sign |
MD5签名 |
是 |
否 |
|
refCode返回值
| 返回值 |
含义 |
| 1 |
成功 |
| 2 |
失败 |
| 3 |
处理中 |
| 4 |
待处理 |
| 5 |
审核驳回 |
| 6 |
待审核 |
| 7 |
交易不存在 |
| 8 |
未知状态 |
注：当status=success和refCode=1同时成立时才表示转账成功
签名算法
签名生成的通用步骤如下：
第一步，设所有发送或者接收到的数据为集合M，将集合M内非空参数值的参数按照参数名ASCII码从小到大排序（字典序），使用URL键值对的格式（即key1=value1&key2=value2…）拼接成字符串。
第二步，在stringA最后拼接上应用key得到stringSignTemp字符串，并对stringSignTemp进行MD5运算，再将得到的字符串所有字符转换为大写，得到sign值signValue。
stringSignTemp="pay_amount=pay_amount&pay_applydate=pay_applydate&pay_bankcode=pay_bankcode&pay_callbackurl=pay_callbackurl&pay_memberid=pay_memberid&pay_notifyurl=pay_notifyurl&pay_orderid=pay_orderid&key=key"
sign=MD5(stringSignTemp).toUpperCase()
账户余额查询接口
提交方式：POST
接口地址：网关地址+/Payment_Dfpay_balance.html
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| mchid |
商户编号 |
是 |
是 |
平台分配商户号 |
| pay_md5sign |
MD5签名 |
是 |
否 |
|
返回值
| 参数名称 |
参数含义 |
是否必填 |
参与签名 | 参数说明 |
| status |
状态 |
是 |
是 |
success:请求成功，error：请求失败 |
| msg |
状态描述 |
是 |
是 |
|
| mchid |
商户号 |
是 |
是 |
status=success时返回 |
| balance |
可提现余额 |
是 |
是 |
status=success时返回 |
| blockedbalance |
冻结余额 |
是 |
是 |
status=success时返回 |
|
| pay_md5sign |
MD5签名 |
是 |
否 |
|
通道编码
请登录商户中心，API管理 通道费率中 查看所属应用的支付通道编码。
印尼银行编码
| 开户行名称 |
银行编码 |
| Bank BRI |
BRI |
| Bank Mandiri |
Mandiri |
| Bank BNI |
BNI |
| Bank Danamon |
Danamon |
| Bank Permata |
Permata |
| Bank Permata Syariah |
Permata Syariah |
| Bank BC |
BCA |
| BII Maybank |
MayBank |
| Maybank Syariah |
Maybank Syariah |
| Bank Panin |
Panin |
| CIMB Niaga |
CIMB Niaga |
| Bank UOB INDONESIA |
UOB |
| Bank OCBC NISP |
OCBC |
| CITIBANK |
CITI |
| Bank ARTHA GRAHA |
ARTHA GRAHA |
| Bank TOKYO MITSUBISHI UFJ |
TOKYO MITSUBISHI UFJ |
| Bank DBS |
DBS |
| Standard Chartered |
Standard Chartered |
| Bank CAPITAL |
Bank CAPITAL |
| ANZ Indonesia |
ANZ Indonesia |
| Bank OF CHINA |
BOC |
| Bank Bumi Arta |
BBA |
| Bank HSBC |
HSBC |
| Bank Rabobank |
Rabobank |
| Bank JTRUST INDONESIA |
JTRUST INDONESIA |
| Bank MAYAPADA |
MAYAPADA |
| Bank Jawa Barat |
Jawa Barat |
| Bank DKI |
DKI |
| Bank BPD DIY |
BPD DIY |
| Bank Jambi |
Jambi |
| Bank Aceh |
Aceh |
| Bank Aceh Syariah |
Aceh Syariah |
| Bank NAGARI |
NAGARI |
| Bank Riau |
Riau |
| Bank SUMSEL BABEL |
SUMSEL BABEL |
| Bank SUMSEL BABEL Syariah |
SUMSEL BABEL Syariah |
| Bank Lampung |
Lampung |
| Bank KALSEL |
KALSEL |
| Bank KALBAR |
KALBAR |
| Bank BPD Kaltim |
BPD Kaltim |
| Bank BPD Kalteng |
BPD Kalteng |
| Bank BPD Bali |
Bali |
| Bank Maluku |
Maluku |
| Bank BPD Papua |
BPD Papua |
| Bank BANTEN |
BANTEN |
| Bank Nusantara Parahyangan |
Nusantara Parahyangan |
| Bank Of India Indonesia |
BII |
| Bank Muamalat |
Muamala |
| Bank Mestika |
Mestika |
| Bank Sinarmas |
Sinarmas |
| Bank Maspion |
Maspion |
| Bank Ganesha |
Ganesha |
| Bank ICBC |
ICBC |
| Bank QNB indonesia |
QNB indonesia |
| Bank BTN |
BTN |
| Bank Woori Saudara |
Woori Saudara |
| Bank BTPN |
BTPN |
| Bank Victoria Syariah |
Victoria Syariah |
| Bank Jabar Banten Syariah |
Jabar Banten Syariah |
| Bank Mega |
Mega |
| Bank Bukopin |
Bukopin |
| Bank Jasa Jakarta |
Jasa Jakarta |
| Bank KEB HANA |
KEB HANA |
| Bank MNC INTERNATIONAL |
MNC INTERNATIONAL |
| Bank YUDHA BHAKTI/ Bank Neo Commerce |
YUDHA BHAKTI |
| Bank Rakyat Indonesia AGRONIAGA |
Rakyat Indonesia AGRONIAGA |
| Bank SBI Indonesia (Indomonex) |
SBI |
| Bank Royal |
Royal |
| Bank National Nobu |
National Nobu |
| Bank MEGA SYARIAH |
MEGA SYARIAH |
| Bank INA |
INA |
| Bank PANIN SYARIAH |
PANIN SYARIAH |
| PRIMA MASTER BANK |
PRIMA MASTER BANK |
| Bank SYARIAH BUKOPIN |
SYARIAH BUKOPIN |
| Bank Sahabat Sampoerna |
Sahabat Sampoerna |
| Bank DINAR |
DINAR |
| Bank BCA SYARIAH |
BCA SYARIAH |
| Bank ARTOS/ Bank Jago |
ARTOS |
| Bank BTPN SYARIAH |
BTPN SYARIAH |
| Bank Mayora |
Mayora |
| Bank INDEX |
INDEX |
| CNB |
CNB |
| Bank MANTAP |
MANTAP |
| Bank VICTORIA INTL |
VICTORIA INTL |
| HARDA |
HARDA |
| Bank CTBC Indonesia |
CTBC |
| Bank COMMONWEALTH |
COMMONWEALTH |
| DANA |
DANA |
| LINKAJA |
LINKAJA |
| SHOPEEPAY |
SHOPEEPAY |
| GOPAY |
GOPAY |
| OVO |
OVO |
越南银行编码
| 开户行名称 |
银行编码 |
| Techcom Bank |
TCB |
| Asia Commercial Bank |
ACB |
| Exim Bank |
EXIM |
| Vietnam Prosperity Bank |
VPB |
| An Binh Bank |
ABB |
| Bank Negara Indonesia |
BNI |
| CIMB Niaga |
CIMB |
| AGRI Bank |
AGRI |
| Saigon Bank |
SGB |
| Viet Capital Commercial Joint Stock Bank |
VCCB |
| Citizen National Bank |
CNB |
| SCB Bank |
SCB |
| Vietnam Thuong Tin Bank |
VB |
| Sacom Bank |
SACOM |
| Vietin Bank |
VTB |
| MB Internet Bank |
MB |
| Vietnam International Bank |
VIB |
| Bank Central Asia |
BCA |
| Bank Rakyat Indonesia |
BRI |
| DongA Bank |
DAB |
| Lien Viet Post Bank |
LVPB |
| Southeast Asia Bank |
SEAB |
| Kien Long Bank |
KLB |
| Ho Chi Minh City Development Bank |
HDB |
| Viet A Bank |
VAB |
| Vietcom Bank |
VCB |
| Bank for Investment and Development of Vietnam |
BIDV |
| Saigon Hanoi Bank |
SHB |
| Vietnam Maritime Commercial Joint Stock Bank |
MSB |
| Peapack Gladstone Bank |
PGB |
| Mandiri Bank |
MDR |
| Tien Phong Bank |
TPB |
| Vietnam Public Bank |
PVB |
| Bac A Bank |
BACA |
| Nam A Bank |
NAMA |
| Orient Commercial Bank |
OCB |
| Bao Viet Bank |
BVB |
尼日利亚银行编码
孟加拉银行编码
| 开户行名称 |
银行编码 |
| AB BANK LTD |
25000f001 |
| AGRANI BANK LTD |
25000f002 |
| AL-ARAFAH ISLAMI BANK LTD |
25000f003 |
| BANGLADESH BANK |
25000f004 |
| BANGLADESH COMMERCE BANK LTD |
25000f005 |
| BANGLADESH DEVELOPMENT BANK LTD |
25000f006 |
| BANGLADESH KRISHI BANK |
25000f007 |
| BANGLADESH SAMABAYA BANK LTD |
25000f008 |
| BANK AL-FALAH LTD |
25000f009 |
| BANK ASIA LTD |
25000f010 |
| BASIC BANK LTD |
25000f011 |
| BKash |
25000f012 |
| BRAC BANK LTD |
25000f013 |
| CITI BANK N A |
25000f014 |
| COMMERCIAL BANK OF CEYLON |
25000f015 |
| COMMUNITY BANK BANGLADESH LTD |
25000f016 |
| DBBL |
25000f017 |
| DHAKA BANK LTD |
25000f018 |
| DUTCH-BANGLA BANK LTD |
25000f019 |
| EASTERN BANK LTD |
25000f020 |
| EXIM BANK LTD |
25000f021 |
| FIRST SECURITY ISLAMI BANK LTD |
25000f022 |
| HABIB BANK LTD |
25000f023 |
| HSBC |
25000f024 |
| ICB ISLAMIC BANK LTD |
25000f025 |
| IFIC BANK LTD |
25000f026 |
| ISLAMI BANK BANGLADESH LTD |
25000f027 |
| JAMUNA BANK LTD |
25000f028 |
| JANATA BANK LTD |
25000f029 |
| MEGHNA BANK |
25000f030 |
| MERCANTILE BANK LTD |
25000f031 |
| MIDLAND BANK LIMITED |
25000f032 |
| MODHUMOTI BANK LIMITED |
25000f033 |
| MUTUAL TRUST BANK LTD |
25000f034 |
| NATIONAL BANK LTD |
25000f035 |
| NATIONAL BANK OF PAKISTAN |
25000f036 |
| NCC BANK LTD |
25000f037 |
| NRB BANK LIMITED |
25000f038 |
| NRB Commercial Bank LTD |
25000f039 |
| NRB GLOBAL BANK LIMITED |
25000f040 |
| ONE BANK LTD |
25000f041 |
| PRIME BANK LTD |
25000f042 |
| PUBALI BANK LTD |
25000f043 |
| RAJSHAHI KRISHI UNNAYAN BANK |
25000f044 |
| RUPALI BANK LTD |
25000f045 |
| SHAHJALAL ISLAMI BANK LTD |
25000f046 |
| SHIMANTO BANK LTD |
25000f047 |
| SOCIAL ISLAMI BANK LTD |
25000f048 |
| SONALI BANK LTD |
25000f049 |
| SOUTH BANGLA AGRICULTURE AND COMMERCE BANK |
25000f050 |
| SOUTHEAST BANK LTD |
25000f051 |
| STANDARD CHARTERED BANK |
25000f052 |
| STATE BANK OF INDIA |
25000f053 |
| THE CITY BANK LTD |
25000f054 |
| THE FARMERS BANK LIMITED |
25000f055 |
| THE PREMIER BANK LTD |
25000f056 |
| TRUST BANK LTD |
25000f057 |
| UNION BANK LTD |
25000f058 |
| UNITED COMMERCIAL BANK LTD |
25000f059 |
| UTTARA BANK LTD |
25000f060 |
| WOORI BANK |
25000f061 |
菲律宾银行编码
| 开户行名称 |
银行编码 |
| Gcash |
Gcash |
| Mayapay |
Mayapay |
俄罗斯银行编码
| 开户行名称 |
银行编码 |
| (传入俄罗斯银行名称即可) |
(传入俄罗斯银行名称即可) |
