API 文档

# 尼日利亚支付API文档

# 1. 如何获取API Key

  用户登录收银台 -> 开发者中心 -> API Key -> 创建API key。API Key 都有单独的配置页，并绑定固定的 IP 地址（“0.0.0.0”表示不做 IP 拦截过滤，任何IP都可以访问），可配置不同的 API Key 满足不同的需求。请不要泄露您的 Access Key 及 Secret Key，以免造成资产损失。Secret Key 生成后将无法再次查看，请注意及时保存，如您忘记了 Secret Key，请在商户后台回收该密钥对并申请新的密钥对。

# 1.1 如何创建API KEY

• 点击开发者中心-API Key

• 1选择是否开启调试模式 ( 开启调试模式后，你有任何错误会有规范的提示信息和日志查看地址 )

• 2选择API Key权限

• 3输入白名单地址 (0.0.0.0 表示任意IP地址可以访问)

注：( 输⼊⽩名单域名时应注意多个IP时用","隔离。)

• 4点击创建，可⽣成API KEY

(⽣成API KEY后可以在下⽅我的API KEY列表进⾏复制、查看、编辑和删除等操作，注意Secret key只在生成的时候出现一次，请妥善保存，如您忘记了Secret Key,请回收该密钥对并申请新的密钥对。)

• 点击编辑可关闭或开启【开始调试】及修改API Key权限和白名单地址，修改完成后点击保存即可

注意：创建或编辑API Key之后请耐心等待90秒API Key生效

# 2. 如何使用API Key

当前API Key是在请求的Header中添加参数列表

参数名 参数说明 类型 是否必须
access_key Api Key 访问密钥 （如：TPhoa7ZQ） String 是
timestamp 毫秒级时间戳（13位 如：1679669488472） String 是
nonce UUID（36位 如：02f7a04f-53cc-47d4-bb3f-fae69dab49ac） 五个部分分别为8个字符、4个字符、4个字符、4个字符、12个字符，中间用“-”号间隔 String 是
sign 参数签名 （如：GXx2wYUD6UVr+zcmeCSFFPzcBLA=） String 是

# 3. 技术侧参数接入流程

# 4. 如何接口签名

# 签名说明

  API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据等）外的私有接口均必须使用您的 API Key 做签名认证，以校验参数或参数值在传输途中是否发生了更改。

一个合法的请求由以下几部分组成：

  • access_key： API 访问密钥；
  • secret_key： 签名加密所使用的密钥（仅在后台申请 API Key 时可见一次，请复制保存在安全处，不可泄露）；
  • timestamp： 您发出请求的时间 (UTC 时间) 。如：1632811287325（13位）。在查询请求中包含此值有助于防止第三方截取您的请求；
  • nonce： 随机 UUID 字符串。如：053a1b81-48a0-4bb1-96b2-60f6e509d911（36位）；
  • sign： 签名计算得出的值，用于确保签名有效和未被篡改；
  • 所有接口都需要在http请求头 （header） 中传递以上除 secret_key 外的几个公共参数，公共参数包含（access_key ，timestamp，nonce，sign）其他涉及到签名参数以API接口说明为准 。

# 签名步骤

​ 1.定义一个 Map 字典类型对象，将请求中的参数以 key-value 的形式放入其中

​ 2.将 access_key、timestamp、nonce 也放入第一步定义的 Map 中

​ 3.将 Map 里面的属性按照 ASCII 码从小到大做升序排序（字典序）并将 Map 转换输出为“key1=value1&key2=value2” 形式的字符串

​ 4.将上一步转换的字符串用 secret_key 进行 HMAC_SHA1 加密并进行 Base64 转码，得到 sign 参数值。secret_key 是在收银平台创建的 apikey 中的信息

​ 5.将 sign 值和其他所需参数加到请求头 header 中，发送请求目标接口

# 签名调试工具

  • SignUtil: 用户登录收银台 -> 开发者中心 -> API 文档 -> 签名工具 打开签名工具页面 (工具中的access_key请使用有效的access_key 并且请设置允许这个access_key访问的IP白名单为 0.0.0.0,我们强烈推荐使用过的access_key调试完成后废弃)

# 5. 接口列表

# 5.1 测试接口连通性

请求方式

Get

请求URL

/ping

响应数据

