Package io.moov.sdk

Class Wallets

java.lang.Object

io.moov.sdk.Wallets

public class Wallets
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateWalletRequestBuilder	create()	Create a new wallet for an account.
CreateWalletResponse	create(java.lang.String accountID, CreateWallet createWallet)	Create a new wallet for an account.
GetWalletRequestBuilder	get()	Get information on a specific wallet (e.g., the available balance).
GetWalletResponse	get(java.lang.String accountID, java.lang.String walletID)	Get information on a specific wallet (e.g., the available balance).
ListWalletsRequestBuilder	list()	List the wallets associated with a Moov account.
ListWalletsResponse	list(ListWalletsRequest request)	List the wallets associated with a Moov account.
UpdateWalletRequestBuilder	update()	Update properties of an existing wallet such as name, description, status, or metadata.
UpdateWalletResponse	update(java.lang.String walletID, java.lang.String accountID, PatchWallet patchWallet)	Update properties of an existing wallet such as name, description, status, or metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public CreateWalletRequestBuilder create()

Create a new wallet for an account. You can specify optional attributes such as a display name and description to specify the intended use of the wallet. This will generate a new moov-wallet payment method.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.write` scope.

Returns:

The call builder

create

public CreateWalletResponse create(java.lang.String accountID,
                                   CreateWallet createWallet)
                            throws java.lang.Exception

Create a new wallet for an account. You can specify optional attributes such as a display name and description to specify the intended use of the wallet. This will generate a new moov-wallet payment method.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.write` scope.

Parameters:

accountID - The Moov account ID the wallet belongs to.

createWallet -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListWalletsRequestBuilder list()

List the wallets associated with a Moov account.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.read` scope.

Returns:

The call builder

list

public ListWalletsResponse list(ListWalletsRequest request)
                         throws java.lang.Exception

List the wallets associated with a Moov account.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.read` scope.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetWalletRequestBuilder get()

Get information on a specific wallet (e.g., the available balance).

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.read` scope.

Returns:

The call builder

get

public GetWalletResponse get(java.lang.String accountID,
                             java.lang.String walletID)
                      throws java.lang.Exception

Get information on a specific wallet (e.g., the available balance).

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.read` scope.

Parameters:

accountID -

walletID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateWalletRequestBuilder update()

Update properties of an existing wallet such as name, description, status, or metadata.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.write` scope.

Returns:

The call builder

update

public UpdateWalletResponse update(java.lang.String walletID,
                                   java.lang.String accountID,
                                   PatchWallet patchWallet)
                            throws java.lang.Exception

Update properties of an existing wallet such as name, description, status, or metadata.

Read our [Moov wallets guide](https://docs.moov.io/guides/sources/wallets/) to learn more.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/wallets.write` scope.

Parameters:

walletID - Identifier for the wallet.

accountID - The Moov account ID the wallet belongs to.

patchWallet -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails