Payment methods

Payments methods represent all of the ways an account can move funds to another Moov account. Payment methods are generated programmatically when a card or bank account is added or the status is updated. For example, ach-debit-fund will be added as a payment method once the bank account is verified. For more context, read our payment methods guide.

Get

Get the specified payment method associated with a Moov account. The PAYMENT_METHODS_READ scope enum is required when making a request from the browser.

1
paymentmethods.get(accountID, paymentMethodID)

Parameters

Name Type Description
accountID string Account on which to request bank account
paymentMethodID string ID of the payment method to retrieve. Can be one of walletID, cardID, or bankAccountID.

Returns

Promise.<PaymentMethod>

List

Retrieve all of the payment methods associated with a Moov account. The PAYMENT_METHODS_READ scope enum is required when making a request from the browser.

1
paymentmethods.list(accountID)

Parameters

Name Type Description
accountID string Account on which to request bank account

Returns

Promise.<Array.<PaymentMethod>>

Types

WalletPaymentType

Wallet Payment Type

Properties

Property Type Description
walletID string Wallet identifier

PaymentMethod

Describes a Payment Method.

Properties

Property Type Description
paymentMethodID string Payment Method identifier
paymentMethodType PAYMENT_METHODS_TYPE Fingerprint of Bank Account
wallet WalletPaymentType Optional wallet object when payment method type is ‘moov-wallet’.
bankAccount BankAccount Optional bank account object when payment method type is one of ‘ach-debit-fund’, ‘ach-debit-collect’, ach-credit-standard’, or ‘ach-credit-same-day’.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "paymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "paymentMethodType": "ach-debit-fund",
  "bankAccount": {
    "bankAccountID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3",
    "status": "new",
    "holderName": "Jules Jackson",
    "holderType": "individual",
    "bankName": "Chase Bank",
    "bankAccountType": "checking",
    "routingNumber": "string",
    "lastFourAccountNumber": "7000"
  }
}

Enums

PAYMENT_METHODS_TYPE

Value Description
MOOV_WALLET Moov Wallet Payment Type
ACH_DEBIT_FUND ACH Debt Fund Payment Type
ACH_DEBIT_COLLECT ACH Debt Collect Payment Type
ACH_CREDIT_STANDARD ACH Credit Standard Payment Type
ACH_CREDIT_SAME_DAY ACH Credit Same Day Payment Type
CARD Card Payment Type
Summary Beta