Skip to content

发起付款

发起付款接口是在对外付款时必须接入的接口能力。

PayerMax提供了全球150余个国家的支付方式,每个支付方式要求的字段可能不同。在接入前,请参考支付方式列表来明确对接的支付方式。

1. 交互流程

2.集成步骤

(1) 商户下载以下的付款申请模板,并在APP或网站自行收集用户出款要素。

注意:

账户信息要求可具体参考:《付款申请模板及填写规范》

(2) 参考《付款申请模板及填写规范》「填写规范」表格,必填参数 (粉色背景) 去构建接口参数

比如:按照《付款申请模板及填写规范》,巴西(BR)的 BANK_TRANSFER 出款方式 payeeInfo.document.documentId 为必填,接口请求时则必须传该字段。

(3) 付款不可撤销,一旦发起就不能撤回。

3.订单幂等性校验

商户提交付款请求时,上送的订单号需要保证唯一。

PayerMax如果识别出商户使用相同的订单号请求,会返回:code=ORDER_REPEAT,同时返回该笔订单当前的状态。

4.接口参数

详情请参考 申请付款 API

5.下单响应

5.1 下单成功响应

当收到响应中code = APPLY_SUCCESSmsg = Success.时,代表请求成功,并不代表交易成功。需要根据返回data体中的status字段来判断交易的状态。详情请参考 申请付款 API

5.2 下单失败响应

5.2.1 服务端请求限制

在发起付款申请时,您可能遇到的「服务端请求限制」类的错误码如下:

分类错误码错误描述备注
服务端请求限制REQ_TIME_OVER_TIMErequestTime effective in two minutes请求时间与服务端偏差超过2分钟,请检查requestTime后重新发起
ILLEGAL_IP_REQUESTillegal ip request请求IP需要加入白名单,请联系PayerMax
TOO_MANY_REQUESTExceed request limitation, please retry later触发接口并发限流,请稍后重试

5.2.2 商户配置校验

在发起付款申请时,您可能遇到的「商户配置校验」类的错误码如下:

分类子分类错误码错误描述备注
商户配置校验签名/密钥配置校验MERCHANT_APP_INVALIDSignature key is not configured.密钥未配置,请尽快配置秘钥
SIGN_VERIFY_FAILEDThe signature verify failed.验签失败,请检查秘钥或签名逻辑
合约可用性校验CONTRACT_INVALIDMerchant has not signed the contract or payment methods.未签约或未开通该支付方式,请检查合约开通情况
MERCHANT_INVALIDThe merchant has been offline.商户已下线,如有疑问请联系PayerMax

5.2.3 订单信息接收

在发起付款申请时,您可能遇到的「订单信息接收」类的错误码如下:

分类子分类错误码错误描述备注
订单信息接收请求参数校验PARAMS_INVALIDThe {field} is incorrect.【字段】校验不符合规则,请参考《付款申请模板及填写规范》查看对应支付方式下的字段规则
PARAMS_INVALIDThe {field} is incorrect,you should fill {?}【字段】校验不符合规则,请根据提示并参考《付款申请模板及填写规范》查看对应支付方式下的字段规则
ORDER_REPEATThe order number repeat.订单号重复,请修改后重新发起
其他异常SYSTEM_ERRORSystem is busy, Please try again later.系统异常,请检查订单状态,如落单失败则重新发起

Released under the MIT License.