Adyen · Schema
UpdatePaymentInstrument
UpdatePaymentInstrument schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| balanceAccountId | string | The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. |
| bankAccount | object | Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**. |
| card | object | Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**. |
| description | string | Your description for the payment instrument, maximum 300 characters. |
| id | string | The unique identifier of the payment instrument. |
| issuingCountryCode | string | The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. |
| paymentInstrumentGroupId | string | The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. |
| reference | string | Your reference for the payment instrument, maximum 150 characters. |
| status | string | 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 |
| statusComment | string | Comment for the status of the payment instrument. Required if `statusReason` is **other**. |
| statusReason | string | The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **othe |
| type | string | Type of payment instrument. Possible value: **card**, **bankAccount**. |