List payment methods
Retrieve a list of payment methods associated with a Moov account. Read our payment methods guide to learn more.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/payment-methods.read scope.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[
{
"paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
"paymentMethodType": "moov-wallet",
"wallet": {
"walletID": "0eb7d670-c252-422a-892d-002136c358e0",
"partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
"walletType": "default"
}
}
]Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
v2024.01.00Path parameters
accountID
string
<uuid>
required
Query parameters
sourceID
string
<uuid>
Optional parameter to filter the account's payment methods by source ID.
A source ID can be a walletID, cardID, or bankAccountID.
paymentMethodType
string
moov-wallet,
ach-debit-fund,
ach-debit-collect,
ach-credit-standard,
ach-credit-same-day,
rtp-credit,
card-payment,
push-to-card,
pull-from-card,
apple-pay,
card-present-payment
Response
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
moov-wallet
wallet
object
Show child attributes
partnerAccountID
string<uuid>
required
walletID
string<uuid>
required
walletType
string<enum>
required
Type of a wallet.
default: The system-generated wallet automatically created when an account is granted the wallet capability.general: An additional, user-defined wallet created via API or Dashboard.
default,
general
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
ach-debit-fund
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
ach-debit-collect
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
ach-credit-standard
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
ach-credit-same-day
bankAccount
object
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
checking,
savings,
general-ledger,
loan
bankName
string
required
fingerprint
string
<=100 characters
required
Once the bank account is linked, we don't reveal the full bank account number.
The fingerprint acts as a way to identify whether two linked bank accounts are the same.
holderName
string
required
holderType
string<enum>
required
individual,
business,
guest
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
rtp-credit
card
object
Show child attributes
billingAddress
object
required
Show child attributes
postalCode
string
<=10 characters
required
addressLine1
string
<=60 characters
addressLine2
string
<=32 characters
city
string
<=32 characters
country
string
<=2 characters
stateOrProvince
string
<=2 characters
bin
string
[6 to 8] characters
required
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
cardVerification
object
required
Show child attributes
addressLine1
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
accountName
object
Show child attributes
firstName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
expiration
object
required
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
lastFourCardNumber
string
4 characters
required
cardAccountUpdater
object
Show child attributes
updateType
string<enum>
unspecified,
account-closed,
contact-cardholder,
expiration-update,
no-change,
no-match,
number-update
updatedOn
string<date-time>
cardOnFile
boolean
domesticPullFromCard
string<enum>
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
not-supported,
standard,
fast-funds,
unknown
holderName
string
issuer
string
issuerCountry
string
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
card-payment
card
object
Show child attributes
billingAddress
object
required
Show child attributes
postalCode
string
<=10 characters
required
addressLine1
string
<=60 characters
addressLine2
string
<=32 characters
city
string
<=32 characters
country
string
<=2 characters
stateOrProvince
string
<=2 characters
bin
string
[6 to 8] characters
required
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
cardVerification
object
required
Show child attributes
addressLine1
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
accountName
object
Show child attributes
firstName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
expiration
object
required
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
lastFourCardNumber
string
4 characters
required
cardAccountUpdater
object
Show child attributes
updateType
string<enum>
unspecified,
account-closed,
contact-cardholder,
expiration-update,
no-change,
no-match,
number-update
updatedOn
string<date-time>
cardOnFile
boolean
domesticPullFromCard
string<enum>
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
not-supported,
standard,
fast-funds,
unknown
holderName
string
issuer
string
issuerCountry
string
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
push-to-card
card
object
Show child attributes
billingAddress
object
required
Show child attributes
postalCode
string
<=10 characters
required
addressLine1
string
<=60 characters
addressLine2
string
<=32 characters
city
string
<=32 characters
country
string
<=2 characters
stateOrProvince
string
<=2 characters
bin
string
[6 to 8] characters
required
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
cardVerification
object
required
Show child attributes
addressLine1
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
noMatch,
match,
notChecked,
unavailable,
partialMatch
accountName
object
Show child attributes
firstName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
noMatch,
match,
notChecked,
unavailable,
partialMatch
expiration
object
required
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
lastFourCardNumber
string
4 characters
required
cardAccountUpdater
object
Show child attributes
updateType
string<enum>
unspecified,
account-closed,
contact-cardholder,
expiration-update,
no-change,
no-match,
number-update
updatedOn
string<date-time>
cardOnFile
boolean
domesticPullFromCard
string<enum>
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
not-supported,
standard,
fast-funds,
unknown
holderName
string
issuer
string
issuerCountry
string
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
pull-from-card
applePay
object
Show child attributes
brand
string<enum>
required
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardDisplayName
string
required
User-friendly name of the tokenized card returned by Apple.
It usually contains the brand and the last four digits of the underlying card. There is no standard format.
cardType
string<enum>
required
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
required
expiration
object
required
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
issuerCountry
string
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
apple-pay
paymentMethodID
string<uuid>
paymentMethodType
string<enum>
card-present-payment
terminalCard
object
Show child attributes
applicationID
string
applicationName
string
bin
string
[6 to 8] characters
brand
string<enum>
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardType
string<enum>
debit,
credit,
prepaid,
unknown
entryMode
string<enum>
contactless
expiration
object
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
holderName
string
issuer
string
issuerCountry
string
lastFourCardNumber
string
4 characters