获取待入账资金账户

GET

merchant

addfunds

获取待入账资金账户

curl --request GET \
  --url https://api-test.velafi.com/v2/merchant/addfunds \
  --header 'X-BH-TOKEN: <api-key>'

const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};

fetch('https://api-test.velafi.com/v2/merchant/addfunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "code": 123,
  "msg": "<string>",
  "data": {
    "fiat": "<string>",
    "paymentMethodName": "<string>",
    "txId": "<string>",
    "fieldList": {}
  }
}

使用此端点获取商户待入账资金（Pending Fund）账户的充值说明。预存资金可以加快交易执行速度，因为 VelaFi 无需在下单时等待外部转账结算。响应内容因支付方式而异——例如，MXN CLABE 账户返回 CLABE 号码和收款人名称，而 BRL Pix Woovi 账户返回二维码和可复制粘贴的 Pix 密钥。

支付 ID 95、142 和 144 必须提供 amount，92 和 137 可选。请参阅下方的 amount 参数。

端点

GET https://api.velafi.com/v2/merchant/addfunds

查询参数

integer

必填

商户 ID。

integer

必填

支付通道 ID。支持的值：

ID	方式	币种
`105`	SPEI (Finco Pay)	MXN
`72`	CLABE - Tesored	MXN
`63`	CBU/CVU (Momentum)	ARS
`137`	QR Argentina	ARS
`68`	Automatic ACH（支付链接）	COP
`69`	Bre-B	COP
`142`	BanColombia 链接	COP
`144`	QR Bre-B	COP
`90`	Pix (Genial)	BRL
`92`	Pix - Woovi (Avenia)	BRL
`81`–`84`	ACH / Wire (Lead Bank)	USD
`85`	SEPA (Bridge)	EUR
`95`	银行转账	PEN

string

必填

法币代码：MXN、ARS、COP、BRL、PEN、USD 或 EUR。

string

要充值的虚拟账户别名（可选）。

number

充值金额。95（最低 10 PEN）、142 和 144 必填。92（最低 0.01 BRL）和 137 可选：提供时，响应对应该金额的充值，并包含 txId。

string

PSE（141）的银行代码。PSE 充值目前不适用于本接口。

string

枚举：alias 或 emailAddress。用于 69（Bre-B）：首次调用（创建 Bre-B key 时）必填。

响应字段

number

HTTP 风格的响应码。200 表示成功。

string

可读的状态消息，例如 SUCCESS。

object

显示 data 字段

string

待入账资金账户的法币币种。

string

可读的支付方式名称。

string

充值记录 ID。在调用为指定金额创建充值时返回：95、142 和 144 始终返回；92 和 137 在提供 amount 时返回。

object

充值字段名称到字段值的映射。键取决于支付方式，详见下方的“各支付方式的 fieldList 键”一节。

各支付方式的 `fieldList` 键

每种支付方式的 fieldList 键是固定的。键的值在您调用本接口时，根据商户在该渠道的账户填充。二维码图片以临时链接返回，响应后一小时失效；如需新的链接，请再次调用本接口。

`paymentId`	键	取值	说明
`105` SPEI (Finco Pay)	`Cuenta CLABE`	商户的 CLABE
`72` SPEI (Tesored)	`clabeNumber`	商户的 CLABE
`63` CBU/CVU (Momentum)	`CVU Number`、`CUIT`、`Alias`	CVU、账户持有人的 CUIT 和 CVU 别名	`Alias` 可能为空。
`137` QR Argentina	`qrCodeLink`	二维码图片链接	当 `amount` 大于 `0` 时，二维码对应该金额，并返回 `txId`。
`68` Automatic ACH	`alias`、`paymentLink`	商户别名和充值链接	`alias` 可能为空。
`69` Bre-B	`brebKey`	商户的 Bre-B key	首次调用必须提供 `type`。密钥创建期间请求会失败，请稍后再次调用。
`142` BanColombia	`paymentLink`、`Alias`	本次充值的付款链接；`Alias` 始终为空	必须提供 `amount`。会返回 `txId`。
`144` QR Bre-B	`qrCode`	二维码图片链接	必须提供 `amount`。会返回 `txId`。
`90` Pix (Genial)	`Chave Pix - Random Pix`、`Pix copia e cola`、`Pix QR Code`	商户的随机 Pix key、Pix 复制粘贴码和二维码图片链接	仅当商户有 Pix 二维码时才返回 `Pix copia e cola`。
`92` Pix - Woovi (Avenia)	`pixKey`、`qrCodeLink`、`qrCode`	Pix key、二维码图片链接和 Pix 复制粘贴码	商户没有 Pix key 时不返回 `pixKey`。提供 `amount`（最低 0.01 BRL）时，二维码对应该金额，并返回 `txId`。
`81`、`83` ACH / FedWire reference (Lead Bank)	`Deposit Message`、`Bank Account Number`、`Bank Routing Number`、`Bank Beneficiary Name`、`Bank Name`、`Bank Address`	充值的收款银行信息	取值可能为空。
`82`、`84` ACH / FedWire virtual (Lead Bank)	`Bank Account Number`、`Bank Routing Number`、`Bank Beneficiary Name`、`Bank Name`、`Bank Address`	充值的收款银行信息	取值可能为空。
`85` SEPA (Bridge)	`Deposit Message`、`BIC/Swift Code`、`IBAN`、`Bank Beneficiary Name`、`Bank Name`、`Bank Address`	充值的收款银行信息	`Deposit Message` 返回为空。
`95` Bank Transfer (PEN)	`paymentLink`	本次充值的付款链接	必须提供 `amount`，最低 10 PEN。会返回 `txId`。

