Beneficiaries
Check an Alias (ARS)
Look up the CBU/CVU, status, and account holders behind an Argentine account alias.
GET
/
v2
/
merchant
/
check
/
alias
Check an Alias (ARS)
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/check/alias \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/check/alias"
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/merchant/check/alias', 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/merchant/check/alias")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"alias": "<string>",
"cbu": "<string>",
"activa": true,
"freezed": true,
"openTime": 123,
"titulares": [
{
"type": 123,
"cuit": "<string>",
"accountName": "<string>"
}
]
}
}Use this endpoint to resolve an Argentine account alias to the CBU/CVU it points to, together with the account status and the registered holders.
If the alias cannot be resolved, the request fails with an invalid-parameter error.
All requests must include the
X-BH-TOKEN header with an access token. See Authentication. This endpoint returns code 0 and msg success on success, not 200/SUCCESS.Endpoint
GET https://api.velafi.com/v2/merchant/check/alias
Query Parameters
string
required
The alias to look up.
Response Fields
number
0 indicates success.string
success on success.object
Show data fields
Show data fields
string
The account’s current alias.
string
The CBU/CVU the alias currently points to.
boolean
Whether the account is active.
boolean
Whether the CBU/CVU is blocked.
number
Time the CBU/CVU was opened (Unix timestamp in milliseconds).
Example
cURL
curl -G https://api.velafi.com/v2/merchant/check/alias \
-H "X-BH-TOKEN: YOUR_ACCESS_TOKEN" \
--data-urlencode "alias=example.alias"
⌘I
Check an Alias (ARS)
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/check/alias \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/check/alias"
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/merchant/check/alias', 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/merchant/check/alias")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"alias": "<string>",
"cbu": "<string>",
"activa": true,
"freezed": true,
"openTime": 123,
"titulares": [
{
"type": 123,
"cuit": "<string>",
"accountName": "<string>"
}
]
}
}