Beneficiarios
Obtener metadatos de plantillas
Obtén metadatos detallados a nivel de campo de la plantilla de un método de pago, incluidas reglas de validación, tipos de texto y listas de opciones desplegables.
GET
/
v2
/
payments
/
templates
/
metamessage
Obtener metadatos de plantillas
curl --request GET \
--url https://api-test.velafi.com/v2/payments/templates/metamessage \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments/templates/metamessage"
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/templates/metamessage', 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/templates/metamessage")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.id": 123,
"data.paymentName": "<string>",
"data.paymentType": 123,
"data.trench": "<string>",
"data.fieldList": [
{
"index": 123,
"indexCode": "<string>",
"title": "<string>",
"textType": 123,
"promptText": "<string>",
"minLimit": 123,
"maxLimit": 123,
"isOptional": true,
"isAccount": true,
"extendInfo": "<string>"
}
]
}
}Mientras que
/v2/payments/templates devuelve un esqueleto simple de clave-valor, este endpoint proporciona todos los metadatos que tu interfaz necesita para mostrar y validar cada campo correctamente. Para cada campo recibes su índice de posición, un indexCode único (úsalo como clave en fieldJson cuando no esté vacío), un título para mostrar, el tipo de texto esperado, los límites mínimo y máximo de caracteres, si el campo es opcional y cualquier opción de lista desplegable codificada en extendInfo. Usa este endpoint para construir dinámicamente formularios de creación de beneficiarios sin codificar las reglas de los campos.
Endpoint
GET https://api.velafi.com/v2/payments/templates/metamessage
Usa
https://api-test.velafi.com/v2/payments/templates/metamessage para hacer pruebas en sandbox.Parámetros de la solicitud
integer
requerido
El ID numérico del método de pago cuyos metadatos de campos quieres obtener.
Campos de la respuesta
integer
Código de estado de la respuesta.
200 indica éxito.string
Mensaje de respuesta legible, por ejemplo
"SUCCESS".object
Objeto de metadatos del método de pago.
Mostrar campos de data
Mostrar campos de data
integer
El ID del método de pago.
string
Nombre para mostrar del método de pago (por ejemplo,
"Wire (CPN)").integer
Código numérico que representa la categoría del tipo de pago.
string
El canal de pago o proveedor subyacente (por ejemplo,
"Circle Payment Network").array
Lista ordenada de descriptores de campo. Cada elemento describe un campo de entrada.
Mostrar campos de cada elemento de fieldList
Mostrar campos de cada elemento de fieldList
integer
Posición secuencial del campo en el formulario.
string
Código único de este campo. Cuando no está vacío, usa este valor como clave en
fieldJson al agregar un beneficiario. Cuando está vacío, usa en su lugar el valor de title.string
Etiqueta legible que se muestra para el campo.
integer
Código numérico que describe el formato de entrada esperado. Consulta la tabla de tipos de texto más abajo.
string
Texto de marcador de posición o de instrucciones que se muestra dentro del campo de entrada.
integer
Longitud mínima de caracteres o valor numérico mínimo permitido.
integer
Longitud máxima de caracteres o valor numérico máximo permitido.
boolean
true si el campo se puede omitir; false si es obligatorio.boolean
true si este campo representa el número o identificador de cuenta.string
Cadena JSON con metadatos adicionales. Para
textType 10 (lista desplegable), contiene el arreglo de opciones, por ejemplo [{"code":"B2B","name":"B2B"},{"code":"B2C","name":"B2C"}]. Cadena vacía para los demás tipos.Referencia de tipos de texto
| Valor | Tipo | Descripción |
|---|---|---|
| 1 | number | Solo caracteres numéricos (0–9) |
| 2 | letter | Solo caracteres alfabéticos (A–Z, a–z) |
| 3 | alphanumeric | Solo letras y números |
| 4 | string | Cualquier cadena de texto libre |
| 5 | image | Datos de imagen. Súbela mediante /v2/base/file/upload y envía la ruta devuelta. Separa varias rutas con comas. |
| 6 | ISO 3166-1 | Código de país (por ejemplo, US, CN) |
| 7 | ISO 3166-2 | Código de subdivisión (por ejemplo, US-CA) |
| 8 | international dialing code | Código de marcación del país (por ejemplo, 1, 86) |
| 9 | date | Fecha en formato yyyy-MM-dd |
| 10 | dropdown list | Valor enumerado; las opciones están codificadas como JSON en extendInfo |
Ejemplo
curl -X GET "https://api.velafi.com/v2/payments/templates/metamessage?paymentId=120" \
-H "X-BH-TOKEN: YOUR_TOKEN"
{
"code": 200,
"msg": "SUCCESS",
"data": {
"id": 120,
"paymentName": "Wire (CPN)",
"paymentType": 5,
"trench": "Circle Payment Network",
"fieldList": [
{
"index": 1,
"indexCode": "beneficiaryName",
"textType": 4,
"title": "Beneficiary Name",
"promptText": "Please enter Beneficiary Name",
"minLimit": 1,
"maxLimit": 300,
"isOptional": false,
"isAccount": false,
"extendInfo": ""
},
{
"index": 3,
"indexCode": "country",
"textType": 6,
"title": "Nationality",
"promptText": "Please select Nationality",
"minLimit": 1,
"maxLimit": 300,
"isOptional": false,
"isAccount": false,
"extendInfo": ""
},
{
"index": 9,
"indexCode": "dateOfBirth",
"textType": 9,
"title": "Date of Birth / Date of Incorporation",
"promptText": "Please enter Date of Birth / Date of Incorporation (yyyy-MM-dd)",
"minLimit": 1,
"maxLimit": 10,
"isOptional": true,
"isAccount": false,
"extendInfo": ""
},
{
"index": 13,
"indexCode": "useCase",
"textType": 10,
"title": "Use Case",
"promptText": "Please select Use Case",
"minLimit": 1,
"maxLimit": 100,
"isOptional": false,
"isAccount": false,
"extendInfo": "[{\"code\":\"B2B\",\"name\":\"B2B\"},{\"code\":\"B2C\",\"name\":\"B2C\"},{\"code\":\"C2B\",\"name\":\"C2B\"},{\"code\":\"C2C\",\"name\":\"C2C\"}]"
},
{
"index": 24,
"indexCode": "accountNumber",
"textType": 3,
"title": "Account Number",
"promptText": "Please enter Account Number",
"minLimit": 1,
"maxLimit": 34,
"isOptional": false,
"isAccount": true,
"extendInfo": ""
}
]
}
}
Cuando
indexCode no está vacío, úsalo como clave en el cuerpo de tu fieldJson. Cuando indexCode está vacío, usa en su lugar la cadena de title como clave.⌘I
Obtener metadatos de plantillas
curl --request GET \
--url https://api-test.velafi.com/v2/payments/templates/metamessage \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/payments/templates/metamessage"
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/templates/metamessage', 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/templates/metamessage")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": {
"data.id": 123,
"data.paymentName": "<string>",
"data.paymentType": 123,
"data.trench": "<string>",
"data.fieldList": [
{
"index": 123,
"indexCode": "<string>",
"title": "<string>",
"textType": 123,
"promptText": "<string>",
"minLimit": 123,
"maxLimit": 123,
"isOptional": true,
"isAccount": true,
"extendInfo": "<string>"
}
]
}
}