{"version":"1.0.1","timestamp":1688116827306}

响应参数说明

Param Type Desc
version String 返回该参数则本文档中所有接口都可正常请求
timestamp int64 Unix时间戳

# 5.2 新建代收订单

请求方式

Post

请求URL

/api/v3/ng/createCollectingOrder

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{
	"amount": "40.20",
	"channelType": "BANK",
	"externalOrderId": "354997490558818072",
	"notifyUrl": "http://192.168.1.135:30001/",
	"remark": "123",
	"returnUrl": "http://192.168.1.135:30001"
}

请求参数说明

Param Desc Sample Require
amount 收款金额，小数点不能超过2位且金额不能低于40（String） 40.20 required
channelType 支付类型（String）oneof=BANK BANK required
externalOrderId 商户订单号 max=64 （String） 354997490558818072 required
notifyUrl 通知URL（String，URL） http://192.168.1.135:30001 optional
remark 备注 max=255（String） 123 optional
returnUrl 返回地址（String，URL） http://192.168.1.135:30001 optional

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": {
        "cashierUrl": "http://192.168.1.200:1084/OCURRPAID202310260755491698306949076DEV001OO0000000200000728?data=eyJjYXNoaWVyQ3VycmVuY3lBbW91bnQiOjEwMC4wMCwiY2FzaGllckV4cGlyZVRpbWUiOjE2OTgz\nMDg3NDkwOTIsImNhc2hpZXJJZCI6Ik9DVVJSUEFJRDIwMjMxMDI2MDc1NTQ5MTY5ODMwNjk0OTA3\nNkRFVjAwMU9PMDAwMDAwMDIwMDAwMDcyOCIsImNhc2hpZXJVcmwiOiJodHRwOi8vMTkyLjE2OC4x\nLjIwMDoxMDg0L09DVVJSUEFJRDIwMjMxMDI2MDc1NTQ5MTY5ODMwNjk0OTA3NkRFVjAwMU9PMDAw\nMDAwMDIwMDAwMDcyOCIsImN1cnJlbmN5IjoiTkdOIiwiY3VycmVuY3lPcmRlclZvIjp7ImFtb3Vu\ndCI6MTAwLjAwLCJjdXJyZW5jeSI6Ik5HTiIsImV4dGVybmFsT3JkZXJJZCI6IjU2NTY1NjUzMzY1\nNjIyMjMzMzU2NSIsIm1lcmNoYW50TmFtZSI6ImNsYXJrX2FnZW50X2hhbWJpdCIsIm9yZGVySWQi\nOiJPQ1VSUlBBSUQyMDIzMTAyNjA3NTU0OTE2OTgzMDY5NDkxMDhERVYwMDFPTzAwMDAwMDA0MDAw\nMDA3MjkiLCJvcmRlclN0YXR1cyI6IkF3YWl0aW5nIFBheW1lbnQiLCJvcmRlclN0YXR1c0NvZGUi\nOjEsIm9yZGVyVGltZSI6MTY5ODMwNjk0OTExMCwicGF5UGFyYW0iOiJodHRwczovL3BheWg1Lm90\ncGF5LnRvcC8jLz9tZXJjaGFudElkPTk5OSZtZXJjaGFudE9yZGVySWQ9MTY5ODMwNjk0OTExNXB5\nODJsbXA5cmRtNDFpa2V0cGImYW1vdW50PTEwMCZzaWduPWFhMDFkNjg0MjFmNDcyY2JiMzg2YTZm\nZDhkZmJjYjA0IiwicGF5VHlwZSI6MTAyLCJwYXlUeXBlTmFtZSI6IkJBTksiLCJwYXlVcmwiOiJo\ndHRwczovL3BheWg1Lm90cGF5LnRvcC8jLz9tZXJjaGFudElkPTk5OSZtZXJjaGFudE9yZGVySWQ9\nMTY5ODMwNjk0OTExNXB5ODJsbXA5cmRtNDFpa2V0cGImYW1vdW50PTEwMCZzaWduPWFhMDFkNjg0\nMjFmNDcyY2JiMzg2YTZmZDhkZmJjYjA0IiwidHJhZGVOb3RlIjoiYWRrYXNkIn0sImlzQ3JlYXRl\nT3JkZXIiOnRydWUsIm1lcmNoYW50SWQiOjE3MDcyODU4NDAzMjYxMjc2MTcsInBheVR5cGUiOjEw\nMiwicmV0dXJuVXJsIjoiaHR0cDovLzE5Mi4xNjguMS4xMzU6MzAwMDEiLCJ2ZXJzaW9uIjoidjEi\nfQ==&pm=W3siY3VycmVuY3lUeXBlIjoiTVhOIiwicGF5VHlwZXMiOlt7ImNvZGUiOjEwMiwidmFsdWUiOiJC\nQU5LIn1dfSx7ImN1cnJlbmN5VHlwZSI6Ik5HTiIsInBheVR5cGVzIjpbeyJjb2RlIjoxMDIsInZh\nbHVlIjoiQkFOSyJ9XX0seyJjdXJyZW5jeVR5cGUiOiJJRFIiLCJwYXlUeXBlcyI6W3siY29kZSI6\nMTAyLCJ2YWx1ZSI6IkJBTksifV19LHsiY3VycmVuY3lUeXBlIjoiSU5SIiwicGF5VHlwZXMiOlt7\nImNvZGUiOjEwMiwidmFsdWUiOiJCQU5LIn1dfSx7ImN1cnJlbmN5VHlwZSI6IkJSTCIsInBheVR5\ncGVzIjpbeyJjb2RlIjoxMDEsInZhbHVlIjoiUElYIn0seyJjb2RlIjoxMDMsInZhbHVlIjoiUElY\nX0RZTkFNSUMifV19XQ==",
        "cashierExpireTime": 1698308749092,
        "currency": "NGN",
        "cashierCurrencyAmount": "100",
        "returnUrl": "http://192.168.1.135:30001",
        "currencyOrderVo": {
            "externalOrderId": "565656533656222333565",
            "tradeNote": "adkasd",
            "orderId": "OCURRPAID202310260755491698306949108DEV001OO0000000400000729"
        }
    }
}

