Interface CardPaymentInstrument

Card Payment Instrument.

interface CardPaymentInstrument {
    bankName?: string;
    cardHolderName?: string;
    cardScheme: CardScheme;
    creationTime: string;
    customerId?: string;
    cvv?: string;
    description?: string;
    expiryDate: CardExpiryDate;
    id?: string;
    instrumentType: InstrumentType;
    pan: string;
    status?: PaymentInstrumentStatus;
}

Hierarchy (view full)

Properties

bankName? cardHolderName? cardScheme creationTime customerId? cvv? description? expiryDate id? instrumentType pan status?

Properties

Optional bankName

bankName?: string

The bank name.

Optional cardHolderName

cardHolderName?: string

Card holder name.

cardScheme

cardScheme: CardScheme

Represents the card scheme information. The scheme is derived from the card PAN.

creationTime

creationTime: string

Creation time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2021-07-15T17:54:12Z"

Optional customerId

customerId?: string

The customer to which this instrument belongs.

Optional cvv

cvv?: string

Deprecated

Never returned.

Card verification value. (CVV)

Optional description

description?: string

Name to be associated with the card.

expiryDate

expiryDate: CardExpiryDate

Card expiry date.

Optional id

id?: string

The instrument id.

instrumentType

instrumentType: InstrumentType

The instrument type.

pan

pan: string

Card number.

Optional status

status?: PaymentInstrumentStatus

The instrument status.

Settings

Member Visibility

Theme

On This Page

bankNamecardHolderNamecardSchemecreationTimecustomerIdcvvdescriptionexpiryDateidinstrumentTypepanstatus