Beneficiarios
Listar métodos de pago compatibles
Lista los métodos de pago para pagos disponibles para un país y una moneda fiat, cada uno con sus campos de plantilla.
GET
/
v2
/
payments
/
support
/
templates
Listar métodos de pago compatibles
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": {}
}
]
}
}Usa este endpoint para saber qué métodos de pago para pagos están disponibles para un país y una moneda fiat, y qué campos de plantilla necesita cada uno. Devuelve el mismo tipo de mapa de campos que Obtener plantillas de métodos de pago, pero para todos los métodos elegibles en una sola llamada.
Todas las solicitudes deben incluir el encabezado
X-BH-TOKEN con un token de negocio obtenido de GET /v2/token/generate.Endpoint
GET https://api.velafi.com/v2/payments/support/templates
Parámetros de consulta
string
requerido
Nombre del país en inglés, por ejemplo
Mexico, Brazil o United States.string
Código de moneda fiat, por ejemplo
MXN. Si lo omites, payments viene vacío.Campos de la respuesta
number
200 indica éxito.string
SUCCESS cuando la operación es exitosa.object
Mostrar campos de data
Mostrar campos de data
array
Métodos de pago disponibles para pagos en el país y la moneda fiat indicados.
Mostrar campos de cada elemento de payments
Mostrar campos de cada elemento de payments
number
ID del método de pago. Úsalo como
paymentId al agregar un beneficiario.string
Este endpoint no lo llena.
string
Nombre del método de pago.
number
Código del tipo de método de pago.
0 indica un método de pago manual.object
Mapa de campos de la plantilla. Cada clave es el
title de un campo (consulta Metadatos de plantillas) y cada valor es el texto predeterminado del campo, normalmente vacío. Si dos campos comparten el mismo título, la clave posterior recibe el sufijo _<index>, donde <index> es el índice de ese campo. En los métodos de pago con un bloque de titular de la cuenta, el mapa también contiene una o más de las claves firstName, lastName y businessName.Ejemplo
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
Listar métodos de pago compatibles
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": {}
}
]
}
}