Create Wallet
Create a Rapyd Wallet.
The following types of wallet are supported:
Person - Requires one personal contact.
Company - Requires one business contact. You can add personal contacts as required. See Add Contact to Wallet.
Client - Requires one business contact. Created by Rapyd Client Support.
Note
For best practices, include the
first_name,last_name,date_of_birth,country,address.nameandaddress.line_1fields in thecontactobject. These fields are required for other operations.This endpoint replaces the deprecated endpoint -
POST /v1/userRapyd will continue to support the deprecated endpoint until December 31, 2024.
contact
Describes details about the wallet contacts. Array of objects. For details about the fields in the 'contact' object, see Add Contact to Wallet.
ewallet_reference_id
Rapyd Wallet ID defined by the customer or end user. Must be unique.
first_name
First name of the Rapyd Wallet owner. For a person wallet type, alphabetic characters and spaces.
last_name
Family name of the Rapyd Wallet owner. For a person wallet type, alphabetic characters and spaces.
type
Type of wallet:
company - Indicates a business wallet.
person - Indicates the wallet of an individual consumer.
Note
To create additional wallets of the client type for a Rapyd client, contact Client Support.
person
Code Samples
.NET
using System; using System.Text.Json; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { var address = new { name = "John Doe", line_1 = "123 Main Street", line_2 = "", line_3 = "", city = "Anytown", state = "NY", country = "US", zip = "12345", metadata = new { }, canton = "", district = "" }; var metadata = new { merchant_defined = true }; var contact = new { email = "johndoe@rapyd.net", first_name = "John", last_name = "Doe", mothers_name = "Jane Smith", contact_type = "personal", address, identification_type = "PA", identification_number = "1234567890", date_of_birth = "11/22/2000", country = "US", metadata, }; var requestObj = new { first_name = "John", last_name = "Doe", email = "", ewallet_reference_id = "John-Doe-02152020", metadata, phone_number = "", type = "person", contact, country = "US", }; string request = JsonSerializer.Serialize(requestObj); string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/user", 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 = { first_name: 'John', last_name: 'Doe', ewallet_reference_id: 'John-Doe-02152020', metadata: { merchant_defined: true }, type: 'company', contact: { phone_number: '+14155551234', email: 'johndoe@rapyd.net', first_name: 'John', last_name: 'Doe', mothers_name: 'Jane Smith', contact_type: 'business', address: { name: 'John Doe', line_1: '123 Main Street', line_2: '', line_3: '', city: 'Anytown', state: 'NY', country: 'US', zip: '12345', phone_number: '+14155551234', metadata: { number: 2 }, canton: '', district: '' }, identification_type: 'PA', identification_number: '1234567890', date_of_birth: '11/22/2000', country: 'US', metadata: { merchant_defined: true }, business_details: { entity_type: 'association', name: 'Four Star Professional Services', registration_number: '4234567779', industry_category: 'company', industry_sub_category: 'home services', address: { 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: { merchant_defined: true } } } } }; const result = await makeRequest('POST', '/v1/user', 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 = [ 'first_name' => 'John', 'last_name' => 'Doe', 'email' => '', 'ewallet_reference_id' => 'John-Doe-02152020', 'metadata' => [ 'merchant_defined' => true ], 'phone_number' => '', 'type' => 'person', 'contact' => [ 'phone_number' => '+14155551234', 'email' => 'johndoe@rapyd.net', 'first_name' => 'John', 'last_name' => 'Doe', 'mothers_name' => 'Jane Smith', 'contact_type' => 'personal', 'address' => [ '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' => '', ], 'identification_type' => 'PA', 'identification_number' => '1234567890', 'date_of_birth' => '11/22/2000', 'country' => 'US', 'metadata' => [ 'merchant_defined' => true ], ], ]; try { $object = make_request('post', '/v1/user', $body); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?>
Python
from pprint import pprint from utilities import make_request # Creating personal wallet personal_wallet = { "first_name": "John", "last_name": "Doe", "email": "", "ewallet_reference_id": "John-Doe-02152020", "metadata": { "merchant_defined": True }, "phone_number": "", "type": "person", "contact": { "phone_number": "+14155551234", "email": "johndoe1@rapyd.net", "first_name": "John", "last_name": "Doe", "mothers_name": "Jane Smith", "contact_type": "personal", "address": { "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": "" }, "identification_type": "PA", "identification_number": "1234567890", "date_of_birth": "11/22/2000", "country": "US", "metadata": { "merchant_defined": True } } } personal_wallet_results = make_request(method='post', path='/v1/user', body=personal_wallet) pprint(personal_wallet_results) # Creating company ewallet company_wallet = { "first_name": "Four Star Professional Services", "last_name": "", "ewallet_reference_id": "e-77641", "metadata": { "merchant_defined": True }, "type": "company", "contact": { "phone_number": "+14155551234", "email": "johndoe1@rapyd.net", "first_name": "John", "last_name": "Doe", "contact_type": "business", "address": { "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": "" }, "identification_type": "PA", "identification_number": "1234567890", "date_of_birth": "11/22/2000", "country": "US", "metadata": { "merchant_defined": True }, "business_details": { "entity_type": "association", "name": "Four Star Professional Services", "registration_number": "4234567779", "industry_category": "company", "industry_sub_category": "home services", "address": { "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": { "merchant_defined": True } } } } } company_wallet_results = make_request(method='post', path='/v1/user', body=company_wallet) pprint(company_wallet_results)
/v1/ewallets
Person Wallet
curl -X post https://sandboxapi.rapyd.net/v1/ewallets -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 '{ "first_name": "John", "last_name": "Doe", "ewallet_reference_id": "2023-01-29b", "metadata": {}, "type": "person", "contact": { "phone_number": "+3547826575", "email": "johndoe@rapyd.net", "first_name": "John", "last_name": "Doe", "mothers_name": "Jane Smith", "contact_type": "personal", "address": { "name": "John Doe", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "12345", "phone_number": "+14155551611", "metadata": {}, "canton": "", "district": "" }, "identification_type": "DL", "identification_number": "1234567890", "date_of_birth": "11/22/2000", "country": "IS", "nationality": "IS", "metadata": { "merchant_defined": true } } }'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "2322ef1e-2181-4981-8bd3-df329c240785" }, "data": { "phone_number": null, "email": null, "first_name": "John", "last_name": "Doe", "id": "ewallet_1d0a9c24781aeccca21f9e640d020d28", "status": "ACT", "accounts": [], "verification_status": "not verified", "type": "person", "metadata": { "merchant_defined": true }, "ewallet_reference_id": "2021-10-28d", "category": null, "contacts": { "data": [ { "id": "cont_7883d252a75f525ae28d74d6c1da7167", "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": "+14155551234", "email": "johndoe@rapyd.net", "identification_type": "DL", "identification_number": "1234567890", "issued_card_data": { "preferred_name": "", "transaction_permissions": "", "role_in_company": "" }, "date_of_birth": "2000-11-22", "country": "US", "nationality": "US", "address": { "id": "address_a1cd1ab9cd3cb7395152ef9e7ceed05f", "name": "John Doe", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "12345", "phone_number": "+14155551611", "metadata": {}, "canton": "", "district": "", "created_at": 1635423334 }, "ewallet": "ewallet_1d0a9c24781aeccca21f9e640d020d28", "created_at": 1635423334, "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_1d0a9c24781aeccca21f9e640d020d28/contacts" } } }
Company Wallet
curl -X post https://sandboxapi.rapyd.net/v1/ewallets -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 '{ "first_name": "Four Star Professional Services", "last_name": "", "ewallet_reference_id": "e-0619", "metadata": { "merchant_defined": true }, "type": "company", "contact": { "phone_number": "+14155551234", "email": "johndoe@rapyd.net", "first_name": "John", "last_name": "Doe", "contact_type": "business", "address": { "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": "" }, "identification_type": "PA", "identification_number": "1234567890", "date_of_birth": "11/22/2000", "country": "US", "metadata": { "merchant_defined": true }, "business_details": { "entity_type": "association", "name": "Four Star Professional Services", "registration_number": "4234567779", "industry_category": "company", "industry_sub_category": "home services", "address": { "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": { "merchant_defined": true } } } } }'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "28671f60-49c4-4989-a1ab-0b89dbf1e002" }, "data": { "phone_number": null, "email": null, "first_name": "Four Star Professional Services", "last_name": "", "id": "ewallet_16f5b11d7cd37c0ebb9242699d1db61d", "status": "ACT", "accounts": [], "verification_status": "not verified", "type": "company", "metadata": { "merchant_defined": true }, "ewallet_reference_id": "e-0619", "category": null, "contacts": { "data": [ { "id": "cont_de961371a321e0ed782c521e41def4e0", "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_f39ec1393ddd85022c9cd430b996f59c", "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": 1687158709 }, "ewallet": "ewallet_16f5b11d7cd37c0ebb9242699d1db61d", "created_at": 1687158709, "metadata": { "merchant_defined": true }, "business_details": { "id": "busi_d49d261b771642ecf7209d8401f741b6", "name": "Four Star Professional Services", "registration_number": "4234567779", "entity_type": "association", "industry_category": "company", "industry_sub_category": "home services", "address": { "id": "address_5b6d9f0148e34ba084d158fe88af05ea", "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": { "merchant_defined": true }, "canton": "", "district": "", "created_at": 1687158709 }, "created_at": 1687158709, "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_16f5b11d7cd37c0ebb9242699d1db61d/contacts" }, "wallet_operational_currency": null } }{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "e3269410-8312-4907-b998-9260adf5091c" }, "data": { "phone_number": null, "email": null, "first_name": "Four Star Professional Services", "last_name": "", "id": "ewallet_2e3c6e5be63ed17a115e6ee66f825a37", "status": "ACT", "accounts": [], "verification_status": "not verified", "type": "company", "metadata": { "merchant_defined": true }, "ewallet_reference_id": "2021-10-28c", "category": null, "contacts": { "data": [ { "id": "cont_08adc02f6916282d389910348d285373", "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": "", "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_2e3c6e5be63ed17a115e6ee66f825a37", "created_at": 1635422882, "metadata": {}, "business_details": { "id": "busi_c80f3dae4ceb059a3c3c338cbfd057bc", "name": "", "registration_number": "", "entity_type": "n/a", "industry_category": "n/a", "industry_sub_category": "n/a", "address": null, "created_at": 1635422882, "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_2e3c6e5be63ed17a115e6ee66f825a37/contacts" } } }
Create Wallet with Contact Reference ID
curl -X post https://sandboxapi.rapyd.net/v1/ewallets -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 '{ "first_name": "John", "last_name": "Doe", "ewallet_reference_id": "2023-01-29b1", "metadata": {}, "type": "person", "contact": { "contact_reference_id": "johndoe2023", "phone_number": "+3547826575", "email": "johndoe@rapyd.net", "first_name": "John", "last_name": "Doe", "mothers_name": "Jane Smith", "contact_type": "personal", "address": { "name": "John Doe", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "12345", "phone_number": "+14155551611", "metadata": {}, "canton": "", "district": "" }, "identification_type": "DL", "identification_number": "1234567890", "date_of_birth": "11/22/2000", "country": "IS", "nationality": "IS", "metadata": { "merchant_defined": true } } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "e36924c2-91cf-4a42-ad78-c23e3ad7f1f6" }, "data": { "id": "cont_88e387ef31488c0f4b385d157a27425a", "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": "+3547826575", "email": "johndoe@rapyd.net", "identification_type": "DL", "identification_number": "1234567890", "issued_card_data": { "preferred_name": "", "transaction_permissions": "", "role_in_company": "" }, "date_of_birth": "2000-11-22", "country": "IS", "nationality": "IS", "address": { "id": "address_b6d52e34fffce3c20d6000dd6faea3a2", "name": "John Doe", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "12345", "phone_number": "+14155551611", "metadata": {}, "canton": "", "district": "", "created_at": 1694069068 }, "ewallet": "ewallet_ca8e764afff51baa58eb47a52da6b5b0", "created_at": 1694069068, "metadata": { "merchant_defined": true }, "business_details": null, "compliance_profile": 0, "verification_status": "not verified", "send_notifications": false, "mothers_name": "Jane Smith", "contact_reference_id": "johndoe2023" } }