Retrieve Wallet
Retrieve the details of a Rapyd Wallet.
Note
This endpoint replaces the deprecated endpoint -
GET /v1/user/:walletRapyd no longer supports the deprecated endpoint.
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.
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_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": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "4293f7b3-4fbb-4425-b1e9-948cf88cd06f" }, "data": { "phone_number": "+17560705621", "email": null, "first_name": "Fred", "last_name": "Cooks", "id": "ewallet_df9de1b6310514f9c11a3f52dddd9ca4", "status": "ACT", "accounts": [ { "id": "4da1dfcd-2cce-11eb-9403-124eb1b705c1", "currency": "EUR", "alias": "EUR", "balance": 10, "received_balance": 0, "on_hold_balance": 0, "reserve_balance": 0, "limits": null, "limit": null } ], "verification_status": "not verified", "type": "person", "metadata": {}, "ewallet_reference_id": null, "category": null, "contacts": { "data": [ { "id": "cont_e21a199b8cfe5ac7c9b220fa9d4039bf", "first_name": "Fred", "last_name": "Cooks", "middle_name": "", "second_last_name": "", "gender": "not_applicable", "marital_status": "not_applicable", "house_type": "", "contact_type": "personal", "phone_number": "+17560705621", "email": "", "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_df9de1b6310514f9c11a3f52dddd9ca4", "created_at": 1606055013, "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_df9de1b6310514f9c11a3f52dddd9ca4/contacts" }, "parent_ewallet": null, "cnls_partner_query_reference": null } }
Retrieve Company Wallet
curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_b9cbf3f4691aab019efacc3e376548df' -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": "88005a53-1314-46fc-bae5-8eb5dc070f3f" }, "data": { "phone_number": null, "email": null, "first_name": "Four Star Professional Services", "last_name": "", "id": "ewallet_b9cbf3f4691aab019efacc3e376548df", "status": "ACT", "accounts": [ { "id": "644410b8-e721-43b2-8847-4764cc0e4a00", "currency": "EUR", "alias": "EUR", "balance": 900, "received_balance": 0, "on_hold_balance": 0, "reserve_balance": 0, "limits": null, "limit": null } ], "verification_status": "not verified", "type": "company", "metadata": {}, "ewallet_reference_id": null, "category": null, "contacts": { "data": [ { "id": "cont_232e04d58c8d9a0188ee649ceebe85c9", "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": "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": null, "address": { "id": "address_d809ebc52486d68f5d77b4b91979c466", "name": "John Doe", "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": 1753096440 }, "ewallet": "ewallet_b9cbf3f4691aab019efacc3e376548df", "created_at": 1753096440, "metadata": {}, "business_details": { "id": "busi_8a368f85fe2b3143d2a1dbbd3207bafe", "name": "Four Star Professional Services", "registration_number": "4234567779", "entity_type": "association", "industry_category": "company", "industry_sub_category": "home services", "address": { "id": "address_a0fda2f72ac2c55fa2eceae29519ac77", "name": "John Doe", "line_1": "1234 Main Street", "line_2": "Suite 1200", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "10101", "phone_number": "14155557779", "metadata": {}, "canton": "", "district": "", "created_at": 1753096440 }, "created_at": 1753096440, "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": "", "contact_reference_id": null } ], "has_more": false, "total_count": 1, "url": "/v1/ewallets/ewallet_b9cbf3f4691aab019efacc3e376548df/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" } }