出款 - API Bkpays Doc

用户信息暂不用填真实

PIX 出款账号传 beneficiaryAccountNumber ，不管什么类型，都传这个值，包括：电话、邮箱、税号、随机数（EVP），传电话号时需要加 +55 区号

巴西代付金额最低10BRL 最大50000BRL

PIX 正则校验规则

提高代付成功率建议

巴西央行对银行代付出款失败率高的主体会进行rate limit限制，代付成功率低失败过多会触发暂停出款然后影响业务，接入商户有义务增加用户代付成功率

CPF

限制为11位纯数字，超过字段或者不满足字段予以报错

不含任何字母，否则报错

不含任何特殊符号，否则报错

应是: 49860282862，而非: 498.602.828-62

CNPJ

限制为14位纯数字，超过字段或者不满足字段予以报错

不含任何字母，否则报错

不含任何特殊符号，否则报错

应是: 20626643000152，而非:20.626.643/0001-52

PHONE

巴西电话为11位数字，加上国际区号"+55”后为14个字符。建议让客户不要自己录入国际区号，因此可以将输入框限制为11位数字，超过字段或者不满足字段予以报错

不含任何字母，否则报错

不含任何特殊符号，否则报错

第一位数字不能是"0"否则报错，巴西没有0"作为开头数的电话。因为我方向银行提交的最终数据为'+55xxxxxxxxxxx，所以在客户录入完11位电话后，商户需要自动加前缓'+55“以后提交到我方

为避免客户混淆CPF和PHONE的输入，除了总则提出的方法外，可以在输入框前显示'+55“字样，提示客后此处是输入电话的地方

因为EMAIL本身格式复杂，因此只需要判定含有 @ 即可提交

提交表单时，弹个PIX文案高亮账号，账号前面必须明确提示当前账户是手机号还是CPF还是邮箱，主要是CPF和手机号，用户经常搞错，手机号传值我们是要加+55前缀的，确认下提交的账号是否正确，进一步提升用户出款成功率

建议开启 CPF 和 PIX 一致性校验，减少用户争议问题，出款成功率也会提高

Request

Header Params

Body Params application/json

Example

{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "paymentType": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "docType": "PIX",
    "docNumber": "string",
    "pixCheck": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

出款

PIX 正则校验规则#

提高代付成功率建议#

Request

Request Code Samples

Responses

PIX 正则校验规则

提高代付成功率建议