Saltar al contenido principal
GET
Obtener plantillas de métodos de pago
Antes de agregar un beneficiario, llama a este endpoint para saber exactamente qué campos se requieren para un método de pago determinado. Proporciona el paymentId numérico y la API devuelve un objeto cuyas claves corresponden directamente al fieldJson que enviarás al crear un beneficiario. Las plantillas varían mucho según la región: un pago por SPEI en México requiere una CLABE y un tipo de cuenta, un pago a CVU en Argentina requiere un número de CVU/CBU y el CUIT, y una transferencia SEPA requiere un número de cuenta tipo IBAN junto con los datos del titular.

Endpoint

Usa https://api-test.velafi.com/v2/payments/templates para pruebas en sandbox.

Parámetros de la solicitud

integer
requerido
ID numérico del método de pago. Consulta la tabla de Payment ID más abajo para ver todos los valores admitidos.

IDs de métodos de pago

La tabla siguiente muestra todos los métodos de pago admitidos. Usa el valor de la columna Payment ID como parámetro de consulta paymentId.

Campos de la respuesta

integer
Código de estado de la respuesta. 200 indica éxito.
string
Mensaje de respuesta legible, por ejemplo "SUCCESS".
object
Mapa clave-valor de los campos obligatorios de la plantilla. Las claves son los nombres de los campos; los valores son cadenas vacías que indican lo que debes llenar al agregar un beneficiario.

Ejemplos de solicitudes y respuestas

Account Type debe ser clabe (cuenta virtual) o debit (cuenta de tarjeta). Bank Code solo es obligatorio cuando Account Type es debit. Consulta la sección de códigos de banco de FINCO PAY (México) más abajo.

Campos del beneficiario por método de pago

Las tablas siguientes muestran las claves de fieldJson que define cada método de pago habilitado para dispersiones. Se obtienen de las plantillas de métodos de pago que devuelve este endpoint. En tiempo de ejecución, la respuesta de este endpoint es la fuente autorizada.
  • Clave: envía el título del campo que aparece en la columna Clave. Cuando un campo también tiene un indexCode, puedes enviar el indexCode como clave en su lugar.
  • Tipo de titular de la cuenta (Business o Individual): para Business, envía también businessName. Para Individual, envía también firstName y lastName (se requiere al menos uno de los dos).
  • Campos de lista desplegable: envía el code de una de las opciones que este endpoint devuelve para el campo. Cualquier otro valor se rechaza con -4010.
  • Campos obligatorios: una solicitud que omite un campo obligatorio se rechaza con -4010.
  • Los métodos 62, 89 y 103 no definen campos de fieldJson.

Referencia: tablas de códigos de banco