进件 API 是必须接入的吗?
不是。四项能力全部是「按需接入」(Conditional),由你根据业务决定是否集成:
沙箱与生产环境的 API 地址分别为
https://api-sandbox.waffo.com/ 和 https://api.waffo.com/。请求头、签名方式与其他 Waffo API 相同:请求体使用 JSON(UTF-8),用你的私钥签名(SHA256WithRSA),用 Waffo 的公钥验证响应签名。
进件类型 onboardingType 选哪个?
当类型为
2 且申请状态为 PARTIAL_SUCCESS 或 FULL_SUCCESS 时,查询响应里会返回 Waffo 分配的 assignedSubMerchantId。
提交进件申请要传哪些字段?
下表是提交接口的必填字段(required)。其余字段为选填或有条件必填。
几个容易漏的点:
siteInfo里的appSiteUrl与webSiteUrl都是选填,但应按实际业务至少提供一个。authorizedPurchaseUrl和authorizedPurchaseDomain只在申请微信支付(WECHATPAY)时需要;域名最多五个,用 JSON 格式。- 董事(
directorInfo)和股东(shareHolderInfo)信息为选填数组。
选填字段有哪些?格式有什么要求?
AddressInfo.region(州 / 省)、AddressInfo.postcode(邮编)为选填。directorInfo[]:每项含directorName、directorIdNumber。shareHolderInfo[]:每项含shareHolderName、shareHolderNationality(ISO 3166-1 alpha-3)、shareHolderIdIdType(NATIONAL_ID_CARD、PASSPORT、DRIVER_LICENSE或OTHERS)、shareHolderIdNumber、shareHolderShares(持股比例,如 40.00%)。extendInfo:预留字段,JSON 字符串,最长 128 个字符。- 网址字段(
appSiteUrl、webSiteUrl、authorizedPurchaseUrl)须以 http 或 https 开头,最长 256 个字符。 - 电话格式为 +国家码-号码,例如 +62-08990013157;日期格式为 DD/MM/YYYY;国家码一律用 ISO 3166-1 alpha-3。
- 请求头带
X-API-KEY和X-SIGNATURE;通知和你的应答同样要签名,Waffo 用你的公钥验签。
提交成功后我会拿到什么?
响应里有三个字段:申请状态和每个支付方式的状态是什么意思?
申请总体状态onboardingStatus:
每个支付方式的状态
payMethodOnboardingStatus:
失败时,查询结果里可能带有
onboardingFailedCode 和 onboardingFailedReason(均为选填)。
怎么查进件状态?
调用inquiry 接口,onboardingSubmissionId 与 onboardingApplicationId 二选一提供即可。响应是一个完整的进件申请对象,包含总体状态、每个支付方式的状态和失败信息、updatedAt(最后更新时间)等。
申请被退回后怎么改?
调用update 接口更新申请。它适用于申请最初因进件资料有误被拒绝的情形,字段结构与提交接口一致。申请仍在 PROCESSING 时不能更新,会返回 A0010。
怎么收到进件结果通知?
Waffo 会向你在notifyUrl 提供的地址发送 HTTPS POST 回调,每个支付方式的进件状态有更新,就会发送一次。报文的 eventType 为 ONBOARDING_NOTIFICATION,result 是与查询接口相同的进件申请对象。
你的响应体 message 必须是以下之一: