Update a payment instrument

patch/paymentInstruments/{id}

Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with inactive status, you can still update the balance account associated with the card.

Endpoint destination URL

https://balanceplatform-api-test.adyen.com/bcl/v1/paymentInstruments/{id}

Path Parameters

Required

Optional

The unique identifier of the payment instrument.

Request Parameters

Required

Optional

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 Requested or Inactive status.

Object that contains information about the card payment instrument.

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 brand of the physical or the virtual card. Possible values: visa, mc.

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.

Max length: 26

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

Contains information about the configuration profile for your cards. The configuration profile consists of settings required when creating a physical or a virtual card. You identify a configuration profile with its configurationProfileId.

When you provide this field in a request, you can override the settings of an existing configuration profile.

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

The activation label attached to the card that contains the activation instructions.

This field overrides the activation label design ID defined in the card configuration profile.

Max length: 255

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.

Overrides the shipment bulk address defined in the card configuration profile.

The unique identifier of the card image. This image is printed on the full front of the card.

The letter or packaging to which the card is attached.

This field overrides the carrier design ID defined in the card configuration profile.

The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.

The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment.

You can override some of the existing settings in the configuration profile by providing the corresponding fields in the configuration object. For example, send the shipmentMethod to override the logistics company defined in the card configuration profile.

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

This field overrides the existing currency setting on the card configuration profile.

Overrides the envelope design ID defined in the card configuration profile.

Any additional material, such as marketing material, that is shipped together with the card.

This field overrides the insert design ID defined in the card configuration profile.

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

The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.

The letter on which the PIN of the card is printed.

This field overrides the PIN mailer design ID defined in the card configuration profile.

Print Line.

Text printed on the physical card below the cardholder name. You provide the value, which can be up to 26 characters.

The logistics company that ships the card.

This field overrides the logistics company defined in the card configuration profile.

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

The address of the contact.

The e-mail address of the contact.

The 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 name of the contact.

Personal data of the contact.

The phone number of the contact.

The URL of the website of the contact.

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

The 3DS configuration of the physical or the virtual card. Possible values: fullySupported, secureCorporate.

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

Specifies how many times the card can be used. Possible values: singleUse, multiUse.

Reach out to your Adyen contact to determine the value relevant for your integration.

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 Requested.

Possible values:

Active: The payment instrument is active and can be used to make payments.
Requested: The payment instrument has been requested. This state is applicable for physical cards.
Inactive: The payment instrument is inactive and cannot be used to make payments.
Suspended: The payment instrument is temporarily suspended and cannot be used to make payments.
Closed: The payment instrument is permanently closed. This action cannot be undone.
Stolen
Lost

Comment for the status of the payment instrument.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
additionalBankAccountIdentificationsarray
Contains optional, additional business account details. Returned when you create a payment instrument with type bankAccount.
balanceAccountIdstring
The unique identifier of the balance account associated with the payment instrument.
bankAccountobject
Contains the business account details. Returned when you create a payment instrument with type bankAccount.
accountNumberstring
The bank account number, without separators or whitespace.
accountTypestring
The bank account type.

Possible values: checking or savings. Defaults to checking.
branchNumberstring
The bank account branch number, without separators or whitespace
formFactorstring
Business accounts with a formFactor value of physical are business accounts issued under the central bank of that country. The default value is physical for NL, US, and UK business accounts.

Adyen creates a local IBAN for business accounts when the formFactor value is set to virtual. The local IBANs that are supported are for DE and FR, which reference a physical NL account, with funds being routed through the central bank of NL.
ibanstring
The international bank account number as defined in the ISO-13616 standard.
routingNumberstring
The routing number, without separators or whitespace.
sortCodestring
The sort code, without separators or whitespace.
typestring
iban or usLocal or ukLocal
cardobject
Contains information about the card payment instrument. Returned when you create a payment instrument with type card.
authenticationobject
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.
emailstring
The email address where the one-time password (OTP) is sent.
passwordstring
Min length: 1Max length: 30
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: äöüßÄÖÜ+-*/ç%()=?!~#'",;:$&àùòâôûáúó

phoneobject
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.

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

or "(0031) 611223344".
typestring
Type of phone number. Possible values: Landline, Mobile.

binstring
The bank identification number (BIN) of the card number.
brandstring
The brand of the physical or the virtual card. Possible values: visa, mc.
brandVariantstring
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.

cardholderNamestring
Max length: 26
The name of the cardholder. Maximum length: 26 characters.
configurationobject
Contains information about the configuration profile for your cards. The configuration profile consists of settings required when creating a physical or a virtual card. You identify a configuration profile with its configurationProfileId.

When you provide this field in a request, you can override the settings of an existing configuration profile.

Reach out to your Adyen contact to get the values that you can send in this object.
activationstring
The activation label attached to the card that contains the activation instructions.