响应参数说明

Param Type Desc
cashierUrl String 收银台链接
cashierExpireTime Int64 收银台到期时间
currency String 币种编码
cashierCurrencyAmount String 收款金额
externalOrderId String 商户订单号
orderId String 系统订单ID
tradeNote String 备注
returnUrl String 回调地址

# 5.3 新建代付订单

请求方式

Post

请求URL

/api/v3/ng/createTransferOrder

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{
    "currencyAmount":"10",
    "channelType":"BANK",
    "externalOrderId":"777888887444233333",
    "accountId":"12345566",
    "accountName":"wsxtes",
    "bankName":"FIDELITY BANK",
    "accountType":"NGN",
    "notifyUrl":"http://192.168.1.135:30001"

}

请求参数说明

Param Desc Sample Require
currencyAmount 代付金额 小数不能大于2位且金额不能低于40（String） 10.20 required
channelType 支付类型 oneof= BANK（String） BANK required
externalOrderId 商户订单号 max=64（String） 777888887444233333 required
accountName 银行账号姓名 （String） wsxtes required
accountId 银行账号（String） 12345566 required
bankName 银行名字（String） FIDELITY BANK 根据实际情况 required
accountType 银行账号类型 oneof=NGN NGN required
notifyUrl 通知URL（String） http://192.168.1.135:30001 optional

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": {
        "orderId": "OCURRDRAW202310260758441698307124373DEV001OO0000000200000735",
        "orderStatus": "Accepted",
        "externalOrderId": "777888887444233333",
        "currencyType": "NGN"
    }
}

响应参数说明

Param Type Desc
currencyType String 法币类型
externalOrderId String 商户订单id
orderId String 系统订单ID
orderStatus String 订单状态

# 5.4 查询代收订单

请求方式

Post

请求URL

/api/v3/ng/query/collectingOrder

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{
   "externalOrderId": "65545164612312332222222",
   "orderId":"OCURRPAID202310260311051698289865983DEV001OO0000000400000663"
}

请求参数说明

