Página de detalles del beneficiario hospedado
Recopila fácilmente los detalles de tu beneficiario para futuros pagos. | Empresarial
Rapyd Disburse se puede usar para pagar a beneficiarios como contratistas, trabajadores, proveedores o empresas de cualquier parte del mundo. La página de detalles de los beneficiarios alojada permite a Rapyd recopilar del beneficiario información confidencial a través de un formulario web seguro para futuros pagos. Para obtener más información sobre cómo reutilizar la información del beneficiario en futuros pagos Cómo reutilizar al beneficiario o al remitente.
Debe pagar a un trabajador contratado de forma regular y necesita una forma eficiente de recopilar y almacenar de forma segura su información personal.
Debes capturar y almacenar de forma segura la información de la cuenta empresarial para poder enviar fácilmente pagos repetidos a tu proveedor empresarial.
Solicitas a Rapyd que genere uno o varios Páginas de detalles de beneficiarios alojadas para diferentes beneficiarios.
Rapyd procesa su solicitud y envía una respuesta con el URL de redireccionamiento.
Muestras la URL de redireccionamiento al cliente.
El cliente completa y envía su información en la página alojada.
Rapyd genera una identificación para que cada beneficiario la reutilice en el futuro.
Los siguientes diagramas de secuencia de mensajes describen cómo se intercambia la información entre Rapyd, el comerciante y los clientes del comerciante.
Crear página de tokenización de beneficiarios
El siguiente diagrama de estados finitos resume los estados de la página de tokenización del beneficiario.
Descripción de los estados
Estado | Descripción |
|---|---|
NUEVO | Nuevo: se creó la página alojada para la tokenización del beneficiario. |
DON | Listo: la página alojada se completó. Se enviaron los detalles del beneficiario. |
EXP | Caducada: la página alojada para la tokenización del beneficiario ha caducado. |
La información del beneficiario se recopila a través de una página alojada y se tokeniza (se almacena en forma de activo digital). Rapyd recopila los datos de forma segura para que no tengas que recopilar, almacenar y enviar información confidencial manualmente. Además, puedes generar varias páginas alojadas y enviarlas a diferentes beneficiarios por correo electrónico para recopilar esta información a través del portal de clientes de Rapyd, tal como se describe Guarda los detalles del beneficiario página de la guía del portal del cliente.
La página alojada admite los siguientes métodos de pago:
Transferencias bancarias
Cartas
Puedes crear una página alojada con el Crea una página de tokenización de beneficiarios API mediante el método POST.
ID de referencia del vendedor
id_de referencia_comerciante es un identificador del beneficiario que enlaza con el comerciante y que aparece en la respuesta de la API.
Generar solicitud de página alojada
El Crear página de tokenización de beneficiarios describe los parámetros de la solicitud.
Soporte de criptomonedas
Usa el payout_currency campo para mostrar las divisas que el beneficiario puede usar para los pagos. Pase el valor USDC para el payout_currency campo para usar el token del beneficiario en las transacciones con criptomonedas.
Solicitud
{ "category": "bank", "sender_entity_type": "company", "sender_country": "US", "merchant_reference_id": "A-1013", "beneficiary_country": "US", "beneficiary_entity_type": "company", "beneficiary_optional_fields": { "last_name": null, "first_name": null, "company_name": "TestBeneficiaryCompany", "identification_type": "company_registered_number", "identification_value": "123456789" } }
Campos opcionales del beneficiario
El beneficiary_optional_fields El objeto es opcional para crear una página alojada, pero es obligatorio cuando se crea un beneficiario. Consulte el campos_opcionales_beneficiarios en el Crear página de tokenización de beneficiarios para obtener más detalles.
Si se pasan estos campos en la solicitud, el beneficiario no tendrá que volver a rellenarlos.
Si estos campos no se incluyen en la solicitud, el beneficiario deberá rellenarlos en la página alojada.
Detalles ampliados del beneficiario
La creación de un beneficiario extendido permite al comerciante recopilar información adicional sobre su beneficiario antes de crear un pago. Se crea un identificador de token de beneficiario y, a continuación, se transfiere al Crea un pago solicitud.
Si el valor de beneficiario _extended_fields está establecido en verdadero, entonces la página de detalles del beneficiario hospedado incluirá campos adicionales para recopilar la información sobre el beneficiario extendido.
Por ejemplo, podrías usar un beneficiario extendido para un pago si:
Realizar desembolsos a creadores de contenido independientes
Creación de pagos para plataformas empresariales basadas en el entretenimiento
Realizar un pago local a un proveedor
Ver Crear beneficiario extendido para obtener más información.
Generar respuesta de página alojada
En la siguiente respuesta se enumeran las redirect_url para mostrar la página de detalles de la cuenta del beneficiario alojada para que el usuario final introduzca información confidencial (número de tarjeta, número de cuenta bancaria, etc.). Crea una página de tokenización de beneficiarios que describe los campos de la respuesta.
Respuesta
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "bb178b63-7134-40c9-9818-b04950f541ac" }, "data": { "id": "hp_ben_d0e257f33e5ef13956ac6037ccb36909", "status": "NEW", "category": "bank", "sender_entity_type": "company", "sender_country": "US", "merchant_reference_id": "A-1013", "beneficiary_entity_type": "company", "beneficiary_country": "US", "beneficiary_currency": "USD", "sender_currency": "USD", "beneficiary_id": null, "payout_method_type": null, "beneficiary_validated": false, "redirect_url": "https://sandboxhosted.rapyd.net/disburse/beneficiary?token=hp_ben_d0e257f33e5ef13956ac6037ccb36909", "merchant_customer_support": { "email": null, "url": null, "phone_number": null }, "expiration": 1614196794, "timestamp": 1612987194, "beneficiary_optional_fields": { "last_name": null, "first_name": null, "company_name": "TestBeneficiaryCompany", "identification_type": "company_registered_number", "identification_value": "123456789" }, "payout_method_types_include": null, "payout_method_types_exclude": null, "complete_url": null, "cancel_url": null } }
Redirige a tu cliente a la URL que has recibido en redirect_url campo para la respuesta.
Caducidad de página
La página del beneficiario alojada caduca 14 días después de su creación de forma predeterminada.
El usuario final o el beneficiario introducirán sus datos en la página alojada que aparece a continuación.
Las páginas alojadas se pueden personalizar mediante el Portal del cliente, tal y como se describe en Personalización de la página alojada .
Se admiten los siguientes idiomas: inglés, islandés, alemán, español, chino simplificado, chino tradicional, coreano, portugués, tailandés, indonesio y tagalo. Especifique su preferencia de idioma en el campo de parámetros de idioma al generar
Rapyd genera una identificación de beneficiario para representar a cada beneficiario enviado a través del formulario de la página alojada. Recibirás las identificaciones de los beneficiarios en el Webhook: creado por el beneficiario después de enviar el formulario.
Configuración de un webhook
Cuando se captura la información del beneficiario, Rapyd envía un webhook. Configure su sistema para recibir webhooks con el procedimiento descrito en Definir un punto final de webhook .
Ahora puedes usar estas identificaciones de beneficiarios para procesar los pagos con Rapyd Disburse usando Crea un pago o Pagos masivos en el portal del cliente.
Antes de insertar el kit de herramientas en tu página, sigue los pasos 1 y 2 para crear la página de detalles de tu cuenta de beneficiario hospedado.
Una vez que hayas creado la página alojada, en la respuesta de la API, recibirás el ID del objeto de la página alojada con los detalles de la cuenta del beneficiario, una cadena que comienza por hpben, (por ejemplo: id: «hp_ben_d0e257f33e5ef13956ac6037ccb36909").
Agrega el siguiente código a la página de detalles de tu cuenta de beneficiario:
Add a <script> tag with the URL of the Rapyd Beneficiary Account Details Toolkit:
<script src="https://toolkit.rapyd.net"></script>
Nota: Para ejecutar este método en sandbox, usa el siguiente código:
<script src="https:/sandboxtoolkit.rapyd.net"></script>
Añade una etiqueta con
id="rapyd-toolkit»:<div id="rapyd-toolkit"></div>
Inicialice los detalles de la cuenta del beneficiario con los siguientes campos:
Javascript
lettoolkit=newRapydToolkit({ button_text: "Submit", // Text that appears on the 'Submit' button. // String. Maximum length is 16 characters. // Default is "Place Your Order". Optional. button_color: "blue", // Color of the 'Submit' button. String. // Standard CSS color name or hexadecimal code such as #323fff. // Default is the color that is returned in the 'merchant_color' // field of the response to 'Create Beneficiary Account Details Page'. Optional.id: "hp_ben_d0e257f33e5ef13956ac6037ccb36909", // ID of the 'Create Beneficiary Account Details Page' response. String. Required.close_on_complete: true, // Causes the embedded Rapyd Beneficiary Account Details Toolkit window to close // when the submission is complete. Boolean. Default is 'true'. Optional. page_type: “beneficiary_token” /* Mandatory for beneficiary account details page Default is "collection". */ });
Llame a Display Toolkit () para mostrar la página de detalles de la cuenta del beneficiario.
toolkit.displayToolkit();
Paso opcional.
close_on_completeestá establecido en falso, llamaToolkit.closeToolkit ()para cerrar la ventana del kit de herramientas para detalles de cuentas de beneficiarios de Rapyd.toolkit.closeToolkit();
Inserta el código que se ejecuta cuando se producen los siguientes eventos. Usa tu código para leer el campo del evento en el objeto de la ventana.
Javascript
{ window.addEventListener('onCreateBeneficiarySuccess', (event) => { console.log(event.detail) // Returns 'Beneficiary' object.// Client code. }) window.addEventListener('onBeneficiaryFailure', (event) => { console.error(event.detail.error) // Returns an error message from the API.// Client code. }) window.addEventListener('onLoading', (event) => { console.error(event.detail.error) // returns true or false depending on the loading state// client code })
Este es un ejemplo de una página de detalles de la cuenta del beneficiario creada con el kit de herramientas:
HTML
<!DOCTYPE html> <html> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Rapyd Beneficiary Account Details Toolkit</title> <script src="https://toolkit.rapyd.net"></script> <script> window.onload = function () { let toolkit = new RapydToolkit({ button_text: "Submit", button_color: "blue", id: "hp_ben_d0e257f33e5ef13956ac6037ccb36909" }); toolkit.displayToolkit(); } window.addEventListener('onCreateBeneficiarySuccess', function (event) { console.log(event.detail) }); window.addEventListener('onBeneficiaryFailure', function (event) { console.log(event.detail.error) }); </script> </head> <body style="background-color: #f1f1f1; display: flex; align-items: center; flex-direction: column; margin: 0"> <h1>Rapyd Beneficiary Account Details Toolkit Demo</h1> <div style="width: 500px" id="rapyd-toolkit"></div> </body> </html>
Evento de éxito
Tras la presentación exitosa, los clientes reciben un En Create Beneficiary Success evento con el Objeto beneficiario.
Tome nota de los siguientes campos de objeto beneficiario y de las tareas asociadas a cada uno de ellos.
Campo | Descripción | Acción |
|---|---|---|
| ID del objeto «beneficiario». Cadena que comienza por beneficiary_. | Puedes capturar el identificador del beneficiario, que es el identificador único de la persona o empresa que recibe el pago. Usa la identificación para validar o recuperar al beneficiario |
| Tipo de entidad. Uno de los siguientes valores: empresa individual | Una persona puede incluir más información personal. Su nombre y apellidos deben coincidir con el nombre que figura en el identification_type |
| Tipo de documento de identificación del beneficiario. Si entity_type es una empresa, este campo debe ser company_registered_number. Cuando entity_type es individual, uno de los siguientes valores: drivers_license identification_id international_passport residence_permit social_security work_permit | identification_value debe ser el número de identificación del documento. |
Recomendación: Asegúrese de implementar elementos de navegación (por ejemplo, volver, devolver o cancelar) en su sitio web al integrar la solución de integración de Toolkit.
Configuración de un webhook
Cuando se captura la información del beneficiario, Rapyd envía un webhook. Configure su sistema para recibir webhooks con el procedimiento descrito en Definición de un endpoint de webhook.