Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 3.07 KB

UpdatePaymentInstrument.md

File metadata and controls

42 lines (31 loc) · 3.07 KB

UpdatePaymentInstrument

Properties

Name Type Description Notes
balanceAccountId kotlin.String The unique identifier of the balance account associated with the payment instrument.
id kotlin.String The unique identifier of the payment instrument.
issuingCountryCode kotlin.String The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.
type inline Type of payment instrument. Possible value: card, bankAccount.
bankAccount PaymentInstrumentBankAccount [optional]
card Card [optional]
description kotlin.String Your description for the payment instrument, maximum 300 characters. [optional]
paymentInstrumentGroupId kotlin.String The unique identifier of the payment instrument group to which the payment instrument belongs. [optional]
reference kotlin.String Your reference for the payment instrument, maximum 150 characters. [optional]
status inline 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. [optional]
statusComment kotlin.String Comment for the status of the payment instrument. Required if `statusReason` is other. [optional]
statusReason inline 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. [optional]

Enum: type

Name Value
type bankAccount, card

Enum: status

Name Value
status active, closed, inactive, suspended

Enum: statusReason

Name Value
statusReason accountClosure, damaged, endOfLife, expired, lost, other, stolen, suspectedFraud, transactionRule