Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 2.01 KB

PaymentInstrumentUpdateRequest.md

File metadata and controls

28 lines (19 loc) · 2.01 KB

PaymentInstrumentUpdateRequest

Properties

Name Type Description Notes
balanceAccountId kotlin.String The unique identifier of the balance account associated with this payment instrument. >You can only change the balance account ID if the payment instrument has inactive status. [optional]
card CardInfo [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 updating the status of the payment instrument. Possible values: lost, stolen, damaged, suspectedFraud, expired, endOfLife, accountClosure, other. If the reason is other, you must also send the `statusComment` parameter describing the status change. [optional]

Enum: status

Name Value
status active, closed, inactive, suspended

Enum: statusReason

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