POST /paymentInstruments

Default value: "application/json"

The two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.

The unique identifier of the payment instrument group to which the payment instrument belongs.

Your description for the payment instrument, maximum 300 characters.

The status comment provides additional information for the statusReason of the payment instrument.

Contains the business account details.

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.

Valid values:

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

Default value: "physical"

The type of payment instrument.

Possible values: card, bankAccount.

Valid values:

• "bankAccount"
• "card"

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.

Valid values:

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

Contains information about the card. Required when you create a payment instrument of type card.

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

Valid 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 state or province code, maximum 3 characters. For example, CA for California in the US or ON for Ontario 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.

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.

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 letter or packaging to which the card is attached.

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

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

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.

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 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 three-letter ISO-4217 currency code of the card. For example, EUR.

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

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

The logistics company that ships the card.

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

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

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

Maximum length: 2 characters for addresses in the US.

The streetname of the house.

The name of the city.

Additional information about the delivery address. For example, an apartment number.

The name of the street and the number of the building.

For example: Simon Carmiggeltstraat 6-50.

The postal code.

Maximum length:

• 5 digits for addresses in the US.

• 10 characters for all other countries.

The email address.

The recipient’s name (person or contact), for example ‘John Doe’.

The name of the company.

Additional information about the delivery address.

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

The house number or name.

The full telephone number.

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

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.

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

Valid values:

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

Your reference for the payment instrument, maximum 150 characters.

The unique identifier of the balance account associated with the payment instrument.

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.

Valid values:

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