Param Desc Require
externalOrderId 商户订单号 max=64（String） required
orderId 系统订单号（String） required

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": [
        {
            "orderId": "OCURRPAID202310260311051698289865983DEV001OO0000000400000663",
            "cashierId": "OCURRPAID202310260311051698289865927DEV001OO0000000200000662",
            "orderType": 1,
            "orderResourceType": 2,
            "userId": "1707285840326127617",
            "orderStatus": 1,
            "orderTime": 1698289866000,
            "channelOrderId": "5850696559035393",
            "externalOrderId": "65545164612312332222222",
            "orderAmount": "100",
            "orderActualAmount": null,
            "orderFee": null,
            "orderPayTime": null,
            "orderCompleteTime": null,
            "currencyType": "NGN",
            "payType": 102,
            "tradeNote": "adkasd",
            "notifyUrl": "https://platform.hambit.co/#/home/dashboard",
            "markStatus": 0,
            "errorMsg": null,
            "errorMsgEn": null,
            "accountType": "",
            "accountName": "",
            "accountNo": "",
            "orderTypeCode": "Pay",
            "orderResourceTypeCode": "Currency",
            "orderStatusCode": "Wait pay",
            "payTypeCode": "BANK"
        }
    ]
}

响应参数说明

Param Type Desc
orderId String 订单ID
cashierId String 收银台ID
orderType int64 订单类型
orderResourceType int64 订单所属业务类型
userId String 用户ID
orderStatus int64 订单状态 1-待支付
2- 支付成功
orderTime int64 订单发起时间
channelOrderId String 订单关联渠道订单ID
externalOrderId String 商户订单号
orderAmount String 订单金额
orderActualAmount String 订单实际金额
orderFee int64 订单手续费
orderPayTime int64 订单支付时间
currencyType String 货币类型
payType int64 支付类型 102:BANK
202:BANK
tradeNote String 备注
notifyUrl String 回调URL
markStatus int64 标记状态
errorMsg String 错误信息
errorMsgEn String 错误信息en
accountType String 账户类型
accountName String 账户名称
accountNo String 账户号
orderTypeCode String 订单类型code
orderResourceTypeCode String 订单所属业务类型code
orderStatusCode String orderStatusc描述
payTypaCode String 支付类型code参考payType

# 5.5 查询代付订单

请求方式

Post

请求URL

/api/v3/ng/query/transferOrder

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{
    "orderId": "OCURRDRAW202310260335441698291344637DEV001OO0000000200000673",
    "externalOrderId": "77788888744423333"
}

请求参数说明

Param Desc Require
externalOrderId 商户订单号 max=64（String） required
orderId 系统订单号 （String） required

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": [
        {
            "orderId": "OCURRDRAW202310260335441698291344637DEV001OO0000000200000673",
            "cashierId": "",
            "orderType": 2,
            "orderResourceType": 2,
            "userId": "1707285840326127617",
            "orderStatus": 8,
            "orderTime": 1698291345000,
            "channelOrderId": "1698291345714bk7sjmjwg7gloqtzpg9",
            "externalOrderId": "77788888744423333",
            "orderAmount": "10",
            "orderActualAmount": "11",
            "orderFee": "1",
            "orderPayTime": 1698291347000,
            "currencyType": "NGN",
            "payType": 202,
            "tradeNote": "",
            "notifyUrl": "https://platform.hambit.co/#/home/dashboard",
            "markStatus": 0,
            "errorMsg": null,
            "errorMsgEn": null,
            "accountType": "",
            "accountName": "FIDELITY BANK",
            "accountNo": "12345566",
            "orderTypeCode": "Transfer",
            "orderResourceTypeCode": "Currency",
            "orderStatusCode": "Success",
            "payTypeCode": "BANK"
        }
    ]
}

响应参数说明

Param Type Desc
orderId String 订单ID
cashierId String 收银台ID
orderType int64 订单类型
orderResourceType int64 订单所属业务类型
userId String 用户ID
orderStatus int64 订单状态 1-已受理
2-银行处理中
4-失败(银行未受理)
8-成功
16-失败
orderTime int64 订单发起时间
channelOrderId String 订单关联渠道订单ID
externalOrderId String 商户订单号
orderAmount String 订单金额
orderActualAmount String 订单实际金额
orderFee int64 订单手续费
orderPayTime int64 订单支付时间
currencyType String 货币类型
payType int64 支付类型 102:BANK
202:BANK
tradeNote String 备注
notifyUrl String 回调URL
markStatus int64 标记状态
errorMsg String 错误信息
errorMsgEn String 错误信息en
accountType String 账户类型
accountName String 账户名称
accountNo String 账户号
orderTypeCode String 订单类型code
orderResourceTypeCode String 订单所属业务类型code
orderStatusCode String orderStatus描述
payTypeCode String 支付类型code参考payType

