Package io.moov.sdk

Class PaymentMethods

java.lang.Object

io.moov.sdk.PaymentMethods

public class PaymentMethods
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
GetPaymentMethodRequestBuilder	get()	Get the specified payment method associated with a Moov account.
GetPaymentMethodResponse	get(java.lang.String accountID, java.lang.String paymentMethodID)	Get the specified payment method associated with a Moov account.
ListPaymentMethodsRequestBuilder	list()	Retrieve a list of payment methods associated with a Moov account.
ListPaymentMethodsResponse	list(java.lang.String accountID)	Retrieve a list of payment methods associated with a Moov account.
ListPaymentMethodsResponse	list(java.lang.String accountID, java.util.Optional<java.lang.String> sourceID, java.util.Optional<? extends PaymentMethodType> paymentMethodType)	Retrieve a list of payment methods associated with a Moov account.

Methods inherited from class java.lang.Object

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

Method Detail

list

public ListPaymentMethodsRequestBuilder list()

Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

Returns:

The call builder

list

public ListPaymentMethodsResponse list(java.lang.String accountID)
                                throws java.lang.Exception

Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListPaymentMethodsResponse list(java.lang.String accountID,
                                       java.util.Optional<java.lang.String> sourceID,
                                       java.util.Optional<? extends PaymentMethodType> paymentMethodType)
                                throws java.lang.Exception

Retrieve a list of payment methods associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

Parameters:

accountID -

sourceID - Optional parameter to filter the account's payment methods by source ID. A source ID can be a [walletID](https://docs.moov.io/api/sources/wallets/list/), [cardID](https://docs.moov.io/api/sources/cards/list/), or [bankAccountID](https://docs.moov.io/api/sources/bank-accounts/list/).

paymentMethodType - The payment method type that represents a payment rail and directionality

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetPaymentMethodRequestBuilder get()

Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

Returns:

The call builder

get

public GetPaymentMethodResponse get(java.lang.String accountID,
                                    java.lang.String paymentMethodID)
                             throws java.lang.Exception

Get the specified payment method associated with a Moov account. Read our [payment methods guide](https://docs.moov.io/guides/money-movement/payment-methods/) 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}/payment-methods.read` scope.

Parameters:

accountID -

paymentMethodID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails