List cards
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/cards.read
scope when generating a token.
GET
/accounts/{accountID}/cards
|
|
|
|
|
|
Successfully retrieved cards.
[
{
"billingAddress": {
"addressLine1": "123 Main Street",
"addressLine2": "Apt 302",
"city": "Boulder",
"country": "US",
"postalCode": "80301-1234",
"stateOrProvince": "CO"
},
"bin": "123456",
"brand": "Discover",
"cardAccountUpdater": {
"updateType": "number-update",
"updatedOn": "2019-08-24T14:15:22Z"
},
"cardCategory": "CLASSIC",
"cardID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"cardOnFile": true,
"cardType": "debit",
"cardVerification": {
"accountName": {
"firstName": "match",
"fullName": "match",
"lastName": "match",
"middleName": "match"
},
"addressLine1": "match",
"cvv": "match",
"postalCode": "match"
},
"commercial": true,
"domesticPullFromCard": "supported",
"domesticPushToCard": "fast-funds",
"expiration": {
"month": "01",
"year": "21"
},
"fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3",
"holderName": "Jules Jackson",
"issuer": "GRINGOTTS BANK",
"issuerCountry": "US",
"issuerPhone": "8185551212",
"issuerURL": "HTTPS://WWW.EXAMPLE.COM/",
"lastFourCardNumber": "1234",
"merchantAccountID": "50469144-f859-46dc-bdbd-9587c2fa7b42",
"paymentMethods": [
{
"paymentMethodID": "9506dbf6-4208-44c3-ad8a-e4431660e1f2",
"paymentMethodType": "card-payment"
},
{
"paymentMethodID": "3f9969cf-a1f3-4d83-8ddc-229a506651cf",
"paymentMethodType": "push-to-card"
}
],
"regulated": true
}
]
No account with the specified accountID was found.
Request was refused due to rate limiting.
Response headers
Retry-After
number
Path parameters
accountID
string
<uuid>
required
ID of the Moov account representing the cardholder.
Response
application/json
billingAddress
object
Show child attributes
addressLine1
string
<=60 characters
required
city
string
<=24 characters
required
country
string
<=2 characters
required
postalCode
string
[1 to 10] characters
required
stateOrProvince
string
<=2 characters
required
addressLine2
string
<=32 characters
bin
string
The first six to eight digits of the card number, which identifies the financial institution that issued the card.
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
cardCategory
string
The category or level of the card defined by the issuer. Examples include, but not limited to “REWARDS”, “TRADITIONAL REWARDS”, “CLASSIC”, and “CORPORATE PURCHASING”.
cardID
string<uuid>
<=36 characters
UUID
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
commercial
boolean
If true, the card is for commercial use, or associated with a business. If false, the card is associated with a general consumer.
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
The name of the cardholder as it appears on the card.
issuer
string
Financial institution that issued the card.
issuerCountry
string
Country where the card was issued.
issuerPhone
string
Phone number of the issuer.
issuerURL
string
URL of the issuer.
lastFourCardNumber
string
Last four digits of the card number
merchantAccountID
string<uuid>
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
UUID
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
regulated
boolean
If true, the card issuing bank is regulated, and the scheme fees for debit transactions will be limited based on the Durbin Amendment. If false, the card issuing bank is not regulated, and the scheme fees will not be limited.