# 5.6 查询余额

请求方式

Get

请求URL

/api/v3/ng/query/balance

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
    "code": "200",
    "success": true,
    "msg": "成功",
    "msgEn": "SUCCESS",
    "data": [
        {
            "accountBalance": "10149",
            "accountFreezeAmount": "0",
            "accountStatusId": 4,
            "accountWaitSettledAmount": "0",
            "currencyType": "NGN",
            "accountStatus": "InAndOut"
        }
    ]
}

响应参数说明

Param Type Desc
accountBalance String 账户可用余额
accountFreezeAmount String 账户冻结金额
accountStatusId int64 账户状态id
accountWaitSettledAmount String 账户待划转金额
currencyType String 法币类型
accountStatus String 账户状态

# 5.7 查询银行

请求方式

POST

请求URL

/api/v3/ng/query/bank

请求类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

请求头

Param Desc Sample
access_key 商户后台获取 pFqV75X3
timestamp Unix时间戳13位 毫秒 1679724896223
nonce UUID V4 794c26b0-d33c-4394-b2bb-c485eca16d9e
sign 计算出来的签名 kAXyh+eerqrefyaF8dyFB0M4FVo=

请求参数

{"bankName": "FIDELITY BANK"}

如需查询所有银行value则传空字符串，如下数据：

{"bankName": ""}

请求参数说明

Param Desc Require
bankName 银行名称（String） required

响应类型

Header: { 'Content-Type': 'application/json;charset=utf-8'}

响应数据

{
	"code": "200",
	"success": true,
	"msg": "成功",
	"msgEn": "SUCCESS",
	"data": [{
		"bankName": "FIDELITY BANK",
		"bankCode": "000007",
		"currencyType": "NGN"
	}]
}

响应参数说明

Param Type Desc
bankName String 银行名称
bankCode String 银行code
currencyType String 货币类型

# 5.8 银行列表（银行列表仅供参考，请按查询银行接口返回数据提单）

