Obtener la cuenta Pending Fund

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

Usa este endpoint para obtener las instrucciones de depósito de la cuenta Pending Fund (fondos pendientes) de un comercio. Precargar fondos permite ejecutar las operaciones más rápido, porque VelaFi no necesita esperar a que se liquide una transferencia externa al momento de crear la orden. La respuesta varía según el método de pago: por ejemplo, una cuenta CLABE en MXN devuelve un número CLABE y el nombre del beneficiario, mientras que una cuenta Pix Woovi en BRL devuelve un código QR y la clave Pix para copiar y pegar.

amount es obligatorio para los IDs de pago 95, 142 y 144, y opcional para 92 y 137. Consulta el parámetro amount más abajo.

Endpoint

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

Parámetros de consulta

integer

requerido

El ID del comercio.

integer

requerido

ID del canal de pago. Valores admitidos:

ID	Método	Moneda
`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

requerido

Código de moneda fiat: MXN, ARS, COP, BRL, PEN, USD o EUR.

string

Alias de la cuenta virtual en la que se depositará (opcional).

number

Monto del depósito. Obligatorio para 95 (mínimo 10 PEN), 142 y 144. Opcional para 92 (mínimo 0.01 BRL) y 137: cuando lo envías, la respuesta corresponde a un depósito por ese monto e incluye txId.

string

Código de banco para PSE (141). Por ahora, los depósitos PSE no están disponibles en este endpoint.

string

Enum: alias o emailAddress. Se usa con 69 (Bre-B): es obligatorio en la primera llamada, cuando se crea la clave Bre-B.

Campos de la respuesta

number

Código de respuesta de estilo HTTP. 200 indica éxito.

string

Mensaje de estado legible, p. ej. SUCCESS.

object

Mostrar campos de data

string

Moneda fiat de la cuenta Pending Fund.

string

Nombre legible del método de pago.

string

ID del registro de fondeo. Se devuelve cuando la llamada crea un depósito por un monto específico: siempre para 95, 142 y 144, y para 92 y 137 cuando envías amount.

object

Mapa de nombres de campos de depósito a sus valores. Las claves dependen del método de pago; consulta Claves de fieldList por método de pago.

Claves de `fieldList` por método de pago

Las claves de fieldList son fijas para cada método de pago. Sus valores se llenan cuando llamas al endpoint, a partir de la cuenta del comercio en ese canal. Las imágenes QR se devuelven como enlaces temporales que expiran una hora después de la respuesta, así que vuelve a llamar al endpoint cuando necesites un enlace nuevo.

`paymentId`	Claves	Valores	Notas
`105` SPEI (Finco Pay)	`Cuenta CLABE`	La CLABE del comercio
`72` SPEI (Tesored)	`clabeNumber`	La CLABE del comercio
`63` CBU/CVU (Momentum)	`CVU Number`, `CUIT`, `Alias`	El CVU, el CUIT del titular de la cuenta y el alias del CVU	`Alias` puede estar vacío.
`137` QR Argentina	`qrCodeLink`	Enlace a la imagen QR	Con `amount` mayor que `0`, el QR corresponde a ese monto y se devuelve `txId`.
`68` Automatic ACH	`alias`, `paymentLink`	El alias del comercio y el enlace de depósito	`alias` puede estar vacío.
`69` Bre-B	`brebKey`	La clave Bre-B del comercio	La primera llamada debe incluir `type`. Mientras se crea la clave, la solicitud falla; vuelve a llamar más tarde.
`142` BanColombia	`paymentLink`, `Alias`	El enlace de pago (checkout) para este depósito; `Alias` siempre está vacío	`amount` es obligatorio. Se devuelve `txId`.
`144` QR Bre-B	`qrCode`	Enlace a la imagen QR	`amount` es obligatorio. Se devuelve `txId`.
`90` Pix (Genial)	`Chave Pix - Random Pix`, `Pix copia e cola`, `Pix QR Code`	La clave Pix aleatoria del comercio, el código Pix para copiar y pegar, y el enlace a la imagen QR	`Pix copia e cola` solo se devuelve cuando el comercio tiene un código QR de Pix.
`92` Pix - Woovi (Avenia)	`pixKey`, `qrCodeLink`, `qrCode`	La clave Pix, el enlace a la imagen QR y el código Pix para copiar y pegar	`pixKey` se omite cuando el comercio no tiene una. Con `amount` (mínimo 0.01 BRL), el QR corresponde a ese monto y se devuelve `txId`.
`81`, `83` ACH / FedWire de referencia (Lead Bank)	`Deposit Message`, `Bank Account Number`, `Bank Routing Number`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Datos bancarios a los que debes enviar el depósito	Los valores pueden estar vacíos.
`82`, `84` ACH / FedWire virtual (Lead Bank)	`Bank Account Number`, `Bank Routing Number`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Datos bancarios a los que debes enviar el depósito	Los valores pueden estar vacíos.
`85` SEPA (Bridge)	`Deposit Message`, `BIC/Swift Code`, `IBAN`, `Bank Beneficiary Name`, `Bank Name`, `Bank Address`	Datos bancarios a los que debes enviar el depósito	`Deposit Message` se devuelve vacío.
`95` Bank Transfer (PEN)	`paymentLink`	El enlace de pago (checkout) para este depósito	`amount` es obligatorio, mínimo 10 PEN. Se devuelve `txId`.

141 (PSE), 143 (Nequi) y 70 (VelaFi Pending Fund) no están disponibles en este endpoint.

Ejemplos

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

Incluye siempre el Deposit Message (código de referencia) cuando envíes fondos por ACH o SEPA, para que VelaFi pueda identificar y acreditar el depósito automáticamente.

⌘I

Obtener la cuenta Pending Fund

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

Descripción general

Cuenta

Configuración

Comercios

Billetera cripto

Beneficiarios

Cotizaciones

Órdenes

Webhooks

Obtener la cuenta Pending Fund

Endpoint

Parámetros de consulta

Campos de la respuesta

Claves de `fieldList` por método de pago

Ejemplos

​Endpoint

​Parámetros de consulta

​Campos de la respuesta

​Claves de fieldList por método de pago

​Ejemplos

Endpoint

Parámetros de consulta

Campos de la respuesta

Claves de `fieldList` por método de pago

Ejemplos