141（PSE）、143（Nequi）和 70（VelaFi Pending Fund）不适用于本接口。

示例

MXN (SPEI)
ARS (CVU)
BRL (Pix Genial)
USD (ACH/Wire)
EUR (SEPA)

cURL

curl -G https://api.velafi.com/v2/merchant/addfunds \
  -H "X-BH-TOKEN: YOUR_TOKEN" \
  --data-urlencode "merchantId=100001" \
  --data-urlencode "paymentId=105" \
  --data-urlencode "fiat=MXN"

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "MXN",
    "paymentMethodName": "SPEI - FINCO PAY",
    "fieldList": {
      "Cuenta CLABE": "000000000000000001"
    }
  }
}

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "ARS",
    "paymentMethodName": "Automated Bank Transfer (Argentina)",
    "fieldList": {
      "CVU Number": "0000000000000000000003",
      "CUIT": "20000000002"
    }
  }
}

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "BRL",
    "paymentMethodName": "Pix (Genial)",
    "fieldList": {
      "Chave Pix - Random Pix": "09a3b1d1-49d6-4820-bd19-53e7f50ee13c",
      "Pix copia e cola": "00020101021126580014br.gov.bcb.pix0138...",
      "Pix QR Code": "https://links.qrcode.co/zAOCe/3471397f291c28d19.png"
    }
  }
}

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "USD",
    "paymentMethodName": "ACH_push",
    "fieldList": {
      "Deposit Message": "BRGJT5PNSZX636P9EC2D",
      "Bank Account Number": "11223344556672",
      "Bank Routing Number": "123456790",
      "Bank Beneficiary Name": "Ventures Inc",
      "Bank Name": "Bank of Nowhere",
      "Bank Address": "1800 North Pole St., Orlando, FL 32803"
    }
  }
}

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "EUR",
    "paymentMethodName": "SEPA",
    "fieldList": {
      "Deposit Message": "BRGJT5PNSZX636P9EC2D",
      "BIC/Swift Code": "123456790",
      "IBAN": "11223344556672",
      "Bank Beneficiary Name": "Ventures Inc",
      "Bank Name": "Bank of Nowhere",
      "Bank Address": "1800 North Pole St., Orlando, FL 32803"
    }
  }
}

通过 ACH 或 SEPA 汇款时，请务必附上 Deposit Message（参考码），以便 VelaFi 自动匹配并入账该笔充值。

⌘I

获取待入账资金账户

curl --request GET \
  --url https://api-test.velafi.com/v2/merchant/addfunds \
  --header 'X-BH-TOKEN: <api-key>'

const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};

fetch('https://api-test.velafi.com/v2/merchant/addfunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "code": 123,
  "msg": "<string>",
  "data": {
    "fiat": "<string>",
    "paymentMethodName": "<string>",
    "txId": "<string>",
    "fieldList": {}
  }
}

概览

账户

配置

商户

加密钱包

收款人

报价

订单

Webhooks

获取待入账资金账户

端点

查询参数

响应字段

各支付方式的 `fieldList` 键

示例

​端点

​查询参数

​响应字段

​各支付方式的 fieldList 键

​示例

端点

查询参数

响应字段

各支付方式的 `fieldList` 键

示例