BankName BankName
FIDELITY BANK U & C MICROFINANCE BANK
STANBICIBTC BANK PATRICKGOLD MICROFINANCE BANK
First bank MAYFAIR MICROFINANCE BANK
Citibank Nigeria REPHIDIM MICROFINANCE BANK
Heritage bank IKENNE MICROFINANCE BANK
Union bank BALOGUN GAMBARI MICROFINANCE BANK
United Bank For Africa Plc TRUST MICROFINANCE BANK
Wema bank NEPTUNE MICROFINANCE BANK
Access bank UNAAB MICROFINANCE BANK
Ecobank Nigeria Plc EVERGREEN MICROFINANCE BANK
Zenith bank OCHE MICROFINANCE BANK
GTBank BIPC MICROFINANCE BANK
Diamond bank CASHCONNECT MICROFINANCE BANK
Standard Chartered Bank Nigeria Ltd. MOLUSI MICROFINANCE BANK
Fidelity bank HEADWAY MICROFINANCE BANK
GATEWAY MORTGAGE BANK NUTURE MICROFINANCE BANK
ABBEY MORTGAGE BANK CORESTEP MICROFINANCE BANK
REFUGE MORTGAGE BANK FIRMUS MICROFINANCE BANK
LAGOS BUILDING AND INVESTMENT COMPANY SEEDVEST MICROFINANCE BANK
PLATINUM MORTGAGE BANK ILISAN MICROFINANCE BANK
FIRST GENERATION MORTGAGE BANK LEGEND MICROFINANCE BANK
BRENT MORTGAGE BANK THINK FINANCE MICROFINANCE BANK
INFINITY TRUST MORTGAGE BANK COASTLINE MICROFINANCE BANK
HAGGAI MORTGAGE BANK LIMITED ISALEOYO MICROFINANCE BANK
MAYFRESH MORTGAGE BANK NEW GOLDEN PASTURES MICROFINANCE BANK
Polaris Bank CONPRO MICROFINANCE BANK
Keystone bank MANNY MICROFINANCE BANK
ENTERPRISE BANK GTI MICROFINANCE BANK
EKONDO MICROFINANCE BANK INTERLAND MICROFINANCE BANK
FINATRUST MICROFINANCE BANK EK-RELIABLE MICROFINANCE BANK
MICROVIS MICROFINANCE BANK DAVODANI MICROFINANCE BANK
OHAFIA MICROFINANCE BANK MOZFIN MICROFINANCE BANK
GOWANS MICROFINANCE BANK NWANNEGADI MICROFINANCE BANK
TRUSTBANC J6 MICROFINANCE BANK LIMITED FINCA MICROFINANCE BANK
XSLNCE MICROFINANCE BANK Rehoboth Microfinance bank
FIDFUND MICROFINANCE Bank Suntrust Bank Nigeria Limited
BC KASH MICROFINANCE BANK PAGA - 100002
NDIORAH MICROFINANCE BANK AG MORTGAGE BANK
CONSUMER MICROFINANCE BANK INNOVECTIVES KESH
ALLWORKERS MICROFINANCE BANK FCMB
RICHWAY MICROFINANCE BANK CONTEC GLOBAL INFOTECH LIMITED(NOWNOW)
AL-BARAKAH MICROFINANCE BANK PALMPAY
ACCION MICROFINANCE BANK ACCESS YELLO & BETA
PERSONAL TRUST MICROFINANCE BANK Providus Bank
MICROCRED MICROFINANCE BANK Titan Bank
PECANTRUST MICROFINANCE BANK Globus Bank
ROYAL EXCHANGE MICROFINANCE BANK FLUTTERWAVE TECHNOLOGY SOLUTIONS LIMITED
VISA MICROFINANCE BANK PAYSTACK PAYMENTS LIMITED
CHIKUM MICROFINANCE BANK VENTURE GARDEN NIGERIA LIMITED
YES MICROFINANCE BANK 9 PAYMENT SOLUTIONS BANK
APEKS MICROFINANCE BANK Moneymaster PSB
CIT MICROFINANCE BANK Rubies Micro-finance Bank
FULLRANGE MICROFINANCE BANK First City Monument Bank Plc
TRIDENT MICROFINANCE BANK Unity Bank Plc
IRL MICROFINANCE BANK Letshego MFB
VIRTUE MICROFINANCE BANK Stanbic IBTC Bank Ltd.
MUTUAL TRUST MICROFINANCE BANK Sterling bank
FFS MICROFINANCE BANK JAIZ BANK
E-BARCS MICROFINANCE BANK Taj Bank
FUTO MICROFINANCE BANK PAYCOM (OPAY)
CREDIT AFRIQUE MICROFINANCE BANK ECOMOBILE
ADDOSSER MICROFINANCE BANK PAGA
OKPOGA MICROFINANCE BANK FSDH
ESO-E MICROFINANCE BANK Eyowo
DAYLIGHT MICROFINANCE BANK RAND MERCHANT BANK
ALPHA KAPITAL MICROFINANCE BANK Kuda Microfinance Bank
MAINSTREET MICROFINANCE BANK Hasal Microfinance Bank
ASTRAPOLARIS MICROFINANCE BANK Infinity MFB
RUBIES MICROFINANCE BANK Moniepoint Microfinance Bank
BOSAK MICROFINANCE BANK Petra Mircofinance Bank Plc
LAPO MICROFINANCE BANK CEMCS Microfinance Bank
GREENBANK MICROFINANCE BANK Unical Microfinance Bank
FAST MICROFINANCE BANK Bowen Microfinance Bank
BAINES CREDIT MICROFINANCE BANK TCF MFB
NIRSAL NATIONAL MICROFINANCE BANK Ibile Microfinance Bank
GROOMING MICROFINANCE BANK Hackman Microfinance Bank
PENNYWISE MICROFINANCE BANK Sparkle Microfinance Bank
ABU MICROFINANCE BANK VFD microfinance bank
RENMONEY MICROFINANCE BANK SEED CAPITAL MICROFINANCE BANK
NEW DAWN MICROFINANCE BANK NOVA MERCHANT BANK
UNIVERSITY OF NIGERIA, NSUKKA MICROFINANCE BANK Lagos Building Investment Company Plc.
YOBE MICROFINANCE BANK ASO SAVINGS
IMO STATE MICROFINANCE BANK JUBILEE LIFE
ALEKUN MICROFINANCE BANK PARALLEX
ABOVE ONLY MICROFINANCE BANK SAFETRUST
QUICKFUND MICROFINANCE BANK FIRST TRUST MORTGAGE BANK PLC
STELLAS MICROFINANCE BANK FBNQUEST MERCHANT BANK
NIGERIAN NAVY MICROFINANCE BANK EMPIRE TRUST MICROFINANCE BANK
AUCHI MICROFINANCE BANK AMML MICROFINANCE BANK
Kuda MFB FETS
ADEYEMI COLLEGE STAFF MICROFINANCE BANK PARKWAY-READYCASH
AB MICROFINANCE BANK CELLULANT
LAVENDER MICROFINANCE BANK eTRANZACT
OLABISI ONABANJO UNIVERSITY MICROFINANCE STANBIC IBTC @Ease WALLET
EMERALD MICROFINANCE BANK ECOBANK XPRESS ACCOUNT
PRESTIGE MICROFINANCE BANK GT MOBILE
IKIRE MICROFINANCE BANK1 TEASY MOBILE
TRUSTFUND MICROFINANCE BANK VT NETWORKS
GLORY MICROFINANCE BANK ACCESS MONEY
IKIRE MICROFINANCE BANK2 FIRSTMONIE WALLET
MEGAPRAISE MICROFINANCE BANK CHAMS MOBILE
MINT-FINEX MFB FORTIS MOBILE
ARISE MICROFINANCE BANK HEDONMARK
NNEW WOMEN MICROFINANCE BANK ZENITH MOBILE
FIRST OPTION MICROFINANCE BANK FIDELITY MOBILE
SAFE HAVEN MICROFINANCE BANK MONEY BOX
ASSETMATRIX MICROFINANCE BANK EARTHOLEUM
PILLAR MICROFINANCE BANK STERLING MOBILE
FCT MICROFINANCE BANK TAGPAY
AFEKHAFE MICROFINANCE BANK IMPERIAL HOMES MORTGAGE BANK
EAGLE FLIGHT MICROFINANCE BANK ZINTERNET - KONGAPAY
OMIYE MICROFINANCE BANK ONE FINANCE
POLYUNWANA MICROFINANCE BANK INTELLFIN
ALERT MICROFINANCE BANK PAYATTITUDE ONLINE
FEDPOLY NASARAWA MICROFINANCE BANK Coronation Bank
KONTAGORA MICROFINANCE BANK NPF MICROFINANCE BANK
PURPLEMONEY MICROFINANCE BANK FORTIS MICROFINANCE BANK
EVANGEL MICROFINANCE BANK COVENANT MFB
SULSPAP MICROFINANCE BANK OMOLUABI
BRIGHTWAY MICROFINANCE BANK PAGE MFBank
BOCTRUST MICROFINANCE BANK LIMITED WETLAND MICROFINANCE BANK
REGENT MICROFINANCE BANK MONEY TRUST MICROFINANCE BANK
SAGAMU MICROFINANCE BANK

