1. 前置必读
ORIXA-API文档
  • 默认模块
    • 前置必读
      • 请求签名算法说明
      • Webhook 签名校验文档
      • 端点响应状态码
      • WebHook通知事件
    • 持卡人
      • 修改持卡人
      • 持卡人列表-分页查询
      • 创建持卡人
    • 卡片操作
      • 卡片敏感信息-Iframe版
      • 卡片列表(分页查询)
      • 获取卡产品列表
      • 实体卡绑定
      • 激活实体卡
      • 卡片激活码(回调异常情况下主动获取)
      • 卡片详情
      • 卡片充值
      • 卡片敏感信息(卡片三要素)
      • 设置卡片状态
      • 卡片刷新
      • 设置PIN
      • 卡卡转账
      • 虚拟卡创建
    • WebHook
      • 获取WebHook信息
      • 设置WebHook
      • 通知记录
    • 模拟测试
      • API请求头模拟
      • 卡片授权交易--仅沙箱环境可用
    • 商户信息
      • 商户可用余额
      • 商户账单
    • 供应链
      • 供应商目录
      • 供应商资质披露
      • 产品类目
      • 产品列表
      • 获取指定产品规格
      • 查询某产品规格库存信息
      • 计算运费
      • 订单记录
      • 取消订单-仅待发货可申请
      • 确认收货
      • 创建订单
      • 获取支持快递列表
    • 全球付
      • 支持国家列表
      • 汇款通道
      • 获取汇款/创建受益人参数说明
      • 创建受益人
      • 受益人列表
      • 获取货币汇率
      • 更新受益人
      • 汇款
      • 汇款订单
  1. 前置必读

端点响应状态码

本文档用于指导代理商判断 API 响应。本文中的响应码指响应体 code 字段,不等同于 HTTP 状态码。

1. 响应判断#

场景判断条件code 类型
成功code === 200整数
失败code 以 AGENT_ 开头字符串
成功响应示例:
{
  "code": 200,
  "msg": "success",
  "time": 1720000000,
  "data": {}
}
失败响应示例:
{
  "code": "AGENT_AUTH_40007",
  "msg": "签名无效",
  "detail": "HMAC signature validation failed",
  "request_id": "req_xxx",
  "timestamp": 1720000000,
  "ip": "127.0.0.1"
}

2. 失败错误码#

2.1 鉴权与权限#

响应码描述触发条件
AGENT_AUTH_40001缺少必要请求头缺少 AccessKey、时间戳、Nonce 或签名请求头
AGENT_AUTH_40002请求已过期请求时间戳与服务器时间相差超过 300 秒
AGENT_AUTH_40003AccessKey 无效或已禁用AccessKey 不存在,或对应应用、用户状态异常
AGENT_AUTH_40004SecretKey 无效应用未配置有效的 API Secret
AGENT_AUTH_40005请求重复提交5 分钟内重复使用同一 Nonce
AGENT_AUTH_40006IP 不在白名单生产代理服务启用 IP 白名单且客户端 IP 不匹配
AGENT_AUTH_40007签名无效HMAC 签名校验失败
AGENT_SCOPE_40001当前 API 未授权AccessKey 的 Scope 不包含当前端点

2.2 参数错误#

响应码描述触发条件
AGENT_PARAM_40002参数格式错误请求参数中包含非法 UTF-8 等格式问题
AGENT_PARAM_40010Webhook URL 不能为空设置 Webhook 时未提交 URL
AGENT_PARAM_40011Webhook URL 格式不正确Webhook URL 无法通过格式校验
AGENT_PARAM_40012Webhook 必须使用 HTTPSWebhook URL 未使用 HTTPS

2.3 风控错误#

响应码描述触发条件
AGENT_RISK_42901请求过于频繁同一 AccessKey 对同一端点超过 10 QPS
AGENT_RISK_40301访问被风控拦截生产代理服务命中 IP 黑名单

2.4 业务错误#

响应码描述触发条件
AGENT_BIZ_30001持卡人错误持卡人不存在或不属于当前代理商
AGENT_BIZ_30002卡号不存在未查询到指定卡片
AGENT_BIZ_30010Email already exists持卡人邮箱已存在
AGENT_BIZ_30011创建持卡人失败上游服务未能创建持卡人
AGENT_BIZ_30012卡片已绑定,请用验证码激活实体卡已被绑定
AGENT_BIZ_30013卡状态异常卡片状态不允许执行当前操作
AGENT_BIZ_30014卡片刷新异常刷新卡片信息失败
AGENT_BIZ_30017System获取卡片敏感信息等操作发生系统级异常
AGENT_BIZ_30018转出卡不可与转入卡相符卡转卡时转出卡与转入卡相同
AGENT_BIZ_30019转出卡号不存在卡转卡时未找到转出卡
AGENT_BIZ_30020转入卡号不存在卡转卡时未找到转入卡

2.5 系统与兜底错误#

响应码描述触发条件
AGENT_SYS_50001系统错误API 网关发生未捕获异常
AGENT_SYS_50003第三方服务异常或未分类错误上游服务失败,或错误消息未匹配到其他固定错误码
AGENT_SYS_50003 是默认兜底码,可能承载参数校验、第三方接口或业务异常。收到此码时必须同时读取 msg 和 detail,不要只根据响应码展示固定文案,必要时可群内联系技术客服
上一页
Webhook 签名校验文档
下一页
WebHook通知事件
Built with