Beneficiaries
List Supported Payment Methods
List the payout payment methods available for a country and fiat currency, each with its template fields.
GET
/
v2
/
payments
/
support
/
templates
List Supported Payment Methods
curl --request GET \
--url https://api-test.velafi.com/v2/payments/support/templates \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments/support/templates"
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/payments/support/templates', 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/payments/support/templates")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"payments": [
{
"paymentId": 123,
"country": "<string>",
"paymentMethodName": "<string>",
"paymentType": 123,
"fieldList": {}
}
]
}
}Use this endpoint to discover which payout payment methods are available for a country and fiat currency, and the template fields each one needs. It returns the same kind of field map as Get Payment Method Templates, but for every eligible method in one call.
All requests must include the
X-BH-TOKEN header with a business token from GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/payments/support/templates
Query Parameters
string
required
English country name, for example
Mexico, Brazil or United States.string
Fiat currency code, for example
MXN. If you omit it, payments is empty.Response Fields
number
200 indicates success.string
SUCCESS on success.object
Show data fields
Show data fields
array
Payment methods available for payouts in the given country and fiat currency.
Show payments item fields
Show payments item fields
number
Payment method ID. Use it as
paymentId when adding a beneficiary.string
Not populated by this endpoint.
string
Payment method name.
number
Payment method type code.
0 indicates a manual payment method.object
Map of template fields. Each key is a field
title (see Template Metadata) and each value is the field’s default text, usually empty. If two fields share a title, the later key gets an _<index> suffix, where <index> is that field’s index. For payment methods with an account-owner block, the map also contains one or more of the keys firstName, lastName and businessName.Example
cURL
curl -G https://api.velafi.com/v2/payments/support/templates \
-H "X-BH-TOKEN: YOUR_TOKEN" \
--data-urlencode "country=Mexico" \
--data-urlencode "fiat=MXN"
⌘I
List Supported Payment Methods
curl --request GET \
--url https://api-test.velafi.com/v2/payments/support/templates \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments/support/templates"
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/payments/support/templates', 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/payments/support/templates")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"payments": [
{
"paymentId": 123,
"country": "<string>",
"paymentMethodName": "<string>",
"paymentType": 123,
"fieldList": {}
}
]
}
}