# 6. 回调信息

# 6.1 如何回调接口验签

# 验签说明

​ API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保回调未被更改， 您可设置回调参数签名认证。设置方法为：登录收银台 ->开发者中心 -> 回调地址 -> 添加。

# 验签步骤

整体流程和签名大体一致，仅仅是拿来验签的数据取法不一样，签名是自己构造数据，验签是获取数据（header、json）

  1. 取出 header 中的 sign 值；

  2. 定义一个 Map 字典类型对象，将请求中的json参数以 key-value 的形式放入其中

  3. 取出 header 中的 access_key、timestamp、nonce 也放入上一步定义的 Map 中

  4. 将 Map 中的 key 按照 ASCII 码从小到大排序（字典序）并将 Map 转换输出为“key1=value1&key2=value2” 形式的字符串；

  5. 将上一步转换的字符串用 secret_key 进行 HMAC_SHA1 加密并进行 Base64 转码，得到 sign 签名值与第一步 header 中取出的 sign 进行字符串校验，相符则验签通过，反之则验签失败。此处的 secret_key 需与下单时的 access_key 相匹配。

# 6.2 支付回调

回调数据

{
    "currencyType":"NGN",
    "orderActualAmount":"84",
    "orderId":"OCURRPAID202310260749501698306590241DEV001OO0000000400000719",
    "orderFee":"3.36",
    "orderStatus":"Payment Successful",
    "payParam":"https://payh5.otpay.top/#/?merchantId=999&merchantOrderId=1698306590247m3ab52g8yzsm09peh2b&amount=84&sign=2f68139e0a1a0d39590f3eb639080842",
    "externalOrderId":"64895570",
    "tradeNote":"wsxtest",
    "payTypeName":"BANK",
    "orderAmount":"84",
    "orderTime":1698306590000,
    "payType":102,
    "orderStatusCode":2,
    "markStatus":0,
    "orderPayTime":1698306730000
}

