Skip to main content

Documentación

Retrieve Wallet

Retrieve the details of a Rapyd Wallet.

Nota

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

    Rapyd no longer supports the deprecated endpoint.

  2. The code samples include successful requests (200), bad requests (400), and an unauthorized request (401). For all error messages that appear due to bad requests, see Wallet Errors, Wallet Contact Errors, and General Errors.

Parameters
Request Path Parameters

    • ewallet

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

Request Header Parameters
Response Parameters
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_31fb2dbbaf6519461ee4fbe1062220d3' \
-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": "7fb030bb-4734-4a23-a17a-145a4b4e1ce4"
    },
    "data": {
        "phone_number": null,
        "email": "jane.smith.162417@example.com",
        "first_name": "Jane",
        "last_name": "Smith",
        "id": "ewallet_31fb2dbbaf6519461ee4fbe1062220d3",
        "status": "ACT",
        "accounts": [
            {
                "id": "49b2c1db-dd26-444f-8667-5508ae901de5",
                "currency": "EUR",
                "alias": "EUR",
                "balance": 95,
                "received_balance": 0,
                "on_hold_balance": 6,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            },
            {
                "id": "d722c12f-e88f-47b8-a2a1-96606b0ee997",
                "currency": "HKD",
                "alias": "HKD",
                "balance": 130356.1,
                "received_balance": 0,
                "on_hold_balance": 0,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            }
        ],
        "verification_status": "not verified",
        "type": "person",
        "metadata": {
            "merchant_defined": true
        },
        "ewallet_reference_id": "erd-2025-08-10b",
        "category": null,
        "contacts": {
            "data": [
                {
                    "id": "cont_cfcecbbaf6bd086f7077a70f53b8e259",
                    "first_name": "Jane",
                    "last_name": "Smith",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "not_applicable",
                    "marital_status": "not_applicable",
                    "house_type": "",
                    "contact_type": "personal",
                    "phone_number": "+14155551235",
                    "email": "jane.smith.162417@example.com",
                    "identification_type": "",
                    "identification_number": "",
                    "issued_card_data": {
                        "preferred_name": "",
                        "transaction_permissions": "",
                        "role_in_company": ""
                    },
                    "date_of_birth": null,
                    "country": "US",
                    "nationality": null,
                    "address": null,
                    "ewallet": "ewallet_31fb2dbbaf6519461ee4fbe1062220d3",
                    "created_at": 1753881859,
                    "metadata": {},
                    "business_details": null,
                    "compliance_profile": 0,
                    "verification_status": "not verified",
                    "send_notifications": false,
                    "mothers_name": "",
                    "contact_reference_id": null
                }
            ],
            "has_more": false,
            "total_count": 1,
            "url": "/v1/ewallets/ewallet_31fb2dbbaf6519461ee4fbe1062220d3/contacts"
        },
        "parent_ewallet": "ewallet_b5320c566cc4aa01fe77440ad08693f7",
        "cnls_partner_query_reference": null
    }
}

  • Retrieve Company Wallet

  • curl -X get
