Cards

You can link credit or debit cards to Moov accounts. You can use a card as a source for making transfers, which charges the card.

Get

Retrieves details for the card with the specified ID. The CARDS_READ scope enum is required when making a request from the browser.

1
cards.get(accountID, cardID)

Parameters

Name Type Description
accountID string Account to query
cardID string Card to query

Returns

Promise.<Card>

List

Lists all the cards associated with a particular Moov account. The CARDS_READ scope enum is required when making a request from the browser.

1
cards.list(accountID)

Parameters

Name Type Description
accountID string Account to query

Returns

Promise.<Array.<Card>>

Links a card to a Moov account. Only use this endpoint if you have provided Moov with a copy of your PCI attestation of compliance. The CARDS_WRITE scope enum is required when making a request from the browser.

1
cards.link(accountID, card)

Parameters

Name Type Description
accountID string Account to link
card LinkCard Card information

Returns

Promise.<Card>

Disable

Disables a card with the specified ID. The CARDS_WRITE scope enum is required when making a request from the browser.

1
cards.disable(accountID, cardID)

Parameters

Name Type Description
accountID string Account to query
cardID string Card to query

Returns

Promise.<void>

Types

CardExpiration

Card account expiration date

Properties

Property Type Description
month string 2 character month
year string 2 character year

LinkCard

Card information collected for acquisition.

Properties

Property Type Description
cardNumber string All digits of the card
expiration CardExpiration Card expiration date
cardCvv string 3-4 digit card verification value
holderName string Full name of the card holder
billingAddress CardBillingAddress The billing address of the card

CardBillingAddress

Card billing address

Properties

Property Type Description
addressLine1 string string <= 32 characters
addressLine2 string string <= 32 characters
city string string <= 24 characters
stateOrProvince string string <= 2 characters
postalCode string string <= 5 characters
country string string <= 2 characters

CardVerficationStatuses

Card verification statuses

Properties

Property Type Description
cvv CARD_VERIFICATION_STATUS Verification status of the CVV
addressLine1 CARD_VERIFICATION_STATUS Verification status of addressLine1
postalCode CARD_VERIFICATION_STATUS Verification status of the postalCode

Card

Describes a Card account.

Properties

Property Type Description
cardID string Card account identifier
fingerprint string string <= 100 characters that is a unique fingerprint of a card
brand CARD_BRAND The card brand
cardType CARD_TYPE The type of the card
lastFourCardNumber string Last four digits of the card
bin string The BIN number of the card
expiration CardExpiration The expiration info of the card
holderName string The name of the card holder
billingAddress CardBillingAddress The billing address of the card
cardVerfication CardVerficationStatuses The results of submitting cardholder data to a card network for verification
issuer string The name of the issuer
issuerCountry string The country of the issuer
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "cardID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "fingerprint": "9948962d92a1ce40c9f918cd9ece3a22bde62fb325a2f1fe2e833969de672ba3",
  "brand": "American Express",
  "cardType": "debit",
  "lastFourCardNumber": "1234",
  "bin": "123456",
  "expiration": {
    "month": "01",
    "year": "21"
  },
  "holderName": "Jules Jackson",
  "billingAddress": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 302",
    "city": "Boulder",
    "stateOrProvince": "CO",
    "postalCode": "80301",
    "country": "US"
  },
  "cardVerification": {
    "cvv": "match",
    "addressLine1": "match",
    "postalCode": "match"
  },
  "issuer": "GRINGOTTS BANK",
  "issuerCountry": "US"
}

CardDetails

Properties

Property Type Description
dynamicDescriptor string An optional override of the default card statement descriptor for a transfer. Accounts must be enabled by Moov to set this field.
merchantInitiatedType recurring, unscheduled, null Enum: [recurring unscheduled] Describes how the card transaction was initiated

Enums

CARD_BRAND

Value Description
AMEX American Express
DISCOVER Discover
MC MasterCard
VISA Visa

CARD_TYPE

Value Description
DEBIT Debit card
CREDIT Credit card
PREPAID Prepaid card
UNKNOWN Unknown type

CARD_VERIFICATION_STATUS

Value Description
NO_MATCH No Match
MATCH Match
NOT_CHECKED Not Checked
UNAVAILABLE Unavailable
Summary Beta