跳转到主要内容
GET
获取支付方式模板
添加收款人之前,请调用此接口以确切了解某个支付方式需要哪些字段。传入数字 paymentId 后,API 会返回一个对象,其键直接对应你在创建收款人时要提交的 fieldJson。不同地区的模板差异很大 —— 墨西哥 SPEI 付款需要 CLABE 和账户类型,阿根廷 CVU 付款需要 CVU/CBU 号码和 CUIT,而 SEPA 转账则需要 IBAN 格式的账号以及账户持有人信息。

接口地址

在沙盒环境中测试时,请使用 https://api-test.velafi.com/v2/payments/templates。

请求参数

integer
必填
支付方式的数字 ID。所有支持的取值请参见下方的支付方式 ID 表。

支付方式 ID

下表列出了所有支持的支付方式。请将 Payment ID 列的值用作 paymentId 查询参数。

响应字段

integer
响应状态码。200 表示成功。
string
可读的响应信息,例如 "SUCCESS"。
object
必填模板字段的键值映射。键为字段名;值为空字符串,表示添加收款人时需要填写的内容。

请求与响应示例

Account Type 必须为 clabe(虚拟账户)或 debit(银行卡账户)。仅当 Account Type 为 debit 时才需要 Bank Code。请参见下方的墨西哥 FINCO PAY 银行代码部分。

各支付方式的收款人字段

下表列出每个已启用付款方式定义的 fieldJson 键,取自支付方式模板。运行时请以本接口返回的内容为准。
  • 键: 发送 键 列中的字段标题。如果字段还有 indexCode,也可以改用 indexCode 作为键。
  • 账户持有人类型(Business 或 Individual): 为 Business 时,还需发送 businessName;为 Individual 时,还需发送 firstName 和 lastName(两者至少填写一个)。
  • 下拉字段: 发送本接口为该字段返回的某个选项的 code。其他值会被拒绝并返回 -4010。
  • 必填字段: 缺少必填字段的请求会被拒绝并返回 -4010。
  • 支付方式 62、89 和 103 未定义 fieldJson 字段。

参考:银行代码表