Pricing Templates
Log in Sign up
Integrations / Adyen Configuration / ...

POST /paymentInstruments

Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.

For more information, refer to Issue cards or Issue business accounts.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
issuingCountryCode String Yes

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

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

Your description for the payment instrument, maximum 300 characters.
statusComment String No

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

Contains the business account details.
bankAccount.formFactor String No

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.

Possible values:

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

Default value: "physical"
type String Yes

The type of payment instrument.

Possible values: card, bankAccount.

Possible values:

  • "bankAccount"
  • "card"
status String No

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"
card Object No

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

The delivery contact (name and address) for physical card delivery.
card.deliveryContact.email String No

The email address of the contact.
card.deliveryContact.name Object Yes

The name of the contact.
card.deliveryContact.name.lastName String Yes

The last name.
card.deliveryContact.name.firstName String Yes

The first name.
card.deliveryContact.webAddress String No

The URL of the contact's website.
card.deliveryContact.company String No

The company name of the contact.
card.deliveryContact.phoneNumber Object No

The phone number of the contact.
card.deliveryContact.phoneNumber.phoneType String No

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

Possible values:

  • "Mobile"
  • "Fax"
  • "Landline"
  • "SIP"
card.deliveryContact.phoneNumber.phoneNumber String No

The phone number. The inclusion of the phone number country code is not necessary.
card.deliveryContact.phoneNumber.phoneCountryCode String No

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

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"
card.deliveryContact.address Object Yes

The address of the contact.
card.deliveryContact.address.line2 String No

The number of the building.

For example, if the address is Simon Carmiggeltstraat 6-50, provide 6-50.
card.deliveryContact.address.line1 String No

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.
card.deliveryContact.address.postalCode String No

The postal code. Maximum length:

  • 5 digits for an address in the US.
  • 10 characters for an address in all other countries.
card.deliveryContact.address.line3 String No

Additional information about the delivery address.
card.deliveryContact.address.stateOrProvince String No

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.
card.deliveryContact.address.country String Yes

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.
card.deliveryContact.address.city String No

The name of the city.
card.brand String Yes

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

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.
card.configuration.activation String No

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

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

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.
card.configuration.carrier String No

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

Overrides the envelope design ID defined in the configurationProfileId.
card.configuration.pinMailer String No

Overrides the PIN mailer design ID defined in the configurationProfileId. The PIN mailer is the letter on which the PIN is printed.
card.configuration.activationUrl String No

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.
card.configuration.logoImageId String No

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.
card.configuration.currency String No

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

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

Overrides the logistics company defined in the configurationProfileId.
card.configuration.bulkAddress Object No

Overrides the shipment bulk address defined in the configurationProfileId.
card.configuration.bulkAddress.postalCode String No

The postal code.

Maximum length:

  • 5 digits for addresses in the US.

  • 10 characters for all other countries.
card.configuration.bulkAddress.email String No

The email address.
card.configuration.bulkAddress.company String No

The name of the company.
card.configuration.bulkAddress.stateOrProvince String No

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

Maximum length: 2 characters for addresses in the US.
card.configuration.bulkAddress.country String Yes

The two-character ISO-3166-1 alpha-2 country code. For example, US.
card.configuration.bulkAddress.houseNumberOrName String No

The house number or name.
card.configuration.bulkAddress.mobile String No

The full telephone number.
card.configuration.bulkAddress.street String No

The streetname of the house.
card.configuration.bulkAddress.city String No

The name of the city.
card.configuration.insert String No

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.
card.configuration.language String No

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

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.
card.authentication Object No

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.
card.authentication.email String No

The email address where the one-time password (OTP) is sent.
card.authentication.phone Object No

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.
card.authentication.phone.number String Yes

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

or "(0031) 611223344".
card.authentication.phone.type String Yes

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

Possible values:

  • "mobile"
  • "landline"
card.authentication.password String No

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: äöüßÄÖÜ+-*/ç%()=?!~#'",;:$&àùòâôûáúó
card.brandVariant String Yes

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.
card.cardholderName String Yes

The name of the cardholder. Maximum length: 26 characters.
card.formFactor String Yes

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

Possible values:

  • "physical"
  • "virtual"
  • "unknown"
reference String No

Your reference for the payment instrument, maximum 150 characters.
balanceAccountId String Yes

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

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.

Possible values:

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2024 SimWorkflow
Terms of Service Privacy Policy