Skip to main content

Documentation

Disable Wallet

Note

This endpoint is deprecated. See Change Wallet Status.

Rapyd will continue to support the deprecated endpoint until December 31, 2024.

Block the Rapyd Wallet.

This action prevents the following actions:

  • Moving money into or out of the wallet.

  • Issuing a bank account number or card to the wallet.

Use this method when the customer requests it, or while you conduct an investigation. Undo the process with Enable Wallet.

This method changes the status of the wallet to DIS (disabled) and triggers the Wallet Disabled Webhook.

    • ewallet

    • ID of the Rapyd Wallet. String starting with ewallet_.

      Required when phone number is not used.

    • phone_number

    • Phone number of the Rapyd Wallet in E.164 format.

      Required when ewallet field is not used. Deprecated.

Code Samples
    • .NET

      • using System;
        using System.Text.Json;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        var requestObj = new
                        {
                            ewallet = "ewallet_dd5a3dadd807259b07c7f41c55bce612",
                        };
        
                        string request = JsonSerializer.Serialize(requestObj);
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("PUT", "/v1/user/disable", 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 = {
              ewallet: 'ewallet_dd5a3dadd807259b07c7f41c55bce612'
            };
            const result = await makeRequest('PUT', '/v1/user/disable', 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 = [
            'ewallet' => 'ewallet_dd5a3dadd807259b07c7f41c55bce612'
          ];
        
        try {
            $object = make_request('put', '/v1/user/disable', $body);
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        wallet_id = 'ewallet_dd5a3dadd807259b07c7f41c55bce612'
        body = {'ewallet': wallet_id}
        disable_results = make_request(method='put', path=f'/v1/user/disable', body=body)
        
        pprint(disable_results)
  • /v1/user/disable

  • Disable Wallet

  • curl -X put
    https://sandboxapi.rapyd.net/v1/user/disable
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '{
        "ewallet": "ewallet_dd5a3dadd807259b07c7f41c55bce612"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "01e8e1bc-5690-4b6e-9854-8033bbf49e83"
        }
    }