Schema2020-08-27object

payment_method_details_card_present

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

amount_authorized integer

optionalnullable

The authorized amount

brand string

optionalnullable

Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.

maxLength:5000

cardholder_name string

optionalnullable

The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

maxLength:5000

country string

optionalnullable

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

maxLength:5000

emv_auth_data string

optionalnullable

Authorization response cryptogram.

maxLength:5000

exp_month integer

required

Two-digit number representing the card's expiration month.

exp_year integer

required

Four-digit number representing the card's expiration year.

fingerprint string

optionalnullable

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*

maxLength:5000

funding string

optionalnullable

Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

maxLength:5000

generated_card string

optionalnullable

ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.

maxLength:5000

last4 string

optionalnullable

The last four digits of the card.

maxLength:5000

network string

optionalnullable

Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.

maxLength:5000

overcapture_supported boolean

optionalnullable

Defines whether the authorized amount can be over-captured or not

read_method string

optionalnullable

How card details were read in this transaction.

Allowed: "contact_emv""contactless_emv""contactless_magstripe_mode""magnetic_stripe_fallback""magnetic_stripe_track2"

receipt

optionalnullable

A collection of fields required to be displayed on receipts. Only required for EMV transactions.

Root JSON Schema

{"properties":{"amount_authorized":{"description":"The authorized amount","nullable":true,"type":"integer"},"brand":{"description":"Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","maxLength":5000,"nullable":true,"type":"string"},"cardholder_name":{"description":"The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.","maxLength":5000,"nullable":true,"type":"string"},"country":{"description":"Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.","maxLength":5000,"nullable":true,"type":"string"},"emv_auth_data":{"description":"Authorization response cryptogram.","maxLength":5000,"nullable":true,"type":"string"},"exp_month":{"description":"Two-digit number representing the card's expiration month.","type":"integer"},"exp_year":{"description":"Four-digit number representing the card's expiration year.","type":"integer"},"fingerprint":{"description":"Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*","maxLength":5000,"nullable":true,"type":"string"},"funding":{"description":"Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.","maxLength":5000,"nullable":true,"type":"string"},"generated_card":{"description":"ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.","maxLength":5000,"nullable":true,"type":"string"},"last4":{"description":"The last four digits of the card.","maxLength":5000,"nullable":true,"type":"string"},"network":{"description":"Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.","maxLength":5000,"nullable":true,"type":"string"},"overcapture_supported":{"description":"Defines whether the authorized amount can be over-captured or not","nullable":true,"type":"boolean"},"read_method":{"description":"How card details were read in this transaction.","enum":["contact_emv","contactless_emv","contactless_magstripe_mode","magnetic_stripe_fallback","magnetic_stripe_track2"],"nullable":true,"type":"string"},"receipt":{"anyOf":[{"$ref":"#/components/schemas/payment_method_details_card_present_receipt"}],"description":"A collection of fields required to be displayed on receipts. Only required for EMV transactions.","nullable":true}},"required":["exp_month","exp_year"],"title":"payment_method_details_card_present","type":"object","x-expandableFields":["receipt"]}