Cuenta
Obtener los detalles de la cuenta
Obtén la información básica de la cuenta del usuario autenticado, incluidos el nombre de la empresa, el país, el estado de KYC y los límites de transacción mensuales.
GET
/
v2
/
user
/
account
Obtener los detalles de la cuenta
curl --request GET \
--url https://api-test.velafi.com/v2/user/account \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/user/account"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/user/account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/user/account")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"userId": 123,
"country": "<string>",
"companyName": "<string>",
"kycPassed": true,
"monthLimit": 123,
"monthUsed": 123
}
}El endpoint
Equivalente en sandbox
GET /v2/user/account devuelve la información principal de la cuenta asociada a tu clave de API: el nombre de la empresa, el país de registro, el estado de verificación KYC y el límite de transacción mensual, junto con cuánto de ese límite ya consumiste en el mes calendario en curso. Usa este endpoint para verificar el estado de la cuenta o para habilitar funciones en tu aplicación según el estado de KYC o la capacidad mensual restante.
Endpoint
| Propiedad | Valor |
|---|---|
| Método | GET |
| Ruta | /v2/user/account |
| Autenticación | Obligatoria — header X-BH-TOKEN |
| Cuerpo de la solicitud | Ninguno |
Parámetros de la solicitud
Este endpoint no recibe parámetros de consulta ni cuerpo de solicitud. La autenticación es el único requisito.Campos de la respuesta
number
requerido
El código numérico de respuesta.
200 indica una respuesta exitosa.string
requerido
Un mensaje breve que describe el resultado. Devuelve
"SUCCESS" cuando la solicitud es exitosa.object
requerido
Un objeto que contiene los detalles de la cuenta del usuario autenticado.
Mostrar campos de data
Mostrar campos de data
number
requerido
El identificador numérico único de la cuenta del usuario autenticado.
string
requerido
El nombre completo del país en el que está registrada la cuenta (por ejemplo,
"Argentina").string
requerido
La razón social de la empresa asociada a esta cuenta.
boolean
requerido
Indica si la cuenta completó correctamente el proceso de verificación KYC (Know Your Customer). La creación de órdenes y los pagos normalmente están bloqueados hasta que este valor sea
true.number
requerido
El límite total de transacciones mensuales de esta cuenta, expresado en USD. Por ejemplo,
250000.0 representa un tope mensual de $250,000.number
requerido
El valor acumulado en USD de las transacciones procesadas en el mes calendario en curso. Se restablece a
0.0 al inicio de cada mes.Ejemplo de solicitud
curl --request GET \
--url https://api.velafi.com/v2/user/account \
--header "X-BH-TOKEN: your_token"
curl --request GET \
--url https://api-test.velafi.com/v2/user/account \
--header "X-BH-TOKEN: your_sandbox_token"
Ejemplo de respuesta
{
"code": 200,
"msg": "SUCCESS",
"data": {
"userId": 1,
"country": "Argentina",
"companyName": "velafi",
"kycPassed": true,
"monthLimit": 250000.0,
"monthUsed": 0.0
}
}
El campo
kycPassed refleja si tu cuenta completó el proceso de verificación Know Your Customer. Si kycPassed es false, contacta al soporte de VelaFi o completa los pasos de KYC en el portal del comercio antes de intentar crear órdenes reales.Calcula
monthLimit menos monthUsed antes de enviar órdenes grandes para confirmar que tienes suficiente capacidad restante en el mes en curso. Si necesitas un límite mensual más alto, contacta al soporte de VelaFi.⌘I
Obtener los detalles de la cuenta
curl --request GET \
--url https://api-test.velafi.com/v2/user/account \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/user/account"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/user/account', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/user/account")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"userId": 123,
"country": "<string>",
"companyName": "<string>",
"kycPassed": true,
"monthLimit": 123,
"monthUsed": 123
}
}