You can follow along the video, or follow the steps below to create and fund a wallet.
Before Getting Started
Be sure to sign up in Client Portal, download the Rapyd Postman Collection to immediately get started with the Rapyd API.
You will want to input your API Credentials into the Postman environment — Rapyd Sandbox Environment.
Create a Wallet
https://sandboxapi.rapyd.net/v1/user
Request
{
"first_name": "Henry Company",
"ewallet_reference_id": "Test-09122023",
"metadata": {
"merchant_defined": true
},
"type": "company",
"contact": {
"phone_number": "+14155588799",
"email": "sanboxtest@rapyd.net",
"first_name": "Mary",
"last_name": "Chen",
"mothers_name": "Mei Hui",
"contact_type": "business",
"address": {
"name": "Henry Company",
"line_1": "888 Some Street",
"city": "Anytown",
"state": "NY",
"country": "US",
"zip": "12345",
"phone_number": "+14155588799"
},
"identification_type": "PA",
"identification_number": "1234567890",
"date_of_birth": "11/22/2000",
"country": "US",
"nationality": "NL",
"metadata": {
"merchant_defined": true
},
"business_details": {
"entity_type": "company",
"name": "Henry Company",
"registration_number": "4234567779",
"industry_category": "bis",
"industry_sub_category": "home services",
"address": {
"name": "Henry Company",
"line_1": "888 Some Street",
"line_2": "Suite 1200",
"city": "Anytown",
"state": "NY",
"country": "US",
"nationality": "IT",
"zip": "10101",
"phone_number": "+14155588799",
"metadata": {
"merchant_defined": true
}
}
}
}
}
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "1a2ce1ea-08ef-40f6-96d4-4d2bc146b08a"
},
"data": {
"phone_number": null,
"email": null,
"first_name": "Henry Company",
"last_name": null,
"id": "ewallet_fbcc006de0394bc2b24308eddca45c64",
"status": "ACT",
"accounts": [],
"verification_status": "not verified",
"type": "company",
"metadata": {
"merchant_defined": true
},
"ewallet_reference_id": "Test-09122023",
"category": null,
"contacts": {
"data": [
{
"id": "cont_b14476c24cdf3616af13204e2630677d",
"first_name": "Mary",
"last_name": "Chen",
"middle_name": "",
"second_last_name": "",
"gender": "not_applicable",
"marital_status": "not_applicable",
"house_type": "",
"contact_type": "business",
"phone_number": "+14155588799",
"email": "sanboxtest@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": "NL",
"address": {
"id": "address_42efee60b3ae37fe34b28f803b57935a",
"name": "Henry Company",
"line_1": "888 Some Street",
"line_2": "",
"line_3": "",
"city": "Anytown",
"state": "NY",
"country": "US",
"zip": "12345",
"phone_number": "+14155588799",
"metadata": {},
"canton": "",
"district": "",
"created_at": 1694544707
},
"ewallet": "ewallet_fbcc006de0394bc2b24308eddca45c64",
"created_at": 1694544707,
"metadata": {
"merchant_defined": true
},
"business_details": {
"id": "busi_3fdbdb9106bd99ee072255157db6534a",
"name": "Henry Company",
"registration_number": "4234567779",
"entity_type": "company",
"industry_category": "bis",
"industry_sub_category": "home services",
"address": {
"id": "address_1ea26d26aa9c439c88ba99d4e7120348",
"name": "Henry Company",
"line_1": "888 Some Street",
"line_2": "Suite 1200",
"line_3": "",
"city": "Anytown",
"state": "NY",
"country": "US",
"zip": "10101",
"phone_number": "+14155588799",
"metadata": {
"merchant_defined": true
},
"canton": "",
"district": "",
"created_at": 1694544707
},
"created_at": 1694544707,
"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": "Mei Hui",
"contact_reference_id": null
}
],
"has_more": false,
"total_count": 1,
"url": "/v1/ewallets/ewallet_fbcc006de0394bc2b24308eddca45c64/contacts"
},
"wallet_operational_currency": null
}
}
Create Payment to Fund Wallet
https://sandboxapi.rapyd.net/v1/payments
Request
{
"amount": 10000,
"currency": "USD",
"customer": "cus_183225bd57e4bc4967bf8b4ddc9c6144",
"ewallets": [
{
"ewallet": "ewallet_fbcc006de0394bc2b24308eddca45c64",
"percentage": 100
}
],
"payment_method": {
"type": "us_debit_visa_card",
"fields": {
"number": "4111111111111111",
"expiration_month": "12",
"expiration_year": "25",
"name": "John Doe",
"cvv": "345"
},
"metadata": {
"merchant_defined": true
}
},
"capture": true,
"complete_payment_url": "https://rapyd.net",
"error_payment_url": "https://docs.rapyd.net"
}
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "2c7664b6-1a4d-421f-b6bc-1945ab617f1f"
},
"data": {
"id": "payment_9dc8ee49ed29c5b66e425f86d17ab9ca",
"amount": 0,
"original_amount": 10000,
"is_partial": false,
"currency_code": "USD",
"country_code": "US",
"status": "ACT",
"description": "",
"merchant_reference_id": "",
"customer_token": "cus_183225bd57e4bc4967bf8b4ddc9c6144",
"payment_method": "card_7dcda71b945d96e4bc86834c59b66d10",
"payment_method_data": {
"id": "card_7dcda71b945d96e4bc86834c59b66d10",
"type": "us_debit_visa_card",
"category": "card",
"metadata": {
"merchant_defined": true
},
"image": "",
"webhook_url": "",
"supporting_documentation": "",
"next_action": "3d_verification",
"name": "John Doe",
"last4": "1111",
"acs_check": "unchecked",
"cvv_check": "unchecked",
"bin_details": {
"type": null,
"brand": null,
"level": null,
"issuer": null,
"country": null,
"bin_number": "411111"
},
"expiration_year": "25",
"expiration_month": "12",
"fingerprint_token": "ocfp_2a694038316f52122bbbb3ae926cfda9"
},
"auth_code": null,
"expiration": 1695150958,
"captured": true,
"refunded": false,
"refunded_amount": 0,
"receipt_email": "",
"redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_9dc8ee49ed29c5b66e425f86d17ab9ca",
"complete_payment_url": "https://rapyd.net",
"error_payment_url": "https://docs.rapyd.net",
"receipt_number": "",
"flow_type": "",
"address": null,
"statement_descriptor": "Test Business",
"transaction_id": "",
"created_at": 1694546158,
"metadata": {},
"failure_code": "",
"failure_message": "",
"paid": false,
"paid_at": 0,
"dispute": null,
"refunds": null,
"order": null,
"outcome": null,
"visual_codes": {},
"textual_codes": {},
"instructions": [],
"ewallet_id": "ewallet_fbcc006de0394bc2b24308eddca45c64",
"ewallets": [
{
"ewallet_id": "ewallet_fbcc006de0394bc2b24308eddca45c64",
"amount": 10000,
"percent": 100,
"refunded_amount": 0
}
],
"payment_method_options": {
"3d_required": true
},
"payment_method_type": "us_debit_visa_card",
"payment_method_type_category": "card",
"fx_rate": 1,
"merchant_requested_currency": null,
"merchant_requested_amount": null,
"fixed_side": "",
"payment_fees": null,
"invoice": "",
"escrow": null,
"group_payment": "",
"cancel_reason": null,
"initiation_type": "customer_present",
"mid": "",
"next_action": "3d_verification",
"error_code": "",
"remitter_information": {},
"save_payment_method": true
}
}
Complete the Bank Redirect Confirmation
Retrieve Wallet Balance
Endpoint / Request
https://sandboxapi.rapyd.net/v1/user/:wallet/accounts
Response
{
"status": {
"error_code": "",
"status": "SUCCESS",
"message": "",
"response_code": "",
"operation_id": "80b8f178-85cc-4d2e-8599-15748a458d09"
},
"data": [
{
"id": "130a51bd-142b-4d79-8105-43104d9d423c",
"currency": "USD",
"alias": "USD",
"balance": 10000,
"received_balance": 0,
"on_hold_balance": 0,
"reserve_balance": 0,
"limits": null,
"limit": null
}
]
}