Skip to main content

Documentación

Validación de los detalles del beneficiario

Verifica a tus beneficiarios para recibir los pagos. | Empresa

Antes de usar un beneficiario Al crear un pago, Rapyd recomienda que compruebes que no se ha cometido ningún error al crear el ID. Para ello, validas los detalles del beneficiario para el tipo de método de pago correspondiente

Por ejemplo, tu servicio de viajes compartidos tiene un sitio web o una aplicación móvil que está registrada en la plataforma Rapyd. Su administrador de nóminas usa billetera de la empresa para pagar a los conductores. Uno de tus conductores es un empleado al que transfieres un salario mensual del monedero de la empresa a la cuenta bancaria del conductor.

En este ejemplo, el conductor es el beneficiario del pago. El administrador de nóminas quiere evitar volver a introducir los detalles del conductor cada mes. Así que obtuvo una identificación para representar al beneficiario, tal como se describe Beneficiario o remitente reutilizando. El identificador del beneficiario es válido para un método de pago y los campos son obligatorios y todos coinciden con los campos que eran obligatorios cuando se creó el identificador. Sin embargo, los campos obligatorios de los métodos de pago pueden cambiar con el tiempo

El administrador de nóminas desea aumentar las probabilidades de que el pago se realice correctamente cada mes. Por lo tanto, antes de solicitar el pago mensual al conductor, el administrador valida los detalles del beneficiario según el método de pago utilizado

Veamos los aspectos más destacados de su flujo de trabajo.

validating-beneficiary.jpg
  1. En su sitio web, su administrador de nóminas le pide que validar a un beneficiario.

  2. El back-end del sitio web le pide a Rapyd que valide al beneficiario.

  3. Rapyd procesa la validación y envía el resultado al back-end del sitio web.

  4. Su administrador de nóminas recibe el resultado de la validación de su sitio web.

Requisito previo

Para ejecutar los ejemplos de este caso de uso, debe crear el siguiente ID en su propio sandbox:

Cuando el administrador de nóminas solicita la validación de la identificación del beneficiario del empleado, le pides a Rapyd que valide al beneficiario.

Para eso, utilizarás Validar al beneficiario con los siguientes parámetros:

Descripción de los parámetros corporales

Parámetro corporal

Descripción

beneficiario

Introduce el identificador del beneficiario que recibiste cuando creaste el beneficiario para el empleado en tu entorno limitado. Para los fines de esta lección de casos de uso, estamos usando beneficiary_a0345a157ccac51bf4d4a54b388c32ba, que es el identificador del beneficiario que creamos en nuestra zona de pruebas.

tipo_de_método de pago

Entrar ph_anzbank_bank como tipo de método de pago.

país del remitente

Entrar GB como código para el Reino Unido, el país del remitente.

divisa del remitente

Entrar PHP como código para los pesos filipinos, la moneda del remitente.

tipo_de_entidad_remitente

Entrar empresa como el tipo de entidad para el remitente.

cantidad

Entrar 10000 como la cantidad máxima de pago a validar para el empleado.

Validar la solicitud del beneficiario

Le pides a Rapyd que valide al beneficiario.

    • Solicitud

      • // Request URL: POST https://sandboxapi.rapyd.net/v1/payouts/beneficiary/validate
        
        // Message body:
        
        {
                "beneficiary": "beneficiary_a0345a157ccac51bf4d4a54b388c32ba",
                "payout_method_type": "ph_anzbank_bank",
                "sender_country": "GB",
                "sender_currency": "PHP",
                "sender_entity_type": "company",
                "amount": 10000
        }
    • .NET Core

      • using System;
        using System.Text.Json;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
        
                        var requestObj = new
                        {
                            beneficiary = "beneficiary_a0345a157ccac51bf4d4a54b388c32ba",
                            payout_method_type = "ph_anzbank_bank",
                            sender_country = "GB",
                            sender_currency = "PHP",
                            sender_entity_type = "company",
                            amount = 10000
                        };
        
                        string request = JsonSerializer.Serialize(requestObj);
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/payouts/beneficiary/validate", request);
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        async function main() {
          try {
            const body = {
              beneficiary: 'beneficiary_a0345a157ccac51bf4d4a54b388c32ba',
              payout_method_type: 'ph_anzbank_bank',
              sender_country: 'GB',
              sender_currency: 'PHP',
              sender_entity_type: 'company',
              amount: 10000
            };
            const result = await makeRequest('POST', '/v1/payouts/beneficiary/validate', body);
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
    • PHP

      • <?php
        
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        include($path);
        
        $body = [
            "beneficiary" => "beneficiary_a0345a157ccac51bf4d4a54b388c32ba",
            "payout_method_type" => "ph_anzbank_bank",
            "sender_country" => "GB",
            "sender_currency" => "PHP",
            "sender_entity_type" => "company",
            "amount" => 10000
        ];
        
        try {
            $object = make_request('post', '/v1/payouts/beneficiary/validate', $body);
            var_dump($object);
        } catch (Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Pitón

      • from pprint import pprint
        
        from utilities import make_request
        
        beneficiary_info = {
            "beneficiary": 'beneficiary_a0345a157ccac51bf4d4a54b388c32ba',
            "payout_method_type": "ph_anzbank_bank",
            "sender_country": "GB",
            "sender_currency": "PHP",
            "sender_entity_type": "company",
            "amount": 10000
        }
        
        results = make_request(method='post',
                               path='/v1/payouts/beneficiary/validate',
                               body=beneficiary_info)
        pprint(results)
Validar la respuesta del beneficiario

Echemos un vistazo a la respuesta.

    • Respuesta

      • {
            "status": {
                "error_code": "",
                "status": "SUCCESS",
                "message": "",
                "response_code": "",
                "operation_id": "63c81cc9-3a36-4907-aeb7-27b4316c6af9"
            },
            "data": {
                "validated": true,
                "beneficiary": {
                    "id": "beneficiary_a0345a157ccac51bf4d4a54b388c32ba",
                    "last_name": "Name",
                    "first_name": "Test",
                    "country": "PH",
                    "entity_type": "individual",
                    "name": "Test Name",
                    "phone_number": "632567000014",
                    "account_number": "006449956988",
                    "currency": "PHP",
                    "identification_type": "international passport",
                    "identification_value": "Z4703384",
                    "bank_name": "Test Name",
                    "category": "bank"
                }
            }
        }

El datos la sección de esta respuesta muestra:

  • El valor del validado el campo es verdadero, lo que significa que la identificación del beneficiario es válida con los parámetros especificados.

  • El beneficiario validado id es beneficiary_a0345a157ccac51bf4d4a54b388c32ba. Cuando ejecutes este ejemplo en tu propia zona de pruebas, obtendrás el ID que has introducido

  • Se muestran los campos del objeto «beneficiario» que representa el identificador.

Su sitio web puede mostrar los resultados de la validación a su administrador de nóminas.

¿Necesita información técnica más detallada?

¿Quieres ver los métodos y objetos de la API de Rapyd que utilizarás? Merchant API Reference para obtener más detalles técnicos.