代付收款人证件类型

idType	说明
CPF	CPF
CNPJ	CNPJ

代付账户类型

accountType	说明	账户示例	备注
1	CPF	22*****99	11位数字 (不含.和-)
2	CNPJ	23*******31	14位数字
3	EMAIL	merchant@example.com	用户邮箱
4	PHONE	+5511987654321	必须+55开头
5	EVP	暂时停用此支付方式， 类似于UUID的格式 xxxxx-xxxx-xxxx-xxx	从中央银行发送到机构的 32 位字母数字字符串
6	RANDOM		随机代付

TIP

• 我们会对CPF和CNPJ进行格式校验和有效性校验，渠道会对CPF和CNPJ进行真实性校验。
• 格式校验和有效性校验会同步返回校验结果，校验失败订单会被直接拒绝。
• 真实性校验会在订单提交到巴西央行后由央行校验，校验过不通过会导致代付失败。
• CPF的校验算法请参考
• CNPJ的校验算法请参考

代付订单状态枚举

值	说明	备注
PROCESSING	处理中
WAITING	路由中
PAYING	支付中
SUCCESS	成功	订单终态
FAIL	失败	订单终态
CANCEL	驳回/取消	订单终态

TIP

注意，在处理来自Cashy的回调或者查询结果时，应对订单状态进行精确地判断。只有终态结果才能认为代付订单明确成功/失败。

代付订单状态描述

值	说明
ACCOUNT_NOT_EXIST	账户不存在
ACCOUNT_FREEZING	账户冻结
ACCOUNT_CANCEL	账户已取消
ACCOUNT_IN_ANOTHER_CURRENCY	另一种货币的帐户
ACCOUNT_NOT_BELONG_TO	帐户不属于接收参与者
ACCOUNT_EXCEPTION	收款账户异常
MCH_NOT_KNOW_PAYMENT	收款人不承认付款
MISS_MUST_PAYMENT_INFO	缺少完成付款的必填信息
ERROR_PAYMENT_TYPE	错误的付款方式
ERROR_OPERATION_TYPE	错误的操作类型
ACCOUNT_TYPE_NOT_APPLICABLE	账户类型不适用
INVALID_CHARACTER	无效字符
OUT_ACCOUNT_BALANCE	超出授权账户余额限制
OUT_ACCOUNT_MONTH_BALANCE	超出账户当月允许的信用额度
NOT_REGISTER_TELPHONE	未注册的手机号码
NOT_RECEIVE_BANXICO_PAYMENT	附加帐户不会收到非来自 Banxico 的付款
INFO_STRUCTURE_INVALID	附加信息结构不正确
UNKNOWN_ERROR	未知异常
SUCCESS	成功
AMOUNT_ERROR	金额错误
PARAM_ERROR	参数错误
NOT_SUPPORTED_CASH	不支持现金支付
NOT_SUPPORTED_CREDIT	不支持信用卡支付
SYSTEM_ERROR	系统异常
INVALID_BANK_ACCOUNT	无效的银行账户
RUT_INVALID	无效的RUT (智利)
COMPLIANCE_REJECT	付款因合规原因被拒绝 (智利)
INVALID_CCI	无效的CCI (秘鲁)
PAYMENT_REJECT_BY_RECEIPT_PSP	付款被收款人的PSP拒绝（巴西）
BENEFICIARY_ACCOUNT_FREQUENCY_RISK_BY_BANK	受益账户触发上游银行交易频率风控（巴西） ,此情况请暂缓该收款账户的出款操作，等待一段时间后再重试
ACCOUNT_NOT_FOUND	未找到对应的收款账号
PAGAMENTO_EXPIRADO_POR_TIMEOUT	(Pagamento expirado por timeout)付款因超时而过期（巴西）, 通常因为巴西央行波动引起的
CHANNEL_IB_TRY_AGAIN_LATER	渠道异常，可稍后重试

代收付款人证件类型

idType	说明
CPF	CPF

代收PayType枚举

值	说明
140	PIX

