GET /v1/rates 中的 payin_rate)折算,
并在您的账户配置了固定入金费用时予以扣除。
无论采用哪种模式,每条路径的终点都相同 —— 自动入账 + webhook:
1. 查询可用通道
可用的国家、货币和收款模式由 CBPay 定义。请始终查询目录:delivery 描述付款在 CBPay 一侧的确认方式(银行通知、轮询或两者兼有)
—— 它不会改变您的任何集成方式:您始终会收到 payin_credited webhook。
收款通道和模式:
可用性可能变化;目录(
GET /v1/payins/methods)始终是唯一可信来源。
在所有情况下入账方式相同:按您当前的 payin_rate 折算为 USDT,并在
扣除固定入金费用后净额入账。
2. 选择模式并创建收款
每个国家都有自己的收款模式。各模式的真实请求与响应如下:- 智利
- 秘鲁
- 墨西哥
- 委内瑞拉
- 玻利维亚
- 巴拉圭
- 巴西
托管支付页面(响应 将 响应 转账到达后,系统会根据转账附言中的参考号进行匹配(或以金额+货币作为
后备匹配方式),您的账户即自动入账。
fintoc) —— 推荐:您会获得一个 payment_url;
付款人打开它后可从任意智利银行或钱包(Banco Estado、Santander、
Mach、Tenpo、Mercado Pago……)转账。付款会被自动检测并校验 ——
无需手动填写参考号。201:payment_url 分享给付款人(链接、重定向或 WebView)。付款确认后,
您的账户即以 USDT 入账,并收到 payin_credited webhook。CLP 金额必须为
整数(智利比索没有小数位),支付会话默认在 24 小时后过期。使用相同的
idempotency_key 重试会返回同一笔入金和同一个 URL —— 绝不会开启第二个
支付会话。预告银行转账(手动的替代方案):预先申报即将到来的存款,并把
参考号分享给汇款人。201:通用收款链接(checkout)
创建一个通用收款链接:一次 POST /v1/payins(method: "checkout")
即可返回一个带品牌的公开 URL,付款人在页面上自行选择支付方式。收款以
你选择的虚拟余额计价(settlement_asset:USDT、USDC、BTC 或
GOLD,默认 USDT),每笔付款在入账时自动转换为该余额——除非付款
人用同一资产支付,此时不发生转换。
页面将支付方式组织为四个标签页:
- CBPay —— 使用应用直接支付:显示商户别名和二维码;用应用扫码 即可通过内部转账即时付款,支持 4 种余额中的任意一种。
- Crypto —— 可用币种按网络分组(目前为 TRON 与以太坊上的 USDT、 以太坊上的 USDC 以及 BTC;新网络启用后会自动出现),每笔收款专属 充值地址,并附带可扫描二维码,兼容外部钱包(Trust Wallet、 MetaMask、Binance 等)。
- Fiat —— 付款人在所有有可用代收走廊的国家中选择自己的国家, 即可看到可用方式(二维码、银行转账、托管支付页)及即时报出的当地 金额。
- 银行卡 —— 在安全的托管页面用信用卡或借记卡支付,按扣款币种 列出(目前为 BOB 和 USD;未来收单机构的币种会自动出现)。每种币种 都是独立的支付选项,各自有报出的金额。
amount以settlement_asset计价:配USDT的"50"表示 50 USDT;配BTC的"0.001"表示 0.001 BTC;配GOLD的"2"表示 2 克黄金。不要发送currency——那是旧契约,会返回400(收款不再 绑定当地货币)。country为可选,仅用于页面上的国家预选;付款人可以更改。GOLD没有自己的支付轨道:收款始终通过自动转换达成,无论客户用什么 方式付款。
201:
checkout_url 分享给付款人(链接、邮件、WhatsApp、打印二维码均可)。
页面无需登录,带有你组织的品牌,并会自动刷新:任一方式确认付款后,页面
显示”已支付”,如设置了 success_url 则自动跳转。
各支付轨道的工作方式
- 多国家法币:付款人选择国家和方式;当地金额即时报价(目标金额 →
美元 → 当地货币,按你走廊的
payin_rate,向上取整),在选定方式时 冻结。入账按正常 payin 汇率与手续费结算,随后转换为settlement_asset。付款金额小于冻结报价时照常入账(钱是真实的), 但不会将链接标记为已支付。当一个国家以多种币种提供同一方式 (例如玻利维亚同时提供 BOB 和 USD 的二维码)时,页面把每种币种列为 独立选项。墨西哥的银行转账会为该链接生成一个专属 CLABE(仅限本次 收款):付款人只需转账准确金额,无需填写任何参考号 —— 账户本身 即可识别链接,存款自动检测并结算。若当时无法签发专属账户,页面会降级 为经典方式(商户通用账户 + 转账附言中必须填写参考号)。 - 拉取式收款(委内瑞拉):
c2p和debito_inmediato直接从付款人 账户扣款。页面要求填写银行、证件号、电话(C2P)或账户(即时扣款) 以及 OTP —— C2P 由付款人在其银行 App 中生成;即时扣款则按需发送 (“请求密码”按钮)。金额始终是报价时冻结的金额;若通道同步确认, 链接即刻支付完成。被拒绝不会终结链接:付款人可修正数据或改用其他 方式。 - 银行卡(多币种):标签页按扣款币种列出每个可用选项及其报价金额; 选择后打开该币种的托管支付页面。每种币种是独立的物化(同一链接可 同时以 BOB 和 USD 报价;最先完成支付的生效)。
- 加密货币(每笔收款一个钱包):选择币种后生成专属地址及其
qr_payload和qr_png_base64——二维码始终为裸地址(BTC bech32、 TRON base58、ETH hex),以兼容钱包与交易所(Binance 等会拒绝 BIP-21/EIP-681 URI);精确金额显示在旁边可复制。若支付资产与settlement_asset不同,报出的应付额已包含转换成本(由付款人 承担;你收到精确的目标金额)。部分支付会累加,页面显示剩余金额。 涉及 BTC/GOLD 的报价每 15 分钟刷新。 - CBPay 应用:商户二维码内嵌链接
(
cbpay:pay?to=…&checkout=…)。应用通过内部转账以 4 种余额中的 任意一种付款:同一资产 ⇒ 精确目标金额;不同 ⇒ 含转换的应付额。金额 在服务端按新报价校验——不足以覆盖收款时返回422 checkout_amount_mismatch及当前应付额。集成方:POST /v1/transfers接受可选字段checkout_token(或在to_qr_token中使用扩展二维码);目标账户强制为链接所属账户。
自动转换到所选余额
任何与settlement_asset 不同资产的入账都会经你账户的转换引擎转换
(与 POST /v1/swaps 相同的点差与限额)。汇总状态通过
conversion_status 传递:
链接的公开端点(免认证,有限流)
GET {checkout_url}/state——链接状态:status、paid_method、settlement_asset、asset_amount、冻结的法币物化 (fiat_methods)、加密进度(crypto,含due/received)及conversion_status。GET {checkout_url}/quote——选择前的报价:countries(按国家的 目录;每个国家在options[]中列出其通道——每个方式+币种一行, 拉取式方式带collect: true)、cards(按国家与币种的银行卡选项, 含local_amount)、crypto(各币对的参考应付额)和cbpay(别名 + 各资产应付额)。带?country=XX时额外返回该国每个选项 当地金额的country_quote。POST {checkout_url}/methods/{method}——物化所选支付选项。法币方式 要求?country=XX;当国家以多种币种提供该方式时(银行卡、玻利维亚 的 QR BOB/USD)还须传¤cy=YYY;加密货币使用crypto:<chain>:<asset>(如crypto:tron:usdt),不带国家。拉取式 方式返回付款人表单定义(banks[]、requires_otp_request)和冻结的 报价。对同一组合重复 POST 返回同一个物化结果。POST {checkout_url}/collect/otp——当通道按需发送密码时 (requires_otp_request: true,如委内瑞拉即时扣款),请求拉取式 收款的 OTP。返回随最终扣款一起提交的otp_reference。严格限流 (每次调用都是真实的短信/推送)。POST {checkout_url}/collect——用付款人数据(银行、证件号、电话或 账户、OTP)执行拉取式扣款。金额始终是冻结的金额;若通道同步确认, 返回paid: true,链接在同一次调用中完成结算。
链接规则
- 一个链接 = 一笔收款:最先完成支付的方式生效;之后经其他轨道的 付款不会入账(在无人付款前,选择某个方式不会锁定其他方式)。
expires_in取值 600 到 604800 秒(10 分钟到 7 天;默认 24 小时)。 到期未支付时 payin 变为expired,你会收到payin_expiredWebhook。- 使用相同
idempotency_key重试会返回同一个链接(URL 不变), 绝不会开启第二笔收款。 settlement_asset必须已为你的组织启用;若被停用,创建请求返回422 settlement_asset_disabled。
payin_credited,附带 settled_via(如
crypto:tron:usdt、qr、cbpay)、settlement_asset 和
asset_amount;加密支付额外附带 crypto_amount,CBPay 应用支付额外
附带 transfer_id、asset 和 amount。
链接专属错误(由打开页面的人看到):
3. 接收入账
当付款到达(无论通过哪种模式),您的账户会自动入账,并触发payin_credited webhook:
fx_rate 是入账时刻您的 payin_rate —— 折算严格按该汇率进行:
usdt_gross = 700.00 / 6.91。
入金对象保留完整的明细:
状态
通过直接转账到达但缺少清晰参考号的存款会保持
unassigned 状态,直到
CBPay 团队将其路由到某个账户。分配后,按目标账户的汇率和费用入账。当一笔待支付的代收(二维码或 checkout)在未收到付款的情况下终止时,payin
会自动从
pending 变为 expired(或 failed),并且您会收到
payin_expired webhook。不产生任何资金变动:如需重新
收款,请创建新的 payin。查询与历史记录
from/to 使用 YYYY-MM-DD(UTC);日期无效时返回
400 invalid_range。