Configuration
List Fiat→Fiat Payment Methods
Retrieve payment methods for a fiat-to-fiat global payment corridor, including separate method lists for the sending and receiving currencies.
GET
/
v2
/
base
/
fiat
/
payments
List Fiat→Fiat Payment Methods
curl --request GET \
--url https://api-test.velafi.com/v2/base/fiat/payments \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/base/fiat/payments"
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/base/fiat/payments', 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/base/fiat/payments")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"onRampCountry": "<string>",
"onRampFiat": "<string>",
"offRampCountry": "<string>",
"offRampFiat": "<string>",
"paymentListFrom": [
{
"paymentId": 123,
"fiatFee": "<string>",
"paymentType": 123
}
],
"paymentListTo": [
{
"paymentId": 123,
"fiatFee": "<string>",
"paymentType": 123
}
]
}
}Use the GET
/v2/base/fiat/payments endpoint to retrieve the payment methods available for a fiat-to-fiat global payment corridor. Provide the originating (on-ramp) and recipient (off-ramp) country and currency as query parameters. The response returns two separate payment method lists — one for the sending side and one for the receiving side — each with its associated fee and processing type. Use this data to present the correct payout rails on both ends of a cross-border payment.
Request
GET /v2/base/fiat/payments
Headers
| Header | Value | Required |
|---|---|---|
X-BH-TOKEN | Your token from GET /v2/token/generate | ✓ |
Query Parameters
string
required
Name of the originating country (e.g.,
"Mexico").string
required
ISO 4217 code for the originating fiat currency (e.g.,
"MXN").string
required
Name of the recipient country (e.g.,
"Argentina").string
required
ISO 4217 code for the recipient fiat currency (e.g.,
"ARS").Response Fields
number
HTTP-style status code.
200 indicates success.string
Human-readable status message, e.g.
"SUCCESS".object
Object containing the echoed corridor and its payment methods for both sides.
Show data
Show data
string
Originating country echoed from the request.
string
Originating fiat currency code echoed from the request.
string
Recipient country echoed from the request.
string
Recipient fiat currency code echoed from the request.
array
Example
cURL
curl --request GET \
--url 'https://api.velafi.com/v2/base/fiat/payments?onRampCountry=Mexico&onRampFiat=MXN&offRampCountry=Argentina&offRampFiat=ARS' \
--header 'X-BH-TOKEN: YOUR_TOKEN'
Response
{
"code": 200,
"msg": "SUCCESS",
"data": {
"onRampCountry": "Mexico",
"onRampFiat": "MXN",
"offRampCountry": "Argentina",
"offRampFiat": "ARS",
"paymentListFrom": [
{
"paymentId": 1,
"fiatFee": "2",
"paymentType": 1
},
{
"paymentId": 2,
"fiatFee": "1.50",
"paymentType": 0
}
],
"paymentListTo": [
{
"paymentId": 1,
"fiatFee": "2",
"paymentType": 1
},
{
"paymentId": 3,
"fiatFee": "1.75",
"paymentType": 0
}
]
}
}
paymentListFrom and paymentListTo may contain different methods and fees because the sending and receiving rails operate independently. Present both lists to the user and collect a paymentId selection for each side before creating the payment order.Was this page helpful?
⌘I
List Fiat→Fiat Payment Methods
curl --request GET \
--url https://api-test.velafi.com/v2/base/fiat/payments \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/base/fiat/payments"
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/base/fiat/payments', 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/base/fiat/payments")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"onRampCountry": "<string>",
"onRampFiat": "<string>",
"offRampCountry": "<string>",
"offRampFiat": "<string>",
"paymentListFrom": [
{
"paymentId": 123,
"fiatFee": "<string>",
"paymentType": 123
}
],
"paymentListTo": [
{
"paymentId": 123,
"fiatFee": "<string>",
"paymentType": 123
}
]
}
}