> ## Documentation Index > Fetch the complete documentation index at: https://docs.cbpayapp.com/llms.txt > Use this file to discover all available pages before exploring further. # 预览某通道的存款说明 > 返回你的组织为 `bank_transfer` 通道发布的银行账户文本 —— 与已宣告 payin 响应中自动嵌入的内容相同。可用于在付款人创建 payin 之前渲染 "钱应该汇到哪里"页面,或在静态页面上展示当前的存款说明。 只有配置了有效、由管理员设置的说明的通道才会返回内容;其余通道 响应 `404 not_found`(没有可预览的内容 —— 该通道不需要说明,或 尚无人配置)。 ## OpenAPI ````yaml /openapi.zh.yaml get /v1/payins/deposit-instructions openapi: 3.1.0 info: title: CBPay API version: '2.62' description: > CBPay 是一个多币种支付平台:覆盖拉美的法币付款(payout)与收款(payin)、内部转账、链上充值与提现,以及 KYC 筛查。每个账户持有四个相互独立的虚拟余额——USDT(运营货币)、USDC、BTC 和 GOLD(纯金克数)——可通过兑换(swap)按需转换。 payout 和服务费可从四个余额中的任意一个支付(用 `PUT /v1/settlement` 设置默认值,或在单笔 payout 中用 `settlement_asset` 覆盖);payin 可自动兑换为你选择的资产(`default_payin_asset`)。 所有金额均为十进制字符串,遵循各货币的精度(USDT/USDC/GOLD 为 6 位小数,BTC 为 8 位)。错误始终返回 `{"error": "", "message": ""}`。 servers: - url: https://api.qbank.cl/platform description: Live（生产环境，真实资金） - url: https://cryptobank.qbank.cl/platform description: Test（沙盒，模拟资金 — pk_test_ 密钥） security: - bearerAuth: [] tags: - name: 凭证 description: >- 每笔操作的品牌化 PDF 凭证,附带公开的签名 QR 真伪校验、每个响应/webhook 中的 receipt_url,以及最终状态时的自动邮件发送。 - name: 身份认证 description: 注册与登录账户成员。会话有效期 24 小时。 - name: 账户 description: 调用账户的档案、成员与 API key。 - name: 余额 description: 余额、流水历史与外汇汇率。 - name: 付款(Payouts) description: 从你选择的结算余额扣款的法币派发(默认 USDT)。 - name: 收款(Payins) description: 法币充值(二维码、转账、专属账户、pull 收款、卡片、checkout 链接)自动入账——默认入账 USDT,也可自动兑换为你选择的结算资产。 - name: 收银台(Checkout) description: >- 通用收银台链接(`POST /v1/payins`,`method: "checkout"`)与公开支付页端点——多国法币、每个链接专属临时钱包的加密货币支付,以及 CBPay 直接支付,按你选择的资产结算。 - name: 已保存卡片(Stored cards) description: 在 3-D Secure 支付中经付款人明确同意保存的卡片(COF)。可列出、吊销并按需扣款(MIT),无需再次索要卡片信息。 - name: 订阅(Subscriptions) description: 由平台调度器管理的已保存卡片周期性扣款——按日、周、月或年,支持暂停/恢复/取消与自动催收。 - name: 转账 description: CBPay 账户之间的免费内部转账(个人或企业,任意组合)。 - name: 联系人 description: 按账户维护的收款人通讯录(CBPay、银行与加密货币目的地),支持手机号匹配与每次发送时自动保存。 - name: 兑换(Swaps) description: 按账户报价即时兑换账户的 USDT、USDC、BTC 与 GOLD 余额。 - name: 加密货币 description: 链上充值与提现(TRON、Ethereum 和 Bitcoin)。 - name: 隔离钱包 description: 拥有自身余额的链上钱包(企业不限数量;个人每个网络+资产组合 1 个)——创建、导入、发送、导出私钥与自动转发。余额存在于链上,从不进入账本。 - name: 签名证明 description: 使用钱包进行加密消息签名(EIP-191 ETH/EVM、TIP-191 TRON)——创建、列出、查询和吊销具有公开验证功能的签名证明。 - name: 钱包链接 description: 通过签名 nonce 挑战将外部钱包(custody=client)链接到你的账户——创建挑战、验证签名、列出和吊销链接。 - name: QR Crypto POS description: >- 面向拥有实体 POS 终端的处理商（企业账户）的定额加密货币二维码收款：已验证商户、每笔收款专属地址 + 二维码、支付早期检测、按商户对账，以及经加密货币提现通道的退款。 - name: KYC / KYB description: 身份验证:个人 KYC、企业 KYB——你自己的入驻验证,以及企业账户的第三方验证。 - name: AML 筛查 description: 针对个人与企业的独立 AML 筛查(制裁、PEP 与负面媒体名单),含重新筛查、持续监控与可下载的 PDF 报告。 - name: 钱包筛查 description: 区块链地址的 AML 风险评估(制裁、非法资金暴露),按次收费;另附提现与充值的免费自动防护。 - name: Qscore description: >- API 优先的信用局。签发完整的信用报告，评分为 1-999（A-E 等级，无数据时为 SC），查询主体的最新评分，并管理 ARCO 争议。智利先行，设计上与国家无关。每份签发的报告都带有公开验证码。 - name: 分析 - name: Webhooks description: 接收签名事件通知的订阅。 - name: 状态 description: 服务可用性。 - name: 银行服务 description: 真实银行账户:通过国际银行通道接收、持有与发送资金。 - name: 卡片 description: 以 Just-In-Time 方式从你选择的余额(USDT、USDC、BTC 或 GOLD)消费的虚拟卡与实体卡,支持按卡设置消费限额。 - name: 安全(OTP) description: >- 通过 SMS/WhatsApp/email 发送的一次性验证码,保护敏感操作;并提供自助 2FA 偏好设置。仅适用于用户会话——API key 豁免。 - name: 通行密钥 description: >- 通过 WebAuthn 使用设备生物识别(Face ID、Touch ID、Windows Hello、安全密钥)的无密码登录、带备份码的验证器应用(TOTP),以及会话/设备管理。 - name: 社交登录 description: >- 通过令牌交换以 Google、Apple、Microsoft 和 Facebook 实现无密码注册与登录。前端获取提供方凭证;API 验证后签发 CBPay 会话。 - name: 实时事件 description: >- Server-Sent Events 流，实时推送账户内（管理员则为整个组织）发生的所有事件，支持通过 `Last-Event-ID` 重放、可选的初始快照，以及 90 天可查询历史。 paths: /v1/payins/deposit-instructions: get: tags: - 收款(Payins) summary: 预览某通道的存款说明 description: | 返回你的组织为 `bank_transfer` 通道发布的银行账户文本 —— 与已宣告 payin 响应中自动嵌入的内容相同。可用于在付款人创建 payin 之前渲染 "钱应该汇到哪里"页面,或在静态页面上展示当前的存款说明。 只有配置了有效、由管理员设置的说明的通道才会返回内容;其余通道 响应 `404 not_found`(没有可预览的内容 —— 该通道不需要说明,或 尚无人配置)。 operationId: getDepositInstructions parameters: - name: country in: query required: true schema: type: string example: CL - name: currency in: query required: true schema: type: string example: CLP - name: method in: query schema: type: string default: bank_transfer responses: '200': description: 该通道当前有效的存款说明。 content: application/json: schema: type: object properties: deposit_instructions: $ref: '#/components/schemas/DepositInstructions' deposit_instructions_swift: $ref: '#/components/schemas/DepositInstructions' description: >- 该通道的国际 SWIFT 变体（仅 US/USD,配置后返回）。 结构相同,带有自己的 `qr_payload` 和 `qr_png_base64`。 examples: cl_bank_transfer: summary: 智利(CLP) value: deposit_instructions: id: 9f0c1a2b-3d4e-4f5a-8b9c-1a2b3c4d5e6f country: CL currency: CLP method: bank_transfer purpose: payin revision: 3 active: true reference_required: true bank_name: Bank of Example account_number: '0001112223' account_type: checking holder_name: Example Org SpA created_at: '2026-07-15T14:02:00Z' qr_payload: | Bank: Bank of Example Account type: checking Account number: 0001112223 Holder: Example Org SpA qr_png_base64: iVBORw0KGgoAAAANSU... us_bank_transfer: summary: 美国(USD —— 双通道:境内电汇 + 国际 SWIFT) value: deposit_instructions: id: 7b1e4d5a-2c3b-4a59-8877-6f5e4d3c2b1a country: US currency: USD method: bank_transfer purpose: payin revision: 1 active: true reference_required: true bank_name: Partner Bank, N.A. account_number: '000123456789' account_type: checking holder_name: CBPay Operations LLC holder_tax_id: 88-1234567 routing_number: '021000021' holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US created_at: '2026-08-07T10:00:00Z' qr_payload: > Bank: Partner Bank, N.A. Account type: checking Account number: 000123456789 Routing number (ABA): 021000021 Holder: CBPay Operations LLC Holder address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US Tax ID: 88-1234567 qr_png_base64: iVBORw0KGgoAAAANSU... deposit_instructions_swift: id: 8c2f5e6b-3d4c-5b6a-9988-7f6e5d4c3b2a country: US currency: USD method: swift purpose: payin revision: 1 active: true reference_required: true bank_name: Partner Bank International account_number: '9870001234' account_type: checking holder_name: CBPay Operations LLC holder_tax_id: 88-1234567 swift: PRTBPRI3 bank_address: 200 Example Blvd, San Juan, PR 00901, PR intermediary_bank_name: Intermediary Bank N.A. intermediary_bank_swift: INTRUS33 holder_address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US notes: Select Puerto Rico as the final beneficiary bank country created_at: '2026-08-07T10:00:00Z' qr_payload: > Bank: Partner Bank International Account type: checking Account number: 9870001234 SWIFT: PRTBPRI3 Bank address: 200 Example Blvd, San Juan, PR 00901, PR Intermediary bank: Intermediary Bank N.A. Intermediary SWIFT: INTRUS33 Holder: CBPay Operations LLC Holder address: 25 SW 9th Street, Suite 406, Miami, FL 33130, US Tax ID: 88-1234567 Note: Select Puerto Rico as the final beneficiary bank country qr_png_base64: iVBORw0KGgoAAAANSU... '400': description: 缺少 country 或 currency(invalid_payload)。 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: invalid_payload message: country and currency are required '401': $ref: '#/components/responses/Unauthorized' '404': description: 该通道未配置有效的存款说明(not_found)。 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: not_found message: no deposit instructions configured for this corridor components: schemas: DepositInstructions: type: object description: | 你的组织为 `bank_transfer` 通道发布的银行账户文本。由管理员维护, 只追加新版本(新的修订版本永远不会覆盖 payin 已经快照的文本)。 properties: id: type: string format: uuid country: type: string currency: type: string method: type: string purpose: type: string enum: - payin - otc revision: type: integer active: type: boolean reference_required: type: boolean bank_name: type: string account_number: type: string account_type: type: string holder_name: type: string holder_tax_id: type: string holder_email: type: string routing_number: type: string description: 收款银行的 ABA 路由号码（US/USD 通道——境内 ACH 与电汇）。 不使用它的通道中此字段缺省。 swift: type: string description: 收款银行的 SWIFT/BIC（US/USD 通道——国际电汇）。 不使用它的通道中此字段缺省。 bank_address: type: string description: 收款银行的注册地址。当通道银行在汇款单上要求填写时提供 （US/USD）。 intermediary_bank_name: type: string description: 中间（代理）银行名称——仅当通道账户经由代理行接收国际电汇时。 intermediary_bank_swift: type: string description: 中间银行的 SWIFT/BIC（如适用）。 holder_address: type: string description: 账户持有人的邮政地址。当汇款单要求填写时提供（US/USD 通道）。 notes: type: string description: >- 面向付款人的自由格式操作说明（例如："Select Puerto Rico as the final beneficiary bank country"）。当通道需要汇款人提供额外 指示时提供。 created_at: type: string format: date-time qr_payload: type: string description: | 多行纯文本,包含银行账户信息(以及该通道要求时的金额和参考号)。 供人工阅读,不是供银行 App 扫描的。 qr_png_base64: type: string description: | 将 `qr_payload` 渲染为 QR 码的 base64 PNG,顶部居中带有你组织 的品牌符号。 Error: type: object properties: error: type: string description: 机器可读的错误代码(snake_case)。 example: insufficient_funds message: type: string description: 人类可读的说明。 responses: Unauthorized: description: 凭证缺失或无效(`unauthorized`)。 content: application/json: schema: $ref: '#/components/schemas/Error' example: error: unauthorized message: invalid or missing credentials securitySchemes: bearerAuth: type: http scheme: bearer description: | 会话 JWT(来自注册/登录)或 API key(`pk_...`)。 也接受 `X-API-Key: ` 作为替代请求头。 ````