PaymentInstrument class abstract

PaymentInstrument

Properties:

  • additionalBankAccountIdentifications - Contains optional, additional business account details. Returned when you create a payment instrument with type bankAccount.
  • balanceAccountId - The unique identifier of the balance account associated with the payment instrument.
  • bankAccount - Contains the business account details. Returned when you create a payment instrument with type bankAccount.
  • card - Contains information about the card payment instrument. Returned when you create a payment instrument with type card.
  • description - Your description for the payment instrument, maximum 300 characters.
  • id - The unique identifier of the payment instrument.
  • issuingCountryCode - The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.
  • paymentInstrumentGroupId - The unique identifier of the payment instrument group to which the payment instrument belongs.
  • reference - Your reference for the payment instrument, maximum 150 characters.
  • replacedById - The unique identifier of the payment instrument that replaced this payment instrument.
  • replacementOfId - The unique identifier of the payment instrument that is replaced by this payment instrument.
  • status - The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to active by default. However, there can be exceptions for cards based on the card.formFactor and the issuingCountryCode. For example, when issuing physical cards in the US, the default status is inactive. Possible values: * active: The payment instrument is active and can be used to make payments. * inactive: The payment instrument is inactive and cannot be used to make payments. * suspended: The payment instrument is suspended, either because it was stolen or lost. * closed: The payment instrument is permanently closed. This action cannot be undone.
  • statusComment - The status comment provides additional information for the statusReason of the payment instrument.
  • statusReason - The reason for the status of the payment instrument. Possible values: accountClosure, damaged, endOfLife, expired, lost, stolen, suspectedFraud, transactionRule, other. If the reason is other, you must also send the statusComment parameter describing the status change.
  • type - The type of payment instrument. Possible values: card, bankAccount.
Annotations
  • @BuiltValue.new()

Constructors

PaymentInstrument([void updates(PaymentInstrumentBuilder b)])
factory

Properties

additionalBankAccountIdentifications → BuiltList<IbanAccountIdentification>?
Contains optional, additional business account details. Returned when you create a payment instrument with type bankAccount.
no setter
balanceAccountId → String
The unique identifier of the balance account associated with the payment instrument.
no setter
bankAccount → BankAccountDetails?
Contains the business account details. Returned when you create a payment instrument with type bankAccount.
no setter
card → Card?
Contains information about the card payment instrument. Returned when you create a payment instrument with type card.
no setter
description → String?
Your description for the payment instrument, maximum 300 characters.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
The unique identifier of the payment instrument.
no setter
issuingCountryCode → String
The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.
no setter
paymentInstrumentGroupId → String?
The unique identifier of the payment instrument group to which the payment instrument belongs.
no setter
reference → String?
Your reference for the payment instrument, maximum 150 characters.
no setter
replacedById → String?
The unique identifier of the payment instrument that replaced this payment instrument.
no setter
replacementOfId → String?
The unique identifier of the payment instrument that is replaced by this payment instrument.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → PaymentInstrumentStatusEnum?
The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to active by default. However, there can be exceptions for cards based on the card.formFactor and the issuingCountryCode. For example, when issuing physical cards in the US, the default status is inactive. Possible values: * active: The payment instrument is active and can be used to make payments. * inactive: The payment instrument is inactive and cannot be used to make payments. * suspended: The payment instrument is suspended, either because it was stolen or lost. * closed: The payment instrument is permanently closed. This action cannot be undone.
no setter
statusComment → String?
The status comment provides additional information for the statusReason of the payment instrument.
no setter
statusReason → PaymentInstrumentStatusReasonEnum?
The reason for the status of the payment instrument. Possible values: accountClosure, damaged, endOfLife, expired, lost, stolen, suspectedFraud, transactionRule, other. If the reason is other, you must also send the statusComment parameter describing the status change.
no setter
type → PaymentInstrumentTypeEnum
The type of payment instrument. Possible values: card, bankAccount.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentInstrumentBuilder)) → PaymentInstrument
Rebuilds the instance.
inherited
toBuilder() → PaymentInstrumentBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PaymentInstrument>
no setter