Depositing Cash to Wallet
Deposit cash at a physical location.
Rapyd makes it easy for you to enable customers to deposit cash to a Rapyd Wallet using a POS. The POS API provides methods for handling deposits at Rapyd POS locations, such as ATMs and retail stores.
Some common use cases may include:
A customer depositing cash to their own wallet.
A business deposits their cash to their company wallet.
For example, the customer would like to deposit 100 GBP (Pound Sterling) into her wallet by depositing the cash at a POS. The POS accepts 100 GBP (Pound Sterling) in cash from the customer, and notifies Rapyd. Rapyd deposits the money into her wallet.
Let’s look at the highlights of your workflow.
Step 1: Getting a One-Time Password (OTP)
Using your mobile application, a customer asks for an OTP.
You request an OTP from Rapyd.
Rapyd sends the OTP to you.
Your app displays the OTP to the customer.
Step 2: Opening a Session
You ask Rapyd to open a session.
Rapyd opens a session.
Step 3: Depositing Cash
You create a request for depositing cash to an eWallet.
Rapyd creates a deposit transaction.
The customer deposits 100 GBP (Pound Sterling) at the POS.
The POS notifies Rapyd.
Rapyd completes the deposit and notifies you.
Step 4: Closing the Session
You ask Rapyd to close the session.
Rapyd closes the session.
To generate a one-time password (OTP), the customer uses the mobile application that you provide to your customers for managing wallets.
The customer runs the mobile application that you provide to your customers for managing their wallets.
The customer requests an OTP code, and the app displays 876680.
Make sure to store the OTP code for future use.
The OTP is valid for 30 seconds. If you do not open a session within that time, then the customer must get a new OTP code.
Use the Open Session method to open a session with the following parameters:
Description of Header Parameters
Header Parameter | Description |
|---|---|
access_key | Enter 8C6223151 as the access key. |
phone_number | Enter +14155559992 as the customer’s phone number. |
Content-Type | Enter application/json as the type of content. |
Description of Path Parameters
Path Parameter | Description |
|---|---|
pos_id | Enter z128ffb-11a5-11l9-93p5-1231a8maf28 as the ID of the point-of-sale location. The |
otp_code | Enter 876680 . |
Open Session Request
You ask Rapyd to open a session.
Request
// Request URL: POST https://sandboxpos.rapyd.net/v1/pos/login/z128ffb-11a5-11l9-93p5-1231a8maf28/876680 // Headers: access_key: 8C6223151 phone_number: +14155559992 Content-Type: application/json // No message body
Open Session Response
Response
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "d1063f84-977b-48f5-a3a3-a3e4d94be47f" }, "data": { "token_id": "d9b7398f-5c2f-438c-8ac6-68e79f28c02e", "operation_id": "95e2c071-9513-48d6-a717-a480814f7df8", "accounts": [ { "account_id": "64e4a964-53b5-11e9-8495-02f0df928b", "account_currency": "GBP", "account_alias": "GBP", "account_balance": 955, "account_currency_symbol": "£" } ] } }
The data section of the response shows the following information:
The customer's wallet includes an account for the GBP currency.
The
token_idis d9b7398f-5c2f-438c-8ac6-68e79f28c02e.The
operation_idis 95e2c071-9513-48d6-a717-a480814f7df8.
Make sure to store these values for future use.
You’ll use the Deposit method to deposit 100 GBP into the customer’s wallet. Make a deposit with the following parameters:
Description of Header Parameters
Header Parameter | Description |
|---|---|
Content-Type | Enter application/json as the type of content. |
access_key | Enter 8C6223151 as the access key. |
token_id | Enter d9b7398f-5c2f-438c-8ac6-68e79f28c02e as the |
operation_id | Enter 95e2c071-9513-48d6-a717-a480814f7df8 as the |
phone_number | Enter +14155559992 as the customer’s phone number. |
Description of Path Parameters
Path Parameter | Description |
|---|---|
amount | Enter 100 as the amount to deposit. |
currency_code | Enter GBP as the `currency of the amount. |
Deposit Cash to a Wallet Request
You ask Rapyd to deposit funds to the customer's wallet.
Request
// Request URL: POST https://sandboxpos.rapyd.net/v1/pos/deposit/100.00/GBP // Headers: access_key: 8C6223151 phone_number: +14155559992 Content-Type: application/json token_id: d9b7398f-5c2f-438c-8ac6-68e79f28c02e operation_id: 95e2c071-9513-48d6-a717-a480814f7df8 // Message body absent
Deposit Cash to a Wallet Response
Let's take a look at the Deposit response.
Response
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "0c211a3c-a4c4-4708-bbe9-7628ddd07437" }, "data": { "transaction_id": "4e61e815-b68f-11e9-9ffc-12c4c8fed768" } }
This confirms that Rapyd deposited 100 GBP (Pound Sterling) to the customer's wallet.
Use the following parameters:
Description of Header Parameters
Header Parameter | Description |
|---|---|
Content-Type | Enter application/json as the type of content. |
access_key | Enter 8C6223151 as the access key. |
token_id | Enter d9b7398f-5c2f-438c-8ac6-68e79f28c02e as the |
operation_id | Enter 95e2c071-9513-48d6-a717-a480814f7df8 as the |
phone_number | Enter +14155559992 as the customer’s phone number. |
Close Session Request
You ask Rapyd to close the session.
Request
// Request URL: POST https://sandboxpos.rapyd.net/v1/pos/logout // Headers: access_key: 8C6223151 phone_number: +14155559992 Content-Type: application/json token_id: d9b7398f-5c2f-438c-8ac6-68e79f28c02e operation_id: 95e2c071-9513-48d6-a717-a480814f7df8 // No message body
The 'status' parameter in this response shows that the session closed successfully.
Close Session Response
Let's take a look at the Close Session response.
Response
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "09666c40-77fa-49c7-be73-82ade0217c8e" } }
The 'status' parameter in this response shows that the session closed successfully.