Merchants
Get Transfer Fee
Look up the applicable inter-merchant transfer fee for a fiat currency before initiating a Pending Fund transfer — fixed or percentage model.
GET
/
v2
/
merchant
/
transfer_fee
Get Transfer Fee
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/transfer_fee \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/transfer_fee"
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/transfer_fee', 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/transfer_fee")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"fiat": "<string>",
"feeType": 123,
"fee": 123
}
}Use this endpoint to retrieve the applicable fee before transferring funds between merchant accounts. VelaFi supports two fee models: a fixed flat-rate fee and a percentage-based fee. Check the fee before calling Transfer Pending Funds so you can display accurate cost information to your users.
All requests must include the
X-BH-TOKEN header with a business token from GET /v2/token/generate. Currently supported currencies are MXN and ARS.Endpoint
GET https://api.velafi.com/v2/merchant/transfer_fee
Query Parameters
string
required
Fiat currency to check the transfer fee for. Supported values:
MXN, ARS.Response Fields
number
HTTP-style response code.
200 indicates success.string
Human-readable status message, e.g.
SUCCESS.object
Examples
- Percentage Fee
- Fixed Fee
cURL
curl -G https://api.velafi.com/v2/merchant/transfer_fee \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "fiat=MXN"
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"fiat": "MXN",
"feeType": 1,
"fee": 0.01
}
}
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"fiat": "MXN",
"feeType": 0,
"fee": 5
}
}
When
feeType is 1 (percentage), multiply fee by the transfer amount to calculate the cost. For example, a fee of 0.01 on a 1,000 MXN transfer equals a 10 MXN fee.Was this page helpful?
⌘I
Get Transfer Fee
curl --request GET \
--url https://api-test.velafi.com/v2/merchant/transfer_fee \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/merchant/transfer_fee"
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/transfer_fee', 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/transfer_fee")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"fiat": "<string>",
"feeType": 123,
"fee": 123
}
}