'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_053d64c44834e1d3057ecb68a34c6b6c' \
-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": "b5ddff12-b415-47b9-b612-93f86695d4d7"
    },
    "data": {
        "phone_number": "+14155551234",
        "email": "johndoe12162020@rapyd.net",
        "first_name": "Four Star Professional Services",
        "last_name": null,
        "id": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
        "status": "ACT",
        "accounts": [
            {
                "id": "df9abb16-5676-11eb-9403-124eb1b705c1",
                "currency": "USD",
                "alias": "USD",
                "balance": 832.44,
                "received_balance": 0,
                "on_hold_balance": 0,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            },
            {
                "id": "f50244a0-b3b6-11eb-9403-124eb1b705c1",
                "currency": "MXN",
                "alias": "MXN",
                "balance": 5000,
                "received_balance": 0,
                "on_hold_balance": 0,
                "reserve_balance": 0,
                "limits": null,
                "limit": null
            }
        ],
        "verification_status": "not verified",
        "type": "company",
        "metadata": {
            "merchant_defined": "updated"
        },
        "ewallet_reference_id": "4-star-pro-12162023",
        "category": null,
        "contacts": {
            "data": [
                {
                    "id": "cont_3625cb4fc18d005b12f9ccf0c466755e",
                    "first_name": "John",
                    "last_name": "Doe",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "not_applicable",
                    "marital_status": "not_applicable",
                    "house_type": "",
                    "contact_type": "business",
                    "phone_number": "+14155551234",
                    "email": "johndoefourstar@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": "NL",
                    "address": {
                        "id": "address_9706af91b503c70a819605222afabc96",
                        "name": "John Doe - Four Star Professional Services",
                        "line_1": "123 Main Street",
                        "line_2": "",
                        "line_3": "",
                        "city": "Anytown",
                        "state": "NY",
                        "country": "US",
                        "zip": "12345",
                        "phone_number": "+14155551234",
                        "metadata": {},
                        "canton": "",
                        "district": "",
                        "created_at": 1608023967
                    },
                    "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
                    "created_at": 1608023967,
                    "metadata": {
                        "merchant_defined": "updated"
                    },
                    "business_details": {
                        "id": "busi_9d2952408ec5dec780f5b88a8fc174aa",
                        "name": "Four Star Professional Services",
                        "registration_number": "R24032020000",
                        "entity_type": "company",
                        "industry_category": "company",
                        "industry_sub_category": "home services",
                        "address": {
                            "id": "address_977b39b4b725fadc9040e1ee1e5df795",
                            "name": "John Doe - Four Star Professional Services",
                            "line_1": "1234 Main Street",
                            "line_2": "Suite 1200",
                            "line_3": "",
                            "city": "Anytown",
                            "state": "NY",
                            "country": "US",
                            "zip": "10101",
                            "phone_number": "14155557779",
                            "metadata": {
                                "merchant_defined": true
                            },
                            "canton": "",
                            "district": "",
                            "created_at": 1608023967
                        },
                        "created_at": 1608023967,
                        "annual_revenue": 0,
                        "establishment_date": null,
                        "legal_entity_type": null,
                        "cnae_code": null,
                        "statement_descriptor": null,
                        "mcc": null,
                        "website_url": null,
                        "customer_service_phone_number": null
                    },
                    "compliance_profile": 0,
                    "verification_status": "not verified",
                    "send_notifications": false,
                    "mothers_name": "Jane Smith",
                    "contact_reference_id": "johndoe20251009"
                },
                {
                    "id": "cont_e7bf3f15100c37b2d5628cbacb762c22",
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "female",
                    "marital_status": "single",
                    "house_type": "lease",
                    "contact_type": "personal",
                    "phone_number": "+14155551233",
                    "email": "jane200@rapyd.net",
                    "identification_type": "PA",
                    "identification_number": "1233242424",
                    "issued_card_data": {
                        "preferred_name": "",
                        "transaction_permissions": "",
                        "role_in_company": ""
                    },
                    "date_of_birth": "2000-11-22",
                    "country": "US",
                    "nationality": "FR",
                    "address": {
                        "id": "address_ba682dc8bd98a4ed3ded711c7c42d099",
                        "name": "Jane Doe",
                        "line_1": "123 Lake Forest Drive",
                        "line_2": "",
                        "line_3": "",
                        "city": "Anytown",
                        "state": "NY",
                        "country": "",
                        "zip": "12345",
                        "phone_number": "+14155551234",
                        "metadata": {
                            "merchant_defined": true
                        },
                        "canton": "",
                        "district": "",
                        "created_at": 1623313045
                    },
                    "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
                    "created_at": 1623313045,
                    "metadata": {
                        "merchant_defined": true
                    },
                    "business_details": null,
                    "compliance_profile": 0,
                    "verification_status": "not verified",
                    "send_notifications": false,
                    "mothers_name": "Jane Smith",
                    "contact_reference_id": null
                },
                {
                    "id": "cont_f2b7f98b019af17df892dcc92abc3cc2",
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "female",
                    "marital_status": "single",
                    "house_type": "lease",
                    "contact_type": "personal",
                    "phone_number": "+14155551237",
                    "email": "jane200@rapyd.net",
                    "identification_type": "PA",
                    "identification_number": "1233242424",
                    "issued_card_data": {
                        "preferred_name": "",
                        "transaction_permissions": "",
                        "role_in_company": ""
                    },
                    "date_of_birth": "2000-11-22",
                    "country": "US",
                    "nationality": "FR",
                    "address": {
                        "id": "address_a81d37a3c2b3c8d3f894bf68aa314fd6",
                        "name": "Jane Doe",
                        "line_1": "123 Lake Forest Drive",
                        "line_2": "",
                        "line_3": "",
                        "city": "Anytown",
                        "state": "NY",
                        "country": "",
                        "zip": "12345",
                        "phone_number": "+14155551234",
                        "metadata": {
                            "merchant_defined": true
                        },
                        "canton": "",
                        "district": "",
                        "created_at": 1608036236
                    },
                    "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
                    "created_at": 1608036236,
                    "metadata": {
                        "merchant_defined": "updated"
                    },
                    "business_details": null,
                    "compliance_profile": 0,
                    "verification_status": "not verified",
                    "send_notifications": false,
                    "mothers_name": "Joan Smyth",
                    "contact_reference_id": null
                }
            ],
            "has_more": false,
            "total_count": 3,
            "url": "/v1/ewallets/ewallet_053d64c44834e1d3057ecb68a34c6b6c/contacts"
        },
        "parent_ewallet": null,
        "cnls_partner_query_reference": null
    }
}

  • Bad Request - Wallet Not Found

  • curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_7a05ee6cb11a889e84703e4bd05677ee' \
-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": "ERROR_GET_USER",
        "status": "ERROR",
        "message": "The request attempted an operation that requires a wallet, but the wallet was not found. The request was rejected. Corrective action: Use the ID of a valid wallet that has not been deleted. The ID is a string starting with 'ewallet_'.",
        "response_code": "ERROR_GET_USER",
        "operation_id": "6199470a-1603-4ba1-b8d5-d856d5a9eb3a"
    }
}

  • Unauthorized

  • curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_df9de1b6310514f9c11a3f52dddd9ca4' \
-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": "UNAUTHENTICATED_API_CALL",
        "status": "ERROR",
        "message": "The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.",
        "response_code": "UNAUTHENTICATED_API_CALL",
        "operation_id": "16dadb09-2343-422b-bcd4-4fb58b04c6d2"
    }
}
En esta sección:

The number of seconds elapsed since the beginning of the Unix epoch, which was 00:00:00 GMT on January 1, 1970. 10-digit integer.