OhayoShikin
    OhayoShikin
    • 接口说明
    • 代收余额查询 - /gateway-api/deposit/balance
      POST
    • 代收查询可用通道 - /gateway-api/deposit/channels
      POST
    • 代收创建订单 - /gateway-api/deposit/create
      POST
    • 代收查询订单 - /gateway-api/deposit/get
      POST
    • 代收订单回调
      POST
    • 代付余额查询 - /gateway-api/withdrawal/balance
      POST
    • 代付创建订单 - /gateway-api/withdrawal/create
      POST
    • 代付查询订单 - /gateway-api/withdrawal/get
      POST
    • 代付订单回调
      POST

    接口说明

    说明#

    所有接口请求均为POST, Content-Type 为 application/json; charset=UTF-8
    除参数错误外, 所有错误信息均有唯一错误码, 可在错误码列表中查看
    所有请求需要签名, 详见签名规则
    签名密钥需要登录商户后台生成, 账号密码及登录地址请向我方管理员索取
    必须要加白的IP才能访问, 可联系我方管理员添加白名单
    我方回调IP请从管理员处获取添加

    签名规则#

    将所有发送或者接收的数据中非空、非sign字段按照参数名ASCII码从小到大排序(字典序),使用URL键值对的格式(即key1=value1&key2=value2…)拼接成字符串A
    在字符串A后面拼接&key=Api秘钥,生成字符串B
    最后将字符串B进行MD5运算,取大写,生成最终的签名sign值
    示例:
    1.
    请求参数如下:
    {
      "amount": 2000,
      "channelCode": "MVola-100-5000",
      "merchantSerial": "MD003",
      "notifyUrl": "https://www.aaa.com/bbb",
      "username": "merchant1",
      "timestamp": 1750528292358
    }
    2.
    非空过滤及排序后得到字符串如下:
    amount=2000&channelCode=MVola-100-5000&merchantSerial=MD003&notifyUrl=https://www.aaa.com/bbb&timestamp=1750528292358&username=merchant1
    3.
    假设签名key为773e7c523734f02c701dd43b015387c8, 拼接为:
    amount=2000&channelCode=MVola-100-5000&merchantSerial=MD003&notifyUrl=https://www.aaa.com/bbb&timestamp=1750528292358&username=merchant1&key=773e7c523734f02c701dd43b015387c8
    4.
    MD5及转大写后得到如下签名:
    81C770A36F5DACA2D9C35253ECB1E62B
    5.
    则最终请求参数为:
    {
      "amount": 2000,
      "channelCode": "MVola-100-5000",
      "merchantSerial": "MD003",
      "notifyUrl": "https://www.aaa.com/bbb",
      "username": "merchant1",
      "timestamp": 1750528292358,
      "sign": "81C770A36F5DACA2D9C35253ECB1E62B"
    }

    关于回调#

    代收只有订单为 2: 完成, 3: 驳回 时才会回调
    代付当订单为 1: 完成,2: 管理员驳回, 3: 商户取消 均会发起回调
    商户端处理完成需要返回小写 success 字符串表示处理成功
    无论成功或失败只会自动回调一次, 之后如需再次回调需要联系管理员手动操作

    关于代收订单状态#

    订单共有如下几种状态
    0: 新创建
    1: 处理中
    2: 完成
    3: 驳回
    4: 超时
    5: 已收到转账,但金额不匹配
    其中 5: 已收到转账,但金额不匹配 为过渡状态, 表示用户并未按要求金额转账
    该状态并不会发起回调, 但是查询订单接口中可以查询到该状态
    管理员经过核实后续处理会将订单设置为 2: 完成 或 3: 驳回
    所以商户端可以根据自己的需求进行忽略或处理

    错误码列表#

    编码描述
    400参数错误
    900商户账号错误
    901签名密钥未初始化
    902商户被禁用,请联系管理员
    903您的IP无权访问, 请联系管理员添加白名单
    904签名错误
    905通道不存在,请检查编码是否正确
    906通道暂不可用
    907无通道权限,请联系管理员
    908订单重复
    909代付余额不足,请先充值
    910通道xxx暂无匹配的收款账号
    404订单不存在
    500其他系统错误
    Modified at 2025-10-14 05:56:39
    Next
    代收余额查询 - /gateway-api/deposit/balance
    Built with