Paso 1: Obtener las plantillas de métodos de pago
Antes de agregar un beneficiario, obtén la plantilla del método de pago que elegiste. La plantilla te indica exactamente qué campos debes llenar para ese método de pago. EndpointParámetros de la solicitud
El ID numérico del método de pago. Cada método de pago (por ejemplo, SPEI para México, CVU para Argentina, SEPA, WIRE/ACH) tiene su propio ID. Consulta la tabla siguiente para ver los IDs más comunes.
IDs de métodos de pago comunes
Ejemplos de respuestas de plantilla
- México — SPEI (Finco Pay)
- Argentina — CVU/CBU (Momentum)
- SEPA (Bridge)
- WIRE / ACH (Lead Bank)
Account Type: clabe (cuenta virtual) o debit (cuenta de tarjeta).
Bank Code: obligatorio solo cuando Account Type es debit.Paso 2: Agregar un beneficiario
Una vez que tengas la plantilla del método de pago de destino, llena los campos y envía una solicitudPOST para registrar el beneficiario bajo un comercio.
Endpoint
Parámetros de la solicitud
El ID del método de pago. Debe coincidir con un ID de método de pago existente en el sistema.
El nombre completo del país del beneficiario (por ejemplo,
Mexico, Argentina, Brazil).Los campos de la plantilla de pago completados, como un objeto clave-valor. Las claves y los formatos de los valores deben coincidir con la plantilla que devuelve
GET /v2/payments/templates.El nombre real del titular de la cuenta. Opcional, pero recomendado para los registros de cumplimiento.
Ejemplos de solicitudes
México MXN — SPEI (Finco Pay)
México MXN — SPEI (Finco Pay)
Argentina ARS — CVU/CBU (Momentum)
Argentina ARS — CVU/CBU (Momentum)
Brasil BRL — Pix (Genial)
Brasil BRL — Pix (Genial)
Pix Type: CPF (11 dígitos), CNPJ (14 dígitos), EMAIL, PHONE (10-11 dígitos), RANDOM_KEY (con -).Colombia COP — Automatic ACH
Colombia COP — Automatic ACH
Global USD — Wire (CPN)
Global USD — Wire (CPN)
Campos de la respuesta
- Éxito
- Cuenta duplicada
Gestionar beneficiarios
Después de crear beneficiarios, puedes gestionarlos con operaciones adicionales de la API:Obtener beneficiario
Consulta los detalles de un beneficiario guardado mediante su ID de pago de usuario.
Eliminar beneficiario
Elimina un beneficiario que ya no necesitas.
Configurar cuenta de reembolso
Designa a un beneficiario como el destino predeterminado de reembolsos de un comercio.
Obtener plantillas de pago
Referencia completa de todas las plantillas de métodos de pago y los requisitos de sus campos.
Bajo el mismo Merchant ID y
paymentId, el mismo número de cuenta receptora solo puede tener un registro en estado valid a la vez. Si intentas agregar un duplicado, la API devuelve status: 3 con un sameAccountNumberId que apunta al registro válido existente.