Creating a Rapyd Wallet

Build a powerful wallet architecture. | Enterprise

A Rapyd Wallet is a place to hold funds as you accept payments, fund payouts and issue cards. Rapyd enables clients to issue wallets to consumers and businesses to manage the flow of funds in and out of their ecosystem.

Wallets issued for your business customers will use type: company. A business can allow more than one contact linked to a wallet.

Wallets issued for your consumers will use type: person. A personal wallet only allows one contact per wallet.

Creating a Rapyd Wallet Workflow

You ask the customer for their information
The customer provides their contact information.
Your website back end asks Rapyd to create a wallet for the customer
Rapyd returns with a personal wallet and sends you a webhook.
You begin the process to verify the customer through Identity Verification.

Next Steps: Verify Identity

You will need to verify the customer's identity through the required documents relevant to the customer's country as described in Identity Verification.

Rapyd Wallet Message Sequences

The message sequence diagrams below describe how information is exchanged between Rapyd, the merchant, and the merchant's customers.

Create Wallet

How Creating a Rapyd Wallet Works

Create a Rapyd Wallet Request

To create a Rapyd Wallet, you'll use Create Wallet with the following parameters:

Description of Parameters

Body Parameter	Description
contact	Describes details about the wallet contacts. Array of objects.
email	Email address of the wallet owner.
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.
last_name	Family name of the Rapyd Wallet owner.
metadata	A JSON object defined by the client.
type	Type of wallet: company or person. Default is person.

Request

{
    "first_name": "Samson",
    "last_name": "Smith",
    "email": "",
    "ewallet_reference_id": "Samson-Smith-09232021",
    "metadata": {
        "merchant_defined": true
    },
    "phone_number": "5555555555",
    "type": "person",
    "contact": {
        "phone_number": "+14155551311",
        "email": "samson@rapyd.net",
        "first_name": "Samson",
        "last_name": "Smith",
        "mothers_name": "Jane Smith",
        "contact_type": "personal",
        "address": {
            "name": "Samson Smith",
            "line_1": "123 Main Street",
            "line_2": "",
            "line_3": "",
            "city": "Anytown",
            "state": "NY",
            "country": "US",
            "zip": "12345",
            "phone_number": "+14155551111",
            "metadata": {},
            "canton": "",
            "district": ""
        },
        "identification_type": "PA",
        "identification_number": "1234567890",
        "date_of_birth": "11/22/2000",
        "country": "US",
        "nationality": "US",
        "metadata": {
            "merchant_defined": true
        }
    }
}

The data section of this request shows a type of wallet that can be created. There are only three types of wallets: person, company, and client. The wallet object is described with the following parameters:

The phone_number is 5555555555.
The ewallet_reference_id is Samson-Smith-09232021.
The contactfirst_name and last_name is SamsonSmith.

Create Wallet Response

Response

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "466d421d-d20e-4d4b-8702-a64d7995b707"
    },
    "data": {
        "phone_number": "5555555555,
        "email": null,
        "first_name": "Samson",
        "last_name": "Smith",
        "id": "ewallet_54d53f5dd6dbb23d74c1f9807603180c",
        "status": "ACT",
        "accounts": [],
        "verification_status": "not verified",
        "type": "person",
        "metadata": {
            "merchant_defined": true
        },
        "ewallet_reference_id": "Samson-Smith-10272021",
        "category": null,
        "contacts": {
            "data": [
                {
                    "id": "cont_590315fa4e0c08357e794284fac95bdd",
                    "first_name": "Samson",
                    "last_name": "Smith",
                    "middle_name": "",
                    "second_last_name": "",
                    "gender": "not_applicable",
                    "marital_status": "not_applicable",
                    "house_type": "",
                    "contact_type": "personal",
                    "phone_number": "+14155551311",
                    "email": "samson@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": "US",
                    "address": {
                        "id": "address_6f2e5e5bcf528b1c629361c9c68d5589",
                        "name": "Samson Smith",
                        "line_1": "123 Main Street",
                        "line_2": "",
                        "line_3": "",
                        "city": "Anytown",
                        "state": "NY",
                        "country": "US",
                        "zip": "12345",
                        "phone_number": "+14155551111",
                        "metadata": {},
                        "canton": "",
                        "district": "",
                        "created_at": 1635375280
                    },
                    "ewallet": "ewallet_54d53f5dd6dbb23d74c1f9807603180c",
                    "created_at": 1635375280,
                    "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_54d53f5dd6dbb23d74c1f9807603180c/contacts"
        }
    }
}

The data section of this request shows the ewallet that was created.

The contact object id cont_590315fa4e0c08357e794284fac95bdd and Samson Smith. FIelds are describe under Wallet Contact Object.
The ewallet id is ewallet_54d53f5dd6dbb23d74c1f9807603180c

In this section:

Documentation