Skip to main content

Documentación

Cancelar un desembolso

Detenga un desembolso a un trabajador o empresa antes de que se confirme. | Empresa

Rapyd facilita la cancelación de un desembolso una vez creado. El desembolso se puede cancelar a menos que el estado este en confirmado o completado.

La empresa de un cliente debe pagar 110 BGN (lev búlgaro) a la cuenta bancaria de un trabajador, pero la billetera de la empresa solo tiene USD (dólares estadounidenses). El propietario de la empresa crea un desembolso con un cambio de moneda automático. Sin embargo, solicitó un pago de 110 BGN por error, por lo que la empresa debe cancelar el desembolso. En su sitio web, la empresa le pide que cancele la solicitud de desembolso. El back-end de su sitio web le pide a Rapyd que procese la solicitud. Rapyd cancela el desembolso y le notifica que el desembolso se canceló.

canceling-a-payout.jpg
  1. El back-end del sitio web le pide a Rapyd que cancele el desembolso con el número de referencia de desembolso específico.

  2. Rapyd procesa la solicitud de cancelación del desembolso y devuelve la confirmación.

  3. El back-end del sitio web recibe la confirmación de la cancelación y se lo notifica al cliente.

En este ejemplo, desea cancelar un desembolso creado por John Doe. Solicita a Rapyd que cancele el desembolso.

Cancelar solicitud de desembolso

Usa el ID del desembolso en la solicitud para cancelar el desembolso.

    • Solicitud

      • // Request URL: DELETE https://sandboxapi.rapyd.net/v1/payouts/payout_d85447ab91a76ac24f4b779dec8281f4
        
        // Message body absent
    • .NET Core

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
        
                        string payout = "payout_d85447ab91a76ac24f4b779dec8281f4";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("DELETE", $"/v1/payouts/{payout}");
        
                        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 result = await makeRequest(
              'DELETE',
              '/v1/payouts/payout_d85447ab91a76ac24f4b779dec8281f4'
            );
            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);
        
        try {
            $object = make_request('delete', "/v1/payouts/payout_d85447ab91a76ac24f4b779dec8281f4");
            var_dump($object);
        } catch (Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        payout = 'payout_d85447ab91a76ac24f4b779dec8281f4'
        results = make_request(method='delete',
                               path=f'/v1/payouts/{payout}')
        pprint(results)
Cancelar respuesta de desembolso

Veamos la respuesta.

    • Respuesta

      • {
            "status": {
                "error_code": "",
                "status": "SUCCESS",
                "message": "",
                "response_code": "",
                "operation_id": "637221bb-f165-49e1-9253-0c8f2a105305"
            },
            "data": {
                "id": "payout_d85447ab91a76ac24f4b779dec8281f4",
                "payout_type": "bank",
                "payout_method_type": "bg_general_bank",
                "amount": 1100,
                "payout_currency": "BGN",
                "sender_amount": 628.40,
                "sender_currency": "USD",
                "status": "Canceled",
                "sender_country": "BG",
        
                  // ...
                  
                "fx_rate": 0.571276,
        
                  // ...
                  
                "ewallets": [
                    {
                        "ewallet_id": "ewallet_4f8009d08b7b41e5d3b356494101d83b",
                        "amount": 1100,
                        "percent": null
                    }
                ],
        
                  // ...
                  
                "merchant_reference_id": "GHY-0YU-HUJ-POI"
        
                  // ...
                  
            }
        }
        

El campo status en la sección data de esta respuesta muestra que el desembolso se canceló correctamente.

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

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