代收订单状态枚举

值	说明	备注
PAYING	支付中
SUCCESS	成功	订单终态
FAIL	失败	订单终态

TIP

注意，在处理来自Cashy的回调或者查询结果时，应对订单状态进行精确地判断。只有终态结果才能认为代收订单明确成功。

常见报错信息

值	含义	覆盖国家
Permission_denied	请求地址未授权（请求地址错误，检查下请求地址是否正确）	全部
System_error	系统错误	全部
System_busy	系统繁忙（重试）	全部
System_Maintenance	系统维护（重试）	全部
MerchantId_is_null	商户Id为空	全部
Sign_verify_error	商户签名验证错误	全部
RequestMethod_not_post	不是POST请求	全部
RequestContentType_not_json	不是application/json请求	全部
RequestBody_is_null	请求体为空	全部
MerchantId_not_Number	商户Id非数字	全部
MerchantId_is_error	商户Id错误	全部
Request_ip_notWhiteList	请求ip非白名单	全部
Params_jsonFormat_error	请求体json格式错误	全部
Params_xxx_Required	某参数未传递,请检查是否漏传。	全部
Params_xxx_error	某参数错误，请检查参数是否合法。	全部
Params_accountNo_Format_isIncorrect	银行账号格式不正确(银行卡号长度与银行不匹配)	部分国家
Merchant_amount_notEnough	商户余额不足	全部
Merchant_not_enabled	商户未启用	全部
Merchant_not_exist	商户不存在	全部
Params_order_notExist	该平台订单号不存在	全部
Params_mchOrderNo_notExist	该商户订单号不存在	全部
Params_mchOrderNo_repeat	商户订单号重复	全部
Params_email_format_invalid	邮箱格式错误	全部
Params_bankId_Disable	此银行暂时不可用	全部
Params_IdCard_format_invalid	证件号格式错误	全部
Params_idCard_Format_incorrect	证件号格式错误	部分国家
Channel_Maintenance_time	通道维护中 ，测试环境可联系技术支持	全部
Params_realName_not_contain_Chinese	账户名字不允许包含中文	全部
Params_accountName_not_contain_Chinese	账户名字不允许包含中文	全部
Params_accountNo_Clabe_Invalidate	Clabe无效	墨西哥
Params_accountNo_CardNumber_Invalidate	银行卡号无效	墨西哥
Params_email_format_invalid	邮箱格式无效	墨西哥
Params_email_length_exceeds<64>characters	邮箱长度超过了64位（应当保证邮箱长度低于64位）	全部
Params_accountName_Maximum<40>characters	代付（受益人）收款人姓名过长	部分国家，MX为40
Params_accountName_Required	请传递收款帐户名	部分国家
Params_accountName_Maximum<64>characters	收款账户名不得超过64字符	部分国家
Params_accountName_not_contain_Chinese	收款账户名不得包含中文	部分国家
Params_CPF_accountNo_Invalid	CPF格式的收款帐号无效	巴西
Params_idType_Required	证件类型必传	部分国家
Params_idType_Invalid	证件类型无效	部分国家
Params_idCard_Required	证件号必传	部分国家
Params_idCard_CPF_Invalid	CPF证件号无效	巴西
Params_realName_Required	代收付款人姓名必传	部分国家
Params_realName_Maximum<64>characters	代收付款人姓名不得超过64字符	部分国家
Params_realName_not_contain_Chinese	代收付款人姓名不得包含中文	部分国家
Tran_risk_intercept	交易风控拦截 ，检查金额是否满足限制条件	全部
COLLECTION_ACCOUNT_DAY_LIMIT	收款卡号达到日限制上限次数	全部
COLLECTION_NAME_DAY_LIMIT	收款姓名达到日限制上限次数	全部
LIMIT_MIN_AMOUNT	订单金额低于最小金额限制	全部
LIMIT_MAX_AMOUNT	订单金额高于最大金额限制	全部
BLACK_LIST_USER_LIMIT	用户属于黑名单限制	全部