Requisitos previos: un token Bearer de acceso con el
CREATE_SHARE_LINK scope. La autenticación básica es rechazada. Contacta a tu representante de ventas para habilitar el acceso. Consulta Autenticación.Qué significan “hosted” / “open-loop”. Un enlace hosted apunta a una página de activación alojada por Fluz. Open-loop significa que la tarjeta virtual resultante es una tarjeta de red (estilo Visa/Mastercard) que se puede usar en muchos comercios, sujeta a las reglas de tu programa — no una tarjeta de regalo de marca única (closed-loop).
Cómo funciona
1
Tú generas enlaces
Llama a
generateVCShareLinks con la oferta, límite de la tarjeta, cantidad, fuente de fondos y un método de entrega. Cada enlace representa una tarjeta con su propio límite, financiada desde la cuenta de gasto que especifiques.2
Fluz crea una solicitud de compartición por enlace
Cada enlace se asigna a una solicitud de compartición (
PENDING) y a una URL alojada.3
El enlace es entregado
Con
GENERATE_URL recibes las URL para distribuirlas tú mismo. Con EMAIL o PHONE_NUMBER, Fluz entrega un enlace a cada destinatario por ti.4
El destinatario activa y reclama la tarjeta
El destinatario abre el enlace y verifica su número de teléfono con un código de un solo uso — sin descargar app, sin contraseña. El límite de la tarjeta se descuenta de tu cuenta de gasto en el momento de la reclamación, no cuando se genera el enlace. La tarjeta no se revela automáticamente al reclamarla; al revelarla se solicita al destinatario ingresar su PIN, o crear uno si aún no lo ha configurado. Consulta Experiencia del destinatario para el recorrido completo.
Disponibilidad y alcance
e
Referencia de operación
ce
Hay tres operaciones públicas, todas protegidas por elCREATE_SHARE_LINK scop
Campos de entrada
s
Fuente de fondos.
userCashBalanceId (una cuenta de gasto perteneciente a tu cuenta emisora) es la fuente de fondos principal y obligatoria. Opcionalmente configura usePrepaymentBalance y/o useRewardsBalance en true para permitir que Fluz recurra a tu saldo de prepayment o de recompensas si la cuenta de gasto no cubre el monto total al momento de la reclamación. Las cuentas bancarias y tarjetas bancarias no son compatibles como fuentes de fondos.Identificación del destinatario y entrega (shareMethod)
)
EXISTING_USER y REGISTER_USER crean la tarjeta virtual como parte de la llamada a generateVCShareLinks, en lugar de diferir la creación de la tarjeta al momento de la reclamación. Consulta Registrar y enviar para el flujo completo de EXISTING_USER, incluyendo cómo registrar primero a un destinatario con registerUser.Reglas de validación
-
cardLimitdebe ser un número entero y al menos el mínimo del programa. -
offerIddebe ser un UUID v4 válido para una oferta activa cuyo comercio sea compartible. -
quantitydebe ser un número entero. -
El campo de destinatario que coincide con
shareMethod(recipientListEmail,recipientListPhone,recipientUserIdsorecipientRegistrations) debe tener longitud igual aquantity. Las discrepancias devuelven un error claro y no crean registros. -
recipientUserIdsyrecipientRegistrationsson mutuamente excluyentes entre sí y con los campos de listas de entrega. -
Cada ID en
recipientUserIdsdebe ser un usuario válido y existente de Fluz. -
userCashBalanceIdes obligatorio y debe ser un UUID v4 válido propiedad de la cuenta del remitente.usePrepaymentBalanceyuseRewardsBalanceson fuentes de respaldo opcionales y pueden habilitarse ambas junto con ella. - Tipos de tarjeta inválidos o entradas con formato incorrecto devuelven errores claros y no crean registros.
-
.
Ejemplos
Respuesta
shareLinkses un arreglo de URL alojadas, una porquantity, cada una con la formahttps://fluz.app/virtual-prepaid-card/{share_request_id}.getVCShareLinks
Lista enlaces de compartición generados previamente para que puedas inspeccionar estado, destinatarios, vencimiento y la tarjeta emitida.Campos de entrada
s
Campos de respuesta (GeneratedShareLink)
)
By status
By batch
By display ID
By display ID
deactivateVCShareLinks
Desactiva (expira) enlaces que generaste — por ejemplo, si un lote se envió por error o necesitas revocar enlaces no reclamados. Desactivar un enlace lo establece enEXPIRED; un enlace no reclamado ya no puede reclamarse.
Campos de entrada
s
"3 share requests successfully deactivated!".
Vencimiento y congelación
La fecha de vencimiento del enlace cumple doble función:- Vencimiento del enlace — después de esta fecha, un enlace no reclamado ya no puede ser reclamado.
- Fecha de congelación/bloqueo de la tarjeta — para una tarjeta emitida, esta es la fecha de bloqueo (fin de ese día). Después, la tarjeta se congela y no se puede usar.
- Vencimiento de la tarjeta se alinea con el fin del mes de la fecha de congelación (por ejemplo, una fecha de congelación de 15/6/2026 produce un vencimiento de tarjeta de 30/6/2026).
- .
Define la ventana con
daysUntilExpirationen el momento de la generación. Si se omite, se usa el valor por defecto del programa (30 días). Esta fecha se muestra al destinatario (normalmente como una fecha “Válida hasta”) — consulta Experiencia del destinatario.Referencia de estados y errores
Estados del objeto de compartición
s
Notas y limitaciones
- La URL devuelta es el destino alojado, no un enlace corto. Internamente, los enlaces también se envuelven mediante un proveedor de enlaces cortos, pero la API devuelve la URL alojada canónica (
/virtual-prepaid-card/{share_request_id}). Distribuye la URL exactamente como se devuelve. userCashBalanceIdes efectivamente obligatorio aunque el esquema lo marque como opcional.- Campos ocultos/internos no forman parte de esta API. El tipo de objeto y el tipo de tarjeta son fijos (
VIRTUAL_CARD/SINGLE_LOAD). La financiación con cuenta bancaria y tarjeta bancaria aún no está habilitada; no las envíes.usePrepaymentBalanceyuseRewardsBalanceson las únicas fuentes de financiación adicionales compatibles hoy. - Los enlaces alojados de tarjetas de regalo no son compatibles. Esta API es solo para tarjetas virtuales.
Próximos pasos
Experiencia del destinatario
Lo que ven tus destinatarios cuando abren un enlace alojado y las reglas que rigen su tarjeta.
Registrar y enviar
Usa
EXISTING_USER para registrar a un destinatario y crear su tarjeta por adelantado, en lugar de al reclamar.Crear una orden masiva
Emite muchas tarjetas a la vez para su distribución programática.