Retrieve a payment method

Get the specified payment method associated with a Moov account. Read our payment methods guide to learn more.

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/{paymentMethodID}

cURL Go JavaScript

1
2


curl -X GET "https://api.moov.io/accounts/{accountID}/payment-methods/{paymentMethodID}" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5
6


mc, _ := moov.NewClient()

var accountID string
var paymentMethodID string

mc.GetPaymentMethod(ctx, accountID, paymentMethodID)

1
2
3


const moov = new Moov(credentialsObject);

moov.paymentmethods.get(accountID, paymentMethodID)

200 404 429

Successfully retrieved payment method

A method of moving money

{
  "paymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "paymentMethodType": "moov-wallet",
  "wallet": {
    "walletID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
  }
}

No payment method with the specified accountID was found

Request was refused due to rate limiting.

Retry-After


      number

Path parameters

accountID


      string
      <uuid>

required

ID of the account.

paymentMethodID


      string
      <uuid>

required

ID of the payment method. Can be one of walletID, cardID, or bankAccountID.

Response

application/json

A method of moving money

Wallet Bank account Card Apple Pay

A method of moving money that is a Moov wallet

paymentMethodID


        string<uuid>

<=36 characters

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

UUID v4

A method of moving money that is a bank account

paymentMethodID


        string<uuid>

<=36 characters

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

UUID v4

bankAccountType


        string<enum>

The bank account type.

Possible values: checking, savings, general-ledger, loan

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.

Codes:

R02 - Account Closed
R03 - No Account/Unable to Locate Account
R04 - Invalid Account Number
R05 - Improper Debit to Consumer Account
R07 - Authorization Revoked by Customer
R08 - Payment Stopped
R10 - Customer Advises Originator is Not Known or Authorized to Receiver and
R11 - Customer Advises Entry Not in Accordance with the Terms of the Authorization
R12 - Branch Sold to Another DFI
R13 - RDFI not qualified to participate
R14 - Representative payee deceased or unable to continue in that capacity
R15 - Beneficiary or bank account holder
R16 - Bank account frozen
R17 - Entry with Invalid Account Number Initiated Under Questionable Circumstances
R20 - Non-payment bank account
R23 - Credit entry refused by receiver
R29 - Corporate customer advises not authorized
R34 - Limited participation RDFI
R38 - Stop Payment on Source Document (Adjustment Entry)
R39 - Improper Source Document

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.

Codes:

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

Possible values: AC03, AC04, AC06, AC14, AG01, AG03, MD07

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

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-attempts-exceeded, verification-expired, 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

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

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 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