List Wallets
Retrieve a list of Rapyd Wallets.
You can filter the list with query parameters.
Note
This endpoint replaces the deprecated endpoint -
GET /v1/user/walletsRapyd 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.
currency
Filters the list for wallets with an account in the specified currency. Three-letter ISO 4217 code for the currency.
ewallet_reference_id
Wallet ID defined by the customer or end user. Must be unique.
min_balance
Filters the list for wallets with an account in the defined
currency, with an available balance of at least the specified value. If this parameter is set,currencyis required.
page_number
Page number to retrieve. If
page_numberis not specified, page 1 is retrieved.
page_size
Number of results per page.
type
Type of wallet:
company
person
client
/v1/ewallets
List Wallets
curl -X get https://sandboxapi.rapyd.net/v1/ewallets -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": "60d408ac-b407-4903-865c-06f94535b895" }, "data": [ { "phone_number": "+13716784041", "email": null, "first_name": "Mark", "last_name": "Holinder", "id": "ewallet_d496b5377c6c6c1d8c0c9ba3fec1d073", "status": "ACT", "accounts": [ { "id": "4d7bda43-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, "parent_ewallet": null, "cnls_partner_query_reference": null }, { "phone_number": "+4966761301819", "email": null, "first_name": "Terry", "last_name": "Cooper", "id": "ewallet_26a33b99ebba47f673dcbdf18889ac46", "status": "ACT", "accounts": [ { "id": "4d63fde4-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, "parent_ewallet": null, "cnls_partner_query_reference": null } ] }
List Wallets by Type
curl -X get https://sandboxapi.rapyd.net/v1/ewallets?type=company -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": "045c1812-890f-4abf-921c-b32fad81754c" }, "data": [ { "phone_number": "+14155557778", "email": "fourstar@rapyd.net", "first_name": "Four Star Professional Services", "last_name": "", "id": "ewallet_81f51b74736793aa47440f0e575abd12", "status": "ACT", "accounts": [ { "id": "dba1796e-2d84-11eb-9403-124eb1b705c1", "currency": "USD", "alias": "USD", "balance": 104, "received_balance": 0, "on_hold_balance": 0, "reserve_balance": 0, "limits": null, "limit": null } ], "verification_status": "not verified", "type": "company", "metadata": { "merchant_defined": true }, "ewallet_reference_id": "b-77781", "category": null, "parent_ewallet": null, "cnls_partner_query_reference": null } ] }
List Wallets by Wallet Reference ID
curl -X get https://sandboxapi.rapyd.net/v1/ewallets?ewallet_reference_id=e-8968 -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": "bd9506f0-d3cc-4c16-a316-eb54121b38a9" }, "data": [ { "phone_number": null, "email": null, "first_name": "John", "last_name": "Doe", "id": "ewallet_755b0fd11fd22b33328fff7d30f3ce30", "status": "ACT", "accounts": [ { "id": "c4e104df-2cdc-11eb-9403-124eb1b705c1", "currency": "USD", "alias": "USD", "balance": 11549.95, "received_balance": 0, "on_hold_balance": 0, "reserve_balance": 0, "limits": null, "limit": null }, { "id": "f1bd62dc-33b1-11eb-9403-124eb1b705c1", "currency": "PHP", "alias": "PHP", "balance": 1992, "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": "e-8968", "category": null, "parent_ewallet": null, "cnls_partner_query_reference": null } ] }
List Wallets by Associated Parent Wallet
curl -X get https://sandboxapi.rapyd.net/v1/ewallets?parent_ewallet=ewallet_f19ba97d670c6e32de6207841eae4dbd -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": "4be8b7a3-4c23-4035-94f1-f3132f54f90f" }, "data": [ { "phone_number": "+15555555555", "email": "jdoe@rapyd.net", "first_name": "John", "last_name": "Doe", "id": "ewallet_1abbd3dd4bb2aeadc2b1649e9355633f", "status": "ACT", "accounts": [ { "id": "b7dd0395-008a-4bff-b39f-48584f4583de", "currency": "USD", "alias": "USD", "balance": 104, "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": "jdoe-5785", "category": null, "parent_ewallet": "ewallet_f19ba97d670c6e32de6207841eae4dbd", "cnls_partner_query_reference": null } ] }
List Wallets by Currency Balance
curl -X get https://sandboxapi.rapyd.net/v1/ewallets?min_balance=10¤cy=HKD -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": "5af028bb-bcdb-4803-9147-68a868afacd3" }, "data": [ { "phone_number": +5555555555, "email": null, "first_name": "John", "last_name": "Doe", "id": "ewallet_506f1aab37a22d72ddb2872d8da6f9ab", "status": "ACT", "accounts": [ { "id": "fd7c8e11-4b5c-4145-ac4b-bc8963f675df", "currency": "HKD", "alias": "HKD", "balance": 9999993, "received_balance": 0, "on_hold_balance": 0, "reserve_balance": 0, "limits": null, "limit": null }, { "id": "93c18a2d-81ca-4899-bfed-4df8f5fa7d6c", "currency": "USD", "alias": "USD", "balance": 1004, "received_balance": 2.42, "on_hold_balance": 0, "reserve_balance": 0, "limits": [ { "type": "max_balance_limit", "amount": 5000, "currency": "USD", "updated_at": 1694525641 } ], "limit": null }, "verification_status": "not verified", "type": "person", "metadata": { "merchant_defined": true }, "ewallet_reference_id": "2023-04-11-24on", "category": null, "parent_ewallet": null, "cnls_partner_query_reference": null } ] }
Bad Request - Invalid Currency
curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets?currency=XYZ' \ -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": "INVALID_FIELDS - [CURRENCY]", "status": "ERROR", "message": "The request attempted an operation, but one or more of the fields did not have a valid value. The request was rejected. Corrective action: Use valid values. The names of the affected fields appear at the end of the error code. See the API Reference for details.", "response_code": "INVALID_FIELDS - [CURRENCY]", "operation_id": "f31044d1-fb5e-4504-a899-402cc5245999" } }
Bad Request - Invalid Type
curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets?type=business' \ -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_INVALID_EWALLET_TYPE", "status": "ERROR", "message": "The request attempted an operation that requires the 'type' parameter, but the 'type' was not a recognized value. The request was rejected. Corrective action: Set 'type' to one of the following values: 'person', 'company', 'client'.", "response_code": "ERROR_INVALID_EWALLET_TYPE", "operation_id": "f597cd93-2682-458a-809a-418f6b61c7ea" } }
Unauthorized
curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets' \ -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": "e711988e-77f7-49db-9817-ba13d51aa6b3" } }