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.
See also Creating a Wallet.
Parent Wallet
The optional parent_ewallet parameter associates a person wallet with a company wallet.
Implementing a parent wallet enhances the onboarding process and helps fulfill compliance regulations.
Single parent: A person wallet can have only one parent wallet.
Default parent wallet: When a request does not specify a parent wallet, the client wallet is automatically assigned as the parent wallet.
Parent wallet type: You can only assign a company wallet as a parent wallet. A person wallet cannot be a parent wallet.
Rapyd Wallet for Partners - Prerequisite
As a partner, before creating a wallet for a sub-merchant, you must first complete a Card Network Lookup Service (CNLS) query. The partner_query_reference value from the Retrieve Query Results CNLS response must be used as the cnls_partner_query_reference in the Create Wallet request body.
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.For information on the wallet and the wallet contact in an account funding transaction (AFT), see Creating an AFT Payment.
This endpoint replaces the deprecated endpoint -
POST /v1/userRapyd no longer supports the deprecated endpoint.
cnls_partner_query_reference
Rapyd Partner only. Required when a partner creates a Rapyd partner wallet for a merchant. Value of the
partner_query_referenceparameter used as the query request ID in the Card Network Lookup Service (CNLS). See Retrieve Query Results. You must run the CNLS before creating a wallet for a merchant. If thecnls_partner_query_referenceandpartner_query_referencevalues do not match, ERROR_CREATE_WALLET_CNLS_PARTNER_QUERY_REFERENCE_MISMATCH is returned.
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
/v1/ewallets
Company Wallet - Rapyd Partner
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", "cnls_partner_query_reference": "abcd1234", "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": "2000-11-22", "country": "US", "metadata": { "merchant_defined": true }, "business_details": { "statement_descriptor": "Four Star Professional Services", "website_url": "https://fourstarprofessionalservices.com", "mcc": "5812", "customer_service_phone_number": "+14155555555", "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, "statement_descriptor": "Four Star Professional Services", "mcc": "5812", "website_url": "https://fourstarprofessionalservices.com", "customer_service_phone_number": "+14155555555" }, "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_16f5b11d7cd37c0ebb9242699d1db61d/contacts" }, "parent_ewallet": null, "cnls_partner_query_reference": "abcd1234" } }
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": "2000-11-22", "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, "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_16f5b11d7cd37c0ebb9242699d1db61d/contacts" }, "parent_ewallet": null, "cnls_partner_query_reference": null } }
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": "2000-11-22", "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", "contact_reference_id": null } ], "has_more": false, "total_count": 1, "url": "/v1/ewallets/ewallet_1d0a9c24781aeccca21f9e640d020d28/contacts" }, "parent_ewallet": null, "cnls_partner_query_reference": null } }
Person Wallet with Associated Parent 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": "2083-06-133959", "parent_ewallet": "ewallet_2ee6d27a928b5861fde301fbfe0d72b0", "metadata": {}, "type": "person", "contact": { "phone_number": "+3547267770", "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": "2000-11-22", "country": "IS", "nationality": "IS", "metadata": { "merchant_defined": true } } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "d61eb505-ee85-46bd-b8a2-5e5c3342032a" }, "data": { "phone_number": null, "email": null, "first_name": "John", "last_name": "Doe", "id": "ewallet_2b34b3d5210343b23f85fbef3aca99db", "status": "ACT", "accounts": [], "verification_status": "not verified", "type": "person", "metadata": {}, "ewallet_reference_id": "2083-06-133959", "category": null, "contacts": { "data": [ { "id": "cont_f5bcfa4857e4f68ae665be14f1e7cb76", "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": "+3547267770", "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_49db4574082a4a6a8bc89e9d86e55fcb", "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": 1727770702 }, "ewallet": "ewallet_2b34b3d5210343b23f85fbef3aca99db", "created_at": 1727770702, "metadata": { "merchant_defined": true }, "business_details": null, "compliance_profile": -1, "verification_status": "not verified", "send_notifications": false, "mothers_name": "Jane Smith", "contact_reference_id": null } ], "has_more": false, "total_count": 1, "url": "/v1/ewallets/ewallet_2b34b3d5210343b23f85fbef3aca99db/contacts" }, "parent_ewallet": "ewallet_2ee6d27a928b5861fde301fbfe0d72b0", "cnls_partner_query_reference": null } }
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": "2000-11-22", "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", "parent_ewallet": null, "cnls_partner_query_reference": null } }