Rapyd.Services.Wallet (rapyd v1.0.0)

Copy Markdown View Source

Rapyd Wallet — manage eWallets, contacts, virtual accounts, KYC/KYB.

Covers: Wallets, Contacts, Wallet Accounts, Transactions, Transfers, Virtual Accounts, and Identity Verification.

Summary

Functions

Add funds to a wallet account (sandbox).

Add funds to a wallet in the sandbox environment.

Change a wallet's status (enable, disable, close, delete_never_used).

Close a virtual account.

Create a contact on a wallet.

Create a KYC identity verification for a wallet contact.

Issue a virtual bank account tied to a wallet.

Remove the account limit from a wallet.

Get the compliance profile for a wallet contact.

Retrieve a wallet contact.

Retrieve a KYC identity verification.

Retrieve a virtual account.

Retrieve a wallet.

Get account balances for a wallet.

Retrieve a single wallet transaction.

List all virtual accounts issued to a specific wallet.

Put funds on hold in a wallet account.

Release held funds in a wallet account.

Remove funds from a wallet account (sandbox).

Remove funds from a wallet in the sandbox environment.

Set a spending or balance limit on a wallet account.

Set response to a wallet-to-wallet transfer request.

Simulate an inbound deposit (sandbox only).

Transfer funds between two wallets.

Functions

add_funds(client, params)

@spec add_funds(Rapyd.Client.t(), map()) :: {:ok, map()} | {:error, Rapyd.Error.t()}

Add funds to a wallet account (sandbox).

add_sandbox_funds(client, ewallet_id, amount, currency)

@spec add_sandbox_funds(Rapyd.Client.t(), String.t(), float(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Add funds to a wallet in the sandbox environment.

change_wallet_status(client, ewallet_id, action)

@spec change_wallet_status(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Change a wallet's status (enable, disable, close, delete_never_used).

close_virtual_account(client, va_id)

@spec close_virtual_account(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Close a virtual account.

create_contact(client, ewallet_id, params)

@spec create_contact(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Create a contact on a wallet.

create_identity_verification(client, params)

@spec create_identity_verification(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Create a KYC identity verification for a wallet contact.

create_virtual_account(client, params)

@spec create_virtual_account(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Issue a virtual bank account tied to a wallet.

create_wallet(client, params)

@spec create_wallet(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Create a wallet.

delete_account_limit(client, ewallet_id)

@spec delete_account_limit(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Remove the account limit from a wallet.

delete_contact(client, ewallet_id, contact_id)

@spec delete_contact(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Delete a wallet contact.

delete_wallet(client, ewallet_id)

@spec delete_wallet(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Delete a wallet.

get_compliance_profile(client, ewallet_id, contact_id)

@spec get_compliance_profile(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Get the compliance profile for a wallet contact.

get_contact(client, ewallet_id, contact_id)

@spec get_contact(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a wallet contact.

get_identity_verification(client, identity_id)

@spec get_identity_verification(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a KYC identity verification.

get_virtual_account(client, va_id)

@spec get_virtual_account(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a virtual account.

get_wallet(client, ewallet_id)

@spec get_wallet(Rapyd.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a wallet.

get_wallet_accounts(client, ewallet_id)

@spec get_wallet_accounts(Rapyd.Client.t(), String.t()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

Get account balances for a wallet.

get_wallet_transaction(client, ewallet_id, txn_id)

@spec get_wallet_transaction(Rapyd.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Retrieve a single wallet transaction.

list_contacts(client, ewallet_id, filters \\ %{})

@spec list_contacts(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List contacts on a wallet.

list_virtual_accounts(client, filters \\ %{})

@spec list_virtual_accounts(Rapyd.Client.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List virtual accounts.

list_virtual_accounts_by_wallet(client, ewallet_id)

@spec list_virtual_accounts_by_wallet(Rapyd.Client.t(), String.t()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List all virtual accounts issued to a specific wallet.

list_wallet_transactions(client, ewallet_id, filters \\ %{})

@spec list_wallet_transactions(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List transactions on a wallet.

list_wallets(client, filters \\ %{})

@spec list_wallets(Rapyd.Client.t(), map()) ::
  {:ok, list()} | {:error, Rapyd.Error.t()}

List wallets.

put_funds_on_hold(client, params)

@spec put_funds_on_hold(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Put funds on hold in a wallet account.

release_funds(client, params)

@spec release_funds(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Release held funds in a wallet account.

remove_funds(client, params)

@spec remove_funds(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Remove funds from a wallet account (sandbox).

remove_sandbox_funds(client, ewallet_id, amount, currency)

@spec remove_sandbox_funds(Rapyd.Client.t(), String.t(), float(), String.t()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Remove funds from a wallet in the sandbox environment.

set_account_limit(client, ewallet_id, params)

@spec set_account_limit(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Set a spending or balance limit on a wallet account.

set_transfer_response(client, params)

@spec set_transfer_response(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Set response to a wallet-to-wallet transfer request.

simulate_deposit(client, params)

@spec simulate_deposit(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Simulate an inbound deposit (sandbox only).

transfer_funds(client, params)

@spec transfer_funds(Rapyd.Client.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Transfer funds between two wallets.

update_contact(client, ewallet_id, contact_id, params)

@spec update_contact(Rapyd.Client.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update a wallet contact.

update_virtual_account(client, va_id, params)

@spec update_virtual_account(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update a virtual account.

update_wallet(client, ewallet_id, params)

@spec update_wallet(Rapyd.Client.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Rapyd.Error.t()}

Update a wallet.