回调数据说明

Param Type Desc
currencyType String 法币类型
errorMsg String 错误信息
errorMsgEn String 错误信息en
externalOrderId String 商户订单ID
markStatus String 标记状态
orderActualAmount float64 订单实际支付金额
orderAmount float64 订单创建金额
orderFee float64 手续费
orderId String 订单ID
orderPayTime int64 订单支付时间
orderStatus String orderStatusCode描述
orderStatusCode int64 订单状态 code 1-待支付
2- 支付成功
orderTime int64 订单创建时间
payParam String 支付类型
payType int64 支付类型
payTypeName String 支付类型名
tradeNote String 备注

​ 任意时候商户都可登录商户后台进行手动触发回调（不建议订单非终态发起手动回调），回调信息中订单状态等相关信息为真实实际状态（手动 回调请一定注意订单状态，如果手动回调订单的状态不是终态，在订单变为终态的时候平台依然会发起通知，请注意业务层面的冗余处理）

# 6.3 代付回调

回调数据

{
    "currencyType":"NGN",
    "accountCode":"000007",
    "accountName":"FIDELITY BANK",
    "orderId":"OCURRDRAW202310260758441698307124373DEV001OO0000000200000735",
    "orderFee":"1",
    "orderStatus":"Completed",
    "externalOrderId":"777888887444233333",
    "payTypeName":"BANK",
    "orderAmount":"10",
    "orderTime":1698307124000,
    "payType":202,
    "userInfoName":"wsxtes",
    "accountNo":"12345566",
    "orderStatusCode":8,
    "markStatus":0,
    "orderPayTime":1698307127000
}

回调数据说明

Param Type Desc
currencyType String 货币类型
accountCode String 账户code
accountName String 账户名
orderId String 订单ID
accountType String 账户类型
orderFee String 订单手续费
orderStatus String orderStatusCode描述
externalOrderId int64 商户订单ID
payTypeName float64 支付类型名称
orderAmount float64 订单创建金额
orderTime int64 订单创建时间
orderPayTime int64 订单代付时间
payType int64 代付类型
userInfoName String 用户名称
accountNo String 账户号
orderStatusCode String 订单状态code 1-已受理
2-银行处理中
4-失败(银行未受理)
8-成功
16-失败
markStatus String 用户证件类型

任意时候商户都可登录商户后台进行手动触发回调（不建议订单非终态发起手动回调），回调信息中订单状态等相关信息为真实实际状态（手动 回调请一定注意订单状态，如果手动回调订单的状态不是终态，在订单变为终态的时候平台依然会发起通知，请注意业务层面的冗余处理）

# 6.4 回调响应

备注：所有的回调都包含签名信息，建议商户做回调验签，商户收到回调信息后，确定订单终态，请响应网

关如下信息（content-type: application/json）如果没有正常响应服务端会在30分钟内，间隔三分钟总计2

次通知

{"code":200,"success":true}

# 6.5 回调通知URL

登录商户后台可以配置统一回调地址（订单中手动指定回调UR地址，优先级高于统一配置的回调地址，例如：订单中指定了notifyUrl参数，不管是否有统一配置回调通知地址，都使用订单中的notifyUrl地址)

注意 http响应status_code优先级最高 只要收到响应status_code=200 响应数据则忽略

# 7. 公共响应代码

filed Type Default value and comment
code String 成功"200" 其他请参考失败code
success Bool 成功 true 失败false 和code保持意义上的同步
msg String 一级code返回的文字性描述
data Object 参考接口列表章节

# 8. 失败code

Code Desc
200 正常
300 参数异常
301 IP无权限
307 签名错误
500 系统错误