Get Pending Fund Account

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": {}
  }
}

Use this endpoint to retrieve the deposit instructions for a merchant’s Pending Fund account. Pre-loading funds enables faster trade execution because VelaFi does not need to wait for an external transfer to settle at order time. The response varies by payment method — for example, an MXN CLABE account returns a CLABE number and beneficiary name, while a BRL Pix Woovi account returns a QR code and copy-paste Pix key.

amount is required for payment IDs 95, 142 and 144, and optional for 92 and 137. See the amount parameter below.

Endpoint

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

Query Parameters

integer

required

The ID of the merchant.

integer

required

Payment channel ID. Supported values:

ID	Method	Currency
`105`	SPEI (Finco Pay)	MXN
`72`	CLABE - Tesored	MXN
`63`	CBU/CVU (Momentum)	ARS
`137`	QR Argentina	ARS
`68`	Automatic ACH (payment link)	COP
`69`	Bre-B	COP
`142`	BanColombia Link	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`	Bank Transfer	PEN

string

required

Fiat currency code: MXN, ARS, COP, BRL, PEN, USD, or EUR.

string

Alias of the virtual account to deposit into (optional).

number

Deposit amount. Required for 95 (minimum 10 PEN), 142 and 144. Optional for 92 (minimum 0.01 BRL) and 137: when you send it, the response is for a deposit of that amount and includes txId.

string

Bank code for PSE (141). PSE deposits are not currently available on this endpoint.

string

Enum: alias or emailAddress. Used with 69 (Bre-B): required on the first call, when the Bre-B key is created.

Response Fields

number

HTTP-style response code. 200 indicates success.

string

Human-readable status message, e.g. SUCCESS.

object

Show data fields

string

Fiat currency of the Pending Fund account.

string

Human-readable payment method name.

string

Funding record ID. Returned when the call creates a deposit for a specific amount: always for 95, 142 and 144, and for 92 and 137 when you send amount.

object

Map of deposit field names to values. The keys depend on the payment method; see fieldList Keys by Payment Method.

`fieldList` Keys by Payment Method

The fieldList keys are fixed for each payment method. Their values are filled when you call the endpoint, from the merchant’s account on that channel. QR images are returned as temporary links that expire one hour after the response, so call the endpoint again when you need a fresh link.

`paymentId`	Keys	Values	Notes
`105` SPEI (Finco Pay)	`Cuenta CLABE`	The merchant’s CLABE
`72` SPEI (Tesored)	`clabeNumber`	The merchant’s CLABE
`63` CBU/CVU (Momentum)	`CVU Number`, `CUIT`, `Alias`	The CVU, the account holder’s CUIT, and the CVU alias	`Alias` can be empty.
`137` QR Argentina	`qrCodeLink`	QR image link	With `amount` greater than `0`, the QR is for that amount and `txId` is returned.
`68` Automatic ACH	`alias`, `paymentLink`	The merchant’s alias and the deposit link	`alias` can be empty.
`69` Bre-B	`brebKey`	The merchant’s Bre-B key	The first call must include `type`. While the key is being created, the request fails; call again later.
`142` BanColombia	`paymentLink`, `Alias`	The checkout link for this deposit; `Alias` is always empty	`amount` is required. `txId` is returned.
`144` QR Bre-B	`qrCode`	QR image link	`amount` is required. `txId` is returned.
`90` Pix (Genial)	`Chave Pix - Random Pix`, `Pix copia e cola`, `Pix QR Code`	The merchant’s random Pix key, the Pix copy-and-paste code, and the QR image link	`Pix copia e cola` is returned only when the merchant has a Pix QR code.
`92` Pix - Woovi (Avenia)	`pixKey`, `qrCodeLink`, `qrCode`	The Pix key, the QR image link, and the Pix copy-and-paste code	`pixKey` is omitted when the merchant has none. With `amount` (minimum 0.01 BRL), the QR is for that amount and `txId` is returned.
`81`, `83` ACH / FedWire reference (Lead Bank)	`Deposit Message`, `Bank Account Number`, `Bank Routing Number`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Bank details to send the deposit to	Values can be empty.
`82`, `84` ACH / FedWire virtual (Lead Bank)	`Bank Account Number`, `Bank Routing Number`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Bank details to send the deposit to	Values can be empty.
`85` SEPA (Bridge)	`Deposit Message`, `BIC/Swift Code`, `IBAN`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Bank details to send the deposit to	`Deposit Message` is returned empty.
`95` Bank Transfer (PEN)	`paymentLink`	The checkout link for this deposit	`amount` is required, minimum 10 PEN. `txId` is returned.

141 (PSE), 143 (Nequi) and 70 (VelaFi Pending Fund) are not available on this endpoint.

Examples

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": "00000000-0000-0000-0000-000000000005",
      "Pix copia e cola": "00020101021126580014br.gov.bcb.pix0138...",
      "Pix QR Code": "https://example.com/pix-qr-code.png"
    }
  }
}

Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "fiat": "USD",
    "paymentMethodName": "ACH_push",
    "fieldList": {
      "Deposit Message": "BRG0000000000000000",
      "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": "BRG0000000000000000",
      "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"
    }
  }
}

Always include the Deposit Message (reference code) when sending funds via ACH or SEPA so that VelaFi can automatically match and credit the deposit.

⌘I

Get Pending Fund Account

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": {}
  }
}

Overview

Account

Configuration

Merchants

Crypto Wallet

Beneficiaries

Quotes

Orders

Webhooks

Get Pending Fund Account

Endpoint

Query Parameters

Response Fields

`fieldList` Keys by Payment Method

Examples

​Endpoint

​Query Parameters

​Response Fields

​fieldList Keys by Payment Method

​Examples

Endpoint

Query Parameters

Response Fields

`fieldList` Keys by Payment Method

Examples