Skip to main content

Documentation

Retrieve Wallet

Retrieve the details of a Rapyd Wallet.

Note

This endpoint replaces the deprecated endpoint - GET /v1/user/:wallet

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

    • ewallet

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

Code Samples
    • .NET

      • using System;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        string wallet = "ewallet_9e2ad940e7b24e78701021cdc7d91fa4";
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/user/{wallet}");
        
                        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('GET', '/v1/user/ewallet_9e2ad940e7b24e78701021cdc7d91fa4');
        
            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('get', '/v1/user/ewallet_9e2ad940e7b24e78701021cdc7d91fa4');
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        wallet = 'ewallet_9e2ad940e7b24e78701021cdc7d91fa4'
        results = make_request(method='get', path=f'/v1/user/{wallet}')
        
        pprint(results)
  • /v1/ewallets/:ewallet

  • Retrieve Person Wallet

  • curl -X get
    https://sandboxapi.rapyd.net/v1/ewallets/ewallet_95feaa629caa5ef64c49e5c24b29171d
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "25fe6971-2353-4a81-9394-e6888615078b"
        },
        "data": {
            "phone_number": null,
            "email": null,
            "first_name": "John",
            "last_name": "Doe",
            "id": "ewallet_95feaa629caa5ef64c49e5c24b29171d",
            "status": "ACT",
            "accounts": [],
            "verification_status": "not verified",
            "type": "person",
            "metadata": {
                "merchant_defined": true
            },
            "ewallet_reference_id": "John-Doe-09052021",
            "category": null,
            "contacts": {
                "data": [
                    {
                        "id": "cont_c5445f7fb0e77e294f2e862480b4a8ee",
                        "first_name": "John",
                        "last_name": "Doe",
                        "middle_name": "",
                        "second_last_name": "",
                        "gender": "not_applicable",
                        "marital_status": "not_applicable",
                        "house_type": "",
                        "contact_type": "personal",
                        "phone_number": "+14155551311",
                        "email": "johndoe@rapyd.net",
                        "identification_type": "PA",
                        "identification_number": "1234567890",
                        "issued_card_data": {
                            "preferred_name": "",
                            "transaction_permissions": "",
                            "role_in_company": ""
                        },
                        "date_of_birth": "2000-11-22",
                        "country": "US",
                        "nationality": "FR",
                        "address": {
                            "id": "address_ec9e2e86fdbc61c02a599febdde56c60",
                            "name": "John Doe",
                            "line_1": "123 Main Street",
                            "line_2": "",
                            "line_3": "",
                            "city": "Anytown",
                            "state": "NY",
                            "country": "US",
                            "zip": "12345",
                            "phone_number": "+14155551111",
                            "metadata": {},
                            "canton": "",
                            "district": "",
                            "created_at": 1625579736
                        },
                        "ewallet": "ewallet_95feaa629caa5ef64c49e5c24b29171d",
                        "created_at": 1625579736,
                        "metadata": {
                            "merchant_defined": true
                        },
                        "business_details": null,
                        "compliance_profile": 0,
                        "verification_status": "not verified",
                        "send_notifications": false,
                        "mothers_name": "Jane Smith"
                    }
                ],
                "has_more": false,
                "total_count": 1,
                "url": "/v1/ewallets/ewallet_95feaa629caa5ef64c49e5c24b29171d/contacts"
            },
            "parent_ewallet": null
        }
    }
  • Retrieve Company Wallet

  • curl -X get
    https://sandboxapi.rapyd.net/v1/ewallets/ewallet_8d2d52f431a4d3d9d49aab3df94a2adf
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "1bde12ca-9ccb-459b-8568-20d58f4e03db"
        },
        "data": {
            "phone_number": "+14155557778",
            "email": "fourstar1@rapyd.net",
            "first_name": "Four Star Professional Services",
            "last_name": "",
            "id": "ewallet_8d2d52f431a4d3d9d49aab3df94a2adf",
            "status": "ACT",
            "accounts": [],
            "verification_status": "not verified",
            "type": "company",
            "metadata": {
                "merchant_defined": true
            },
            "ewallet_reference_id": "b-77781",
            "category": null,
            "contacts": {
                "data": [
                    {
                        "id": "cont_da2731fec587e0b394c0b32cd40601ff",
                        "first_name": "Four Star Professional Services",
                        "last_name": "",
                        "middle_name": "",
                        "second_last_name": "",
                        "gender": "not_applicable",
                        "marital_status": "not_applicable",
                        "house_type": "",
                        "contact_type": "business",
                        "phone_number": "+14155557778",
                        "email": "fourstar1@rapyd.net",
                        "identification_type": "",
                        "identification_number": "",
                        "issued_card_data": {
                            "preferred_name": "",
                            "transaction_permissions": "",
                            "role_in_company": ""
                        },
                        "date_of_birth": null,
                        "country": "",
                        "nationality": null,
                        "address": null,
                        "ewallet": "ewallet_8d2d52f431a4d3d9d49aab3df94a2adf",
                        "created_at": 1625580421,
                        "metadata": {},
                        "business_details": {
                            "id": "busi_5095e339ba3da25c247c0ce254d14183",
                            "name": "",
                            "registration_number": "",
                            "entity_type": "n/a",
                            "industry_category": "n/a",
                            "industry_sub_category": "n/a",
                            "address": null,
                            "created_at": 1625580421,
                            "annual_revenue": 0,
                            "establishment_date": null,
                            "legal_entity_type": null,
                            "cnae_code": null
                        },
                        "compliance_profile": 0,
                        "verification_status": "not verified",
                        "send_notifications": false,
                        "mothers_name": ""
                    }
                ],
                "has_more": false,
                "total_count": 1,
                "url": "/v1/ewallets/ewallet_8d2d52f431a4d3d9d49aab3df94a2adf/contacts"
            },
            "parent_ewallet": null
        }
    }