This field overrides the activation label design ID defined in the card configuration profile.
activationUrlstring
Max length: 255
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.
bulkAddressobject
Overrides the shipment bulk address defined in the card configuration profile.
citystring
The name of the city.
companystring
The name of the company.
countrystring
The two-character ISO-3166-1 alpha-2 country code. For example, US.
emailstring
The email address.
houseNumberOrNamestring
The house number or name.
mobilestring
The full telephone number.
postalCodestring
The postal code.

Maximum length:

5 digits for addresses in the US.

10 characters for all other countries.

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

Maximum length: 2 characters for addresses in the US.
streetstring
The streetname of the house.
cardImageIdstring
The unique identifier of the card image. This image is printed on the full front of the card.
carrierstring
The letter or packaging to which the card is attached.

This field overrides the carrier design ID defined in the card configuration profile.
carrierImageIdstring
The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.
configurationProfileIdstring
The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment.

You can override some of the existing settings in the configuration profile by providing the corresponding fields in the configuration object. For example, send the shipmentMethod to override the logistics company defined in the card configuration profile.
currencystring
The three-letter ISO-4217 currency code of the card. For example, EUR.

This field overrides the existing currency setting on the card configuration profile.
envelopestring
Overrides the envelope design ID defined in the card configuration profile.
insertstring
Any additional material, such as marketing material, that is shipped together with the card.

This field overrides the insert design ID defined in the card configuration profile.
languagestring
The two-letter ISO-639-1 language code of the card. For example, en.
logoImageIdstring
The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.
pinMailerstring
The letter on which the PIN of the card is printed.

This field overrides the PIN mailer design ID defined in the card configuration profile.
printLinestring
Print Line.

Text printed on the physical card below the cardholder name. You provide the value, which can be up to 26 characters.
shipmentMethodstring
The logistics company that ships the card.

This field overrides the logistics company defined in the card configuration profile.
cvcstring
The CVC2 value of the card.

The CVC2 is not sent by default. This is only returned in the POST response for single-use virtual cards.

deliveryContactobject
The delivery contact (name and address) for physical card delivery.
addressobject
The address of the contact.
citystring
Max length: 3000
The name of the city. Maximum length: 3000 characters.
countrystring
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.

houseNumberOrNamestring
Max length: 3000
The number or name of the house. Maximum length: 3000 characters.
postalCodestring
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
stateOrProvincestring
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.

Required for the US and Canada.

streetstring
Max length: 3000
The name of the street. Maximum length: 3000 characters.

The house number should not be included in this field; it should be separately provided via houseNumberOrName.

emailstring
The e-mail address of the contact.
fullPhoneNumberstring
The 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"
nameobject
The name of the contact.
firstNamestring
Max length: 80
The first name.
lastNamestring
Max length: 80
The last name.
personalDataobject
Personal data of the contact.
dateOfBirthstring
The date of birth of the person. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).
idNumberstring
An ID number of the person.
nationalitystring
Min length: 2Max length: 2
The nationality of the person represented by a two-character country code.

The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').

phoneNumberobject
The phone number of the contact.
phoneCountryCodestring
The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, US or NL.
phoneNumberstring
The phone number. The inclusion of the phone number country code is not necessary.
phoneTypestring
The type of the phone number. Possible values: Landline, Mobile, SIP, Fax.
webAddressstring
The URL of the website of the contact.
expirationobject
The expiration date of the card.
monthstring
The month in which the card will expire.
yearstring
The year in which the card will expire.
formFactorstring
The form factor of the card. Possible values: virtual, physical.
lastFourstring
Last last four digits of the card number.
numberstring
The primary account number (PAN) of the card.

The PAN is masked by default and returned only for single-use virtual cards.

threeDSecurestring
The 3DS configuration of the physical or the virtual card. Possible values: fullySupported, secureCorporate.

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

usagestring
Specifies how many times the card can be used. Possible values: singleUse, multiUse.

Reach out to your Adyen contact to determine the value relevant for your integration.

descriptionstring
Max length: 300
Your description for the payment instrument, maximum 300 characters.
idstring
The unique identifier of the payment instrument.
issuingCountryCodestring
The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.
paymentInstrumentGroupIdstring
The unique identifier of the payment instrument group to which the payment instrument belongs.
referencestring
Max length: 150
Your reference for the payment instrument, maximum 150 characters.
replacedByIdstring
The unique identifier of the payment instrument that replaced this payment instrument.
replacementOfIdstring
The unique identifier of the payment instrument that is replaced by this payment instrument.
statusstring
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 Requested.

Possible values:

Active: The payment instrument is active and can be used to make payments.

Requested: The payment instrument has been requested. This state is applicable for physical cards.

Inactive: The payment instrument is inactive and cannot be used to make payments.

Suspended: The payment instrument is temporarily suspended and cannot be used to make payments.

Closed: The payment instrument is permanently closed. This action cannot be undone.

Stolen

Lost

statusCommentstring
Comment for the status of the payment instrument.
typestring
The type of payment instrument.

Possible values: card, bankAccount.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Update a payment instrument

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error