Returned within the following response objects:
getBin() string

The first 6 digits of the device-specific account number (DPAN), known as the Bank Identification Number. This BIN will differ from the BIN of the underlying card.

getCardType() string

The type of the credit card. Possible values:

  • Apple Pay - Visa
  • Apple Pay - MasterCard
  • Apple Pay - American Express
  • Apple Pay - Discover
getCardholderName() string

The cardholder name associated with the credit card.

getCreatedAt() Calendar

The date/time the object was created.

getCustomerId() string

A string value representing an existing customer in your Vault that owns this payment method. Use this to look up a single customer.

isDefault() boolean

A value indicating whether the specified payment method is the default for the customer.

getExpirationMonth() string

The expiration month of the card, formatted MM.

getExpirationYear() string

The 4-digit year associated with the card, formatted YYYY.

getExpired() boolean

A value indicating whether the credit card has passed its established expiration date.


A URL that points to a payment method image resource (a PNG file) hosted by Braintree.

getLast4() string

The last 4 digits of the device-specific account number (DPAN).

getPaymentInstrumentName() string

A description of the payment method intended for display to the user, typically card type and last 4 digits of the physical card number stored by Wallet (formerly Passbook). We receive this description alongside the DPAN when processing an Apple Pay transaction.

getSourceDescription() string

Indicates what type of payment method was tokenized by the network. Also includes an identifier for the account (e.g. last 4 digits if the payment method was a credit card).

getSubscriptions() Array Subscription

Subscriptions associated with the payment method.

getToken() string

An alphanumeric value that references a specific payment method stored in your Vault.

getUpdatedAt() Calendar

The date/time the object was last updated.