Retrieve a payment method
Get the specified payment method 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.
GET
/accounts/{accountID}/payment-methods/{paymentMethodID}
|
|
|
|
The request completed successfully.
A method of moving money
{
"paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42",
"paymentMethodType": "moov-wallet",
"wallet": {
"walletID": "0eb7d670-c252-422a-892d-002136c358e0"
}
}Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
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.
Default:
v2024.01.00Path parameters
accountID
string
<uuid>
required
paymentMethodID
string
<uuid>
required
Response
application/json
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
moov-wallet
wallet
object
Show child attributes
walletID
string<uuid>
required
bankAccount
object
A bank account as contained within a payment method.
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
The bank account type.
Possible values:
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
The type of holder on a funding source.
Possible values:
individual,
business
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
Possible values:
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
ach-debit-fund
bankAccount
object
A bank account as contained within a payment method.
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
The bank account type.
Possible values:
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
The type of holder on a funding source.
Possible values:
individual,
business
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
Possible values:
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
ach-debit-collect
bankAccount
object
A bank account as contained within a payment method.
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
The bank account type.
Possible values:
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
The type of holder on a funding source.
Possible values:
individual,
business
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
Possible values:
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
ach-credit-standard
bankAccount
object
A bank account as contained within a payment method.
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
The bank account type.
Possible values:
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
The type of holder on a funding source.
Possible values:
individual,
business
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
Possible values:
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
ach-credit-same-day
bankAccount
object
A bank account as contained within a payment method.
Show child attributes
bankAccountID
string<uuid>
required
bankAccountType
string<enum>
required
The bank account type.
Possible values:
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
The type of holder on a funding source.
Possible values:
individual,
business
lastFourAccountNumber
string
required
routingNumber
string
required
status
string<enum>
required
Possible values:
new,
verified,
verificationFailed,
pending,
errored
updatedOn
string<date-time>
required
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
rtp-credit
card
object
A card as contained within a payment method.
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
The first six to eight digits of the card number, which identifies the financial institution that issued the card.
brand
string<enum>
required
The card brand.
Possible values:
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
ID of the card.
cardType
string<enum>
required
The type of the card.
Possible values:
debit,
credit,
prepaid,
unknown
cardVerification
object
required
The results of submitting cardholder data to a card network for verification.
Show child attributes
accountName
object
required
The results of submitting cardholder name to a card network for verification.
Show child attributes
firstName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
addressLine1
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
domesticPullFromCard
string<enum>
required
Indicates if the card supports domestic pull-from-card transfer.
Possible values:
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
required
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
required
The expiration date of the card or token.
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
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.
issuer
string
required
Financial institution that issued the card.
issuerCountry
string
required
Country where the card was issued.
lastFourCardNumber
string
4 characters
required
Last four digits of the card number
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>
cardOnFile
boolean
Indicates cardholder has authorized card to be stored for future payments.
holderName
string
The name of the cardholder as it appears on the card.
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
card-payment
card
object
A card as contained within a payment method.
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
The first six to eight digits of the card number, which identifies the financial institution that issued the card.
brand
string<enum>
required
The card brand.
Possible values:
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
ID of the card.
cardType
string<enum>
required
The type of the card.
Possible values:
debit,
credit,
prepaid,
unknown
cardVerification
object
required
The results of submitting cardholder data to a card network for verification.
Show child attributes
accountName
object
required
The results of submitting cardholder name to a card network for verification.
Show child attributes
firstName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
addressLine1
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
domesticPullFromCard
string<enum>
required
Indicates if the card supports domestic pull-from-card transfer.
Possible values:
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
required
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
required
The expiration date of the card or token.
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
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.
issuer
string
required
Financial institution that issued the card.
issuerCountry
string
required
Country where the card was issued.
lastFourCardNumber
string
4 characters
required
Last four digits of the card number
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>
cardOnFile
boolean
Indicates cardholder has authorized card to be stored for future payments.
holderName
string
The name of the cardholder as it appears on the card.
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
push-to-card
card
object
A card as contained within a payment method.
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
The first six to eight digits of the card number, which identifies the financial institution that issued the card.
brand
string<enum>
required
The card brand.
Possible values:
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardID
string<uuid>
required
ID of the card.
cardType
string<enum>
required
The type of the card.
Possible values:
debit,
credit,
prepaid,
unknown
cardVerification
object
required
The results of submitting cardholder data to a card network for verification.
Show child attributes
accountName
object
required
The results of submitting cardholder name to a card network for verification.
Show child attributes
firstName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
fullName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
lastName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
middleName
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
addressLine1
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
cvv
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
postalCode
string<enum>
required
Possible values:
noMatch,
match,
notChecked,
unavailable,
partialMatch
domesticPullFromCard
string<enum>
required
Indicates if the card supports domestic pull-from-card transfer.
Possible values:
not-supported,
supported,
unknown
domesticPushToCard
string<enum>
required
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
required
The expiration date of the card or token.
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
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.
issuer
string
required
Financial institution that issued the card.
issuerCountry
string
required
Country where the card was issued.
lastFourCardNumber
string
4 characters
required
Last four digits of the card number
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>
cardOnFile
boolean
Indicates cardholder has authorized card to be stored for future payments.
holderName
string
The name of the cardholder as it appears on the card.
merchantAccountID
string<uuid>
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
pull-from-card
applePay
object
Describes an Apple Pay token on a Moov account.
Show child attributes
brand
string<enum>
required
The card brand.
Possible values:
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
The type of the card.
Possible values:
debit,
credit,
prepaid,
unknown
dynamicLastFour
string
required
The last four digits of the Apple Pay token, which may differ from the tokenized card’s last four digits.
expiration
object
required
The expiration date of the card or token.
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
fingerprint
string
<=100 characters
required
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.
issuerCountry
string
Country where the underlying card was issued.
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
apple-pay
A card used at point of sale terminal for a card present transaction as contained within a payment method.
paymentMethodID
string<uuid>
ID of the payment method.
paymentMethodType
string<enum>
Possible values:
card-present-payment
terminalCard
object
Describes payment card details captured with tap or in-person payment.
Show child attributes
bin
string
[6 to 8] characters
brand
string<enum>
The card brand.
Possible values:
American Express,
Discover,
Mastercard,
Visa,
Unknown
cardType
string<enum>
The type of the card.
Possible values:
debit,
credit,
prepaid,
unknown
entryMode
string<enum>
How the card information was entered into the point of sale terminal.
Possible values:
contactless
expiration
object
The expiration date of the card or token.
Show child attributes
month
string
2 characters
required
year
string
2 characters
required
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.
lastFourCardNumber
string
4 characters
Last four digits of the card number