PATCH /paymentInstruments/{id}

The unique identifier of the payment instrument.

Default value: "application/json"

Comment for the status of the payment instrument.

Required if statusReason is other.

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.

Possible values:

• "inactive"
• "active"
• "suspended"
• "closed"

Object that contains information about the card payment instrument.

The delivery contact (name and address) for physical card delivery.

The email address of the contact.

The name of the contact.

The last name.

The first name.

The URL of the contact's website.

The company name of the contact.

The phone number of the contact.

The type of the phone number. Possible values: Landline, Mobile, SIP, Fax.

Possible values:

• "Mobile"
• "Fax"
• "Landline"
• "SIP"

The phone number. The inclusion of the phone number country code is not necessary.

The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, US or NL.

The full phone number of the contact provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"

The address of the contact.

The number of the building.

For example, if the address is Simon Carmiggeltstraat 6-50, provide 6-50.

The name of the street. Do not include the number of the building.

For example, if the address is Simon Carmiggeltstraat 6-50, provide Simon Carmiggeltstraat.

The postal code. Maximum length:

• 5 digits for an address in the US.
• 10 characters for an address in all other countries.

Additional information about the delivery address.

The two-letter ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

If you don't know the country or are not collecting the country from the shopper, provide country as ZZ.

The name of the city.

The brand of the physical or the virtual card. Possible values: visa, mc.

Settings required when creating a physical or a virtual card.

Reach out to your Adyen contact to get the values that you can send in this object.

Overrides the activation label design ID defined in the configurationProfileId. The activation label is attached to the card and contains the activation instructions.

The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.

The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them.

For example, send the shipmentMethod to override the logistics company defined in the card configuration profile.

Overrides the carrier design ID defined in the configurationProfileId. The carrier is the letter or packaging to which the card is attached.

Overrides the envelope design ID defined in the configurationProfileId.

Overrides the PIN mailer design ID defined in the configurationProfileId. The PIN mailer is the letter on which the PIN is printed.

Your app's URL, if you want to activate cards through your app. For example, my-app://ref1236a7d. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process.

Maximum length: 255 characters.

The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.

The three-letter ISO-4217 currency code of the card. For example, EUR.

The ID of the card image. This is the image that will be printed on the full front of the card.

Overrides the logistics company defined in the configurationProfileId.

Overrides the shipment bulk address defined in the configurationProfileId.

The postal code.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The email address.

The name of the company.

The two-letter ISO 3166-2 state or province code.

Maximum length: 2 characters for addresses in the US.

The two-character ISO-3166-1 alpha-2 country code. For example, US.

The house number or name.

The full telephone number.

The streetname of the house.

The name of the city.

Overrides the insert design ID defined in the configurationProfileId. An insert is any additional material, such as marketing materials, that are shipped together with the card.

The two-letter ISO-639-1 language code of the card. For example, en.

Allocates a specific product range for either a physical or a virtual card. Possible values: fullySupported, secureCorporate.

Reach out to your Adyen contact to get the values relevant for your integration.

Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to 3D Secure and digital wallets for more information.

The email address where the one-time password (OTP) is sent.

The phone number where the one-time password (OTP) is sent.

This object must have:

• A type set to mobile.

• A number with a valid country code.

• A number with more than 4 digits, excluding the country code.

Make sure to verify that the card user owns the phone number.

The full phone number provided as a single string. For example, "0031 6 11 22 33 44", "+316/1122-3344",

or "(0031) 611223344".

Type of phone number. Possible values: Landline, Mobile.

Possible values:

• "mobile"
• "landline"

The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters.

• Characters between a-z, A-Z, and 0-9

• Special characters: äöüßÄÖÜ+-*/ç%()=?!~#'",;:$&àùòâôûáúó

The brand variant of the physical or the virtual card. For example, visadebit or mcprepaid.

Reach out to your Adyen contact to get the values relevant for your integration.

The name of the cardholder. Maximum length: 26 characters.

The form factor of the card. Possible values: virtual, physical.

Possible values:

• "physical"
• "virtual"
• "unknown"

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.

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.

Possible values:

• "suspectedFraud"
• "other"
• "lost"
• "accountClosure"
• "endOfLife"
• "transactionRule"
• "expired"
• "stolen"
• "damaged"