List payment methods
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/payment-methods.read
scope when generating a token.
GET
/accounts/{accountID}/payment-methods
Successfully retrieved payment methods
[
{
"paymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"paymentMethodType": "moov-wallet",
"wallet": {
"walletID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
}
}
]
No account with the specified accountID was found
Request was refused due to rate limiting.
Response headers
X-Retry-In
string
<duration>
How long (in milliseconds) to wait until able to retry the request.
Path parameters
accountID
string
<uuid>
required
ID of the account.
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
Optional parameter to filter the account’s payment methods by payment method type.
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
Response
application/json
A method of moving money that is a Moov wallet
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
wallet
object
A Moov wallet to store funds for transfers.
Show child attributes
walletID
string<uuid>
<=36 characters
Pattern
UUID v4
A method of moving money that is a bank account
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
bankAccount
object
Describes a bank account on a Moov account.
Show child attributes
bankAccountID
string<uuid>
<=36 characters
Pattern
UUID v4
bankAccountType
string<enum>
The bank account type.
Possible values:
checking
,
savings
,
unknown
bankName
string
exceptionDetails
object
Reason for, and details related to, an
errored
or verificationFailed
bank account status.
Show child attributes
achReturnCode
string<enum>
The return code of an ACH transaction that caused the bank account status to change.
Possible values:
R02
,
R03
,
R04
,
R05
,
R07
,
R08
,
R10
,
R11
,
R12
,
R13
,
R14
,
R15
,
R16
,
R17
,
R20
,
R23
,
R29
,
R34
,
R38
,
R39
description
string
Details related to an
errored
or verificationFailed
bank account status.
rtpRejectionCode
string<enum>
The rejection code of an RTP transaction that caused the bank account status to change.
Possible values:
AC03 - Account Invalid
,
AC04 - Account Closed
,
AC06 - Account Blocked
,
AC14 - Creditor Account Type Invalid
,
AG01 - Transactions Forbidden On Account
,
AG03 - Transaction Type Not Supported
,
MD07 - Customer Deceased
fingerprint
string
<=100 characters
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
holderType
string<enum>
The type of holder on a funding source.
Possible values:
individual
,
business
lastFourAccountNumber
string
paymentMethods
array
Includes any payment methods generated for a newly created bank account, removing the need to call the List Payment Methods endpoint following a successful Create BankAccount request.
NOTE: This field is only populated for Create BankAccount requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
routingNumber
string
status
string<enum>
The bank account status.
Possible values:
new
,
verified
,
verificationFailed
,
pending
,
errored
statusReason
string<enum>
The reason the bank account status changed to the current value.
Possible values:
bank-account-created
,
verification-initiated
,
micro-deposit-attempts-exceeded
,
micro-deposit-expired
,
max-verification-failures
,
verification-successful
,
ach-debit-return
,
ach-credit-return
,
rtp-credit-failure
,
micro-deposit-return
,
admin-action
,
other
updatedOn
string<date-time>
<=24 characters
A method of moving money that is a credit or debit card
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
card
object
Describes a card on a Moov account.
Show child attributes
billingAddress
object
Show child attributes
addressLine1
string
<=60 characters
required
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
<=5 characters
required
stateOrProvince
string
<=2 characters
required
addressLine2
string
<=32 characters
bin
string
brand
string
The card brand.
Possible values:
American Express
,
Discover
,
Mastercard
,
Visa
cardAccountUpdater
object
The results of the most recent card update request.
Show child attributes
updateType
string<enum>
The results of the card update request.
Possible values:
unspecified
,
account-closed
,
contact-cardholder
,
expiration-update
,
no-change
,
no-match
,
number-update
updatedOn
string<date-time>
<=24 characters
cardID
string<uuid>
<=36 characters
Pattern
UUID v4
cardOnFile
boolean
Indicates cardholder has authorized card to be stored for future payments.
cardType
string<enum>
The type of the card.
Possible values:
debit
,
credit
,
prepaid
,
unknown
cardVerification
object
The results of submitting cardholder data to a card network for verification.
Show child attributes
accountName
object
The results of submitting cardholder name to a card network for verification.
Show child attributes
firstName
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
fullName
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
lastName
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
middleName
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
addressLine1
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
cvv
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
postalCode
string
Possible values:
noMatch
,
match
,
notChecked
,
unavailable
,
partialMatch
domesticPullFromCard
string
Indicates if the card supports domestic pull-from-card transfer.
Possible values:
not-supported
,
supported
,
unknown
domesticPushToCard
string
Indicates which level of domestic push-to-card transfer is supported by the card, if any.
Possible values:
not-supported
,
standard
,
fast-funds
,
unknown
expiration
object
The expiration date of the card or token.
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters
Uniquely identifies a linked payment card or token.
For Apple Pay, the fingerprint is based on the tokenized card number and may vary based on the user’s device.
This field can be used to identify specific payment methods across multiple accounts on your platform.
holderName
string
issuer
string
issuerCountry
string
lastFourCardNumber
string
merchantAccountID
string<uuid>
<=36 characters
Pattern
ID of the Moov account acting as a merchant or other entity authorized to store the card.
Defaults to your platform account ID if cardOnFile is set to true and no other account is provided.
paymentMethods
array
Includes any payment methods generated for a newly linked card, removing the need to call the List Payment Methods endpoint following a successful Link Card request.
NOTE: This field is only populated for Link Card requests made with the X-Wait-For
header.
Show child attributes
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
A method of moving money using an Apple Pay token.
paymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
paymentMethodType
string<enum>
The payment method type that represents a payment rail and directionality
Possible values:
moov-wallet
,
ach-debit-fund
,
ach-debit-collect
,
ach-credit-standard
,
ach-credit-same-day
,
rtp-credit
,
card-payment
,
apple-pay
,
push-to-card
,
pull-from-card
applePay
object
Describes an Apple Pay token on a Moov account.
Show child attributes
brand
string<enum>
The card brand.
Possible values:
American Express
,
Discover
,
Mastercard
,
Visa
cardDisplayName
string
User-friendly name of the tokenized card returned by Apple.
It usually contains the brand and the last four digits of the underlying card for example, “Visa 1256”.
There is no standard format.
cardType
string<enum>
The type of the card.
Possible values:
debit
,
credit
,
prepaid
,
unknown
dynamicLastFour
string
The last four digits of the Apple Pay token, which may differ from the tokenized card’s last four digits
expiration
object
The expiration date of the card or token.
Show child attributes
month
string
2 characters
year
string
2 characters
fingerprint
string
<=100 characters
Uniquely identifies a linked payment card or token.
For Apple Pay, the fingerprint is based on the tokenized card number and may vary based on the user’s device.
This field can be used to identify specific payment methods across multiple accounts on your platform.