Página alojada de detalles del beneficiario
Recopile fácilmente los detalles de su beneficiario para futuros desembolsos. | Empresarial
Rapyd Disburse se puede usar para pagar a beneficiarios como contratistas, trabajadores, proveedores o empresas de cualquier parte del mundo. La página alojada de detalles del beneficiario permite a Rapyd recopilar la información confidencial del beneficiario a través de un formulario web seguro para futuros desembolsos. Para obtener más información sobre cómo reutilizar la información del beneficiario en futuros desembolsos, ver Reutilizar el beneficiario o 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.
Debe capturar y almacenar de forma segura la información de la cuenta empresarial para poder enviar fácilmente desembolsos repetidos a su proveedor empresarial.
Solicita a Rapyd que genere una o varias Páginas alojadas de detalles de beneficiarios para diferentes beneficiarios.
Rapyd procesa su solicitud y envía una respuesta con redirect URL.
Muestra la URL de redireccionamiento al cliente.
El cliente completa y envía su información en la página alojada.
Rapyd genera un ID para cada beneficiario a reutilizar en el futuro.
Los siguientes diagramas de secuencia de mensajes describen cómo se intercambia la información entre Rapyd, el comercio y los clientes del comercio.
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 |
|---|---|
NEW | Nuevo: se creó la página alojada de tokenización del beneficiario. |
DON | Listo: la página alojada se completó. Se enviaron los detalles del beneficiario. |
EXP | Expirado: la página alojada para la tokenización del beneficiario ha expirado. |
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 tenga que recopilar, almacenar y enviar información confidencial manualmente. Además, puede generar varias páginas alojadas y enviarlas a diferentes beneficiarios por correo electrónico para recopilar esta información a través del Rapyd Client Portal, tal como se describe en la página Guardar los detalles del beneficiario de la guía del Client Portal.
La página alojada admite los siguientes métodos de desembolso:
Transferencias bancarias
Tarjetas
Puedes crear una página alojada con la API Crear una página de tokenización de beneficiarios mediante el método POST.
ID de referencia del comercio
merchant_reference_id es un ID para el beneficiario que se enlaza con el comercio y que aparece en la respuesta de la API.
Solicitud para generar una página alojada
Crear página de tokenización de beneficiarios describe los parámetros de la solicitud.
Soporte de criptomonedas
Use el campo payout_currency para mostrar las monedas que el beneficiario puede usar para los desembolsos. Pase el valor USDC para el campo payout_currency 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 objeto beneficiary_optional_fields es opcional para crear una página alojada, pero es obligatorio cuando se crea un beneficiario. Consulte beneficiary_option_fields en Crear página de tokenización de beneficiarios para obtener más detalles.
Si estos campos se incluyen en la solicitud, el beneficiario no tendrá que volver a llenar.
Si estos campos no se incluyen en la solicitud, el beneficiario deberá llenarlos en la página alojada.
Detalles del beneficiario extendido
La creación de un beneficiario extendido permite al comercio recopilar información adicional sobre su beneficiario antes de crear un desembolso. Se crea un ID del token de beneficiario y luego se transfiere a la solicitud Crear un pago.
Si el valor de beneficiary_extended_fields está establecido a verdadero, entonces la página alojada de detalles del beneficiario incluirá campos adicionales para recopilar la información sobre el beneficiario extendido.
Por ejemplo, puede usar un beneficiario extendido para un desembolso si:
Realizar desembolsos a creadores de contenido independientes
Crear desembolsos para plataformas empresariales basadas en el entretenimiento
Realizar un desembolso local a un proveedor
Ver Crear beneficiario extendido para obtener más información.
Respuesta para generar de página alojada
En la siguiente respuesta figura la redirect_url para mostrar la página alojada de detalles de la cuenta del beneficiario para que el usuario final introduzca información confidencial (número de tarjeta, número de cuenta bancaria, etc.). Crear una página de tokenización de beneficiarios 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 } }
Redirija a su cliente a la URL que ha recibido en el campo redirect_url para la respuesta.
Expiración de página
La página alojada del beneficiario expira 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 Client Portal, tal y como se describe en Personalizar 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 la página.
Rapyd genera un ID de beneficiario para representar a cada beneficiario enviado a través del formulario de la página alojada. Recibirá los ID de los beneficiarios en el Webhook: beneficiario creado 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 siguiendo el procedimiento descrito en Definir un punto final de webhook .
Ahora puede usar los ID los de beneficiarios para procesar los pagos con Rapyd Disburse usando Crear un desembolso o Desembolsos masivos en el Client Portal.
Antes de integrar el toolkit a su página, siga los pasos 1 y 2 para crear su página alojada de detalles de cuenta del beneficiario.
Una vez que haya creado la página alojada, en la respuesta de la API, recibirá el ID del objeto de la página alojada con los detalles de la cuenta del beneficiario, una cadena que comienza por hp_ben, (por ejemplo: id: «hp_ben_d0e257f33e5ef13956ac6037ccb36909").
Adicione el siguiente código a la página de detalles de su cuenta de beneficiario:
Adicione una etiqueta <script> la URL del toolkit de detalles de la cuenta del beneficiario Rapyd:
<script src="https://toolkit.rapyd.net"></script>
Nota: Para ejecutar este método en el sandbox, use el siguiente código:
<script src="https:/sandboxtoolkit.rapyd.net"></script>
Adicione una etiqueta con
id="rapyd-toolkit»:<div id="rapyd-toolkit"></div>
Inicie 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, llameToolkit.closeToolkit()para cerrar la ventana de toolkit para detalles de cuentas de beneficiarios de Rapyd.toolkit.closeToolkit();
Inserta el código que se ejecuta cuando se producen los siguientes eventos. Use su 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 toolkit:
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 exitoso
Al enviar correctamente, los clientes reciben un evento onCreateBeneficiarySuccess 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 «beneficiary». Cadena que comienza por beneficiary_. | Puede capturar el ID del beneficiario, que es el identificador único de la persona o empresa que recibe el desembolso. Use el ID para validar o recuperar al beneficiario. |
| Tipo de entidad. Uno de los siguientes valores: persona empresa | Una persona puede incluir más información personal. Su nombre y apellidos deben coincidir con el nombre que figura en 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 una persona, use 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 siguiendo el procedimiento descrito en Definición de un endpoint de webhook.