Get a payment instrument
Returns the details of a payment instrument.
Path Parameters
The unique identifier 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.
Show moreShow lessadditionalBankAccountIdentificationsarrayDeprecated in version 2Please use
bankAccount
object insteadContains optional, additional business account details. Returned when you create a payment instrument with
type
bankAccount.balanceAccountIdstringThe unique identifier of the balance account associated with the payment instrument.
bankAccountobjectContains the business account details. Returned when you create a payment instrument with
type
bankAccount.accountNumberstringThe bank account number, without separators or whitespace.
accountTypestringThe bank account type.
Possible values: checking or savings. Defaults to checking.
branchNumberstringThe bank account branch number, without separators or whitespace
formFactorstringBusiness 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.ibanstringThe international bank account number as defined in the ISO-13616 standard.
routingNumberstringThe routing number, without separators or whitespace.
sortCodestringThe sort code, without separators or whitespace.
typestringiban or usLocal or ukLocal
cardobjectContains information about the card payment instrument. Returned when you create a payment instrument with
type
card.authenticationobjectContains 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.
emailstringThe email address where the one-time password (OTP) is sent.
passwordstringMin length: 1Max length: 30The 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: äöüßÄÖÜ+-*/ç%()=?!~#'",;:$&à ùòâôûáúó
phoneobjectThe 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.
numberstringThe full phone number provided as a single string. For example, "0031 6 11 22 33 44", "+316/1122-3344",
or "(0031) 611223344".
typestringType of phone number. Possible values: Landline, Mobile.
binstringThe bank identification number (BIN) of the card number.
brandstringThe brand of the physical or the virtual card. Possible values: visa, mc.
brandVariantstringThe 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.
cardholderNamestringMax length: 26The name of the cardholder. Maximum length: 26 characters.
configurationobjectSettings 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.
activationstringOverrides the activation label design ID defined in the
configurationProfileId
. The activation label is attached to the card and contains the activation instructions.activationUrlstringMax length: 255Your 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.
bulkAddressobjectOverrides the shipment bulk address defined in the
configurationProfileId
.citystringThe name of the city.
companystringThe name of the company.
countrystringThe two-character ISO-3166-1 alpha-2 country code. For example, US.
emailstringThe email address.
houseNumberOrNamestringThe house number or name.
mobilestringThe full telephone number.
postalCodestringThe postal code.
Maximum length:
-
5 digits for addresses in the US.
-
10 characters for all other countries.
stateOrProvincestringThe two-letter ISO 3166-2 state or province code.
Maximum length: 2 characters for addresses in the US.
streetstringThe streetname of the house.
cardImageIdstringThe ID of the card image. This is the image that will be printed on the full front of the card.
carrierstringOverrides the carrier design ID defined in the
configurationProfileId
. The carrier is the letter or packaging to which the card is attached.carrierImageIdstringThe ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
configurationProfileIdstringThe 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.currencystringThe three-letter ISO-4217 currency code of the card. For example, EUR.
envelopestringOverrides the envelope design ID defined in the
configurationProfileId
.insertstringOverrides 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.languagestringThe two-letter ISO-639-1 language code of the card. For example, en.
logoImageIdstringThe 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.
pinMailerstringOverrides the PIN mailer design ID defined in the
configurationProfileId
. The PIN mailer is the letter on which the PIN is printed.shipmentMethodstringOverrides the logistics company defined in the
configurationProfileId
.cvcstringThe 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.deliveryContactobjectThe delivery contact (name and address) for physical card delivery.
addressobjectThe address of the contact.
citystringThe name of the city.
countrystringThe 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
asZZ
.line1stringThe 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.
line2stringThe number of the building.
For example, if the address is Simon Carmiggeltstraat 6-50, provide 6-50.
line3stringAdditional information about the delivery address.
postalCodestringThe postal code. Maximum length:
- 5 digits for an address in the US.
- 10 characters for an address in all other countries.
stateOrProvincestringThe 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.
companystringThe company name of the contact.
emailstringThe email address of the contact.
fullPhoneNumberstringThe 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"
nameobjectThe name of the contact.
firstNamestringMax length: 80The first name.
lastNamestringMax length: 80The last name.
phoneNumberobjectThe phone number of the contact.
phoneCountryCodestringThe two-character ISO-3166-1 alpha-2 country code of the phone number. For example, US or NL.
phoneNumberstringThe phone number. The inclusion of the phone number country code is not necessary.
phoneTypestringThe type of the phone number. Possible values: Landline, Mobile, SIP, Fax.
webAddressstringThe URL of the contact's website.
expirationobjectThe expiration date of the card.
monthstringThe month in which the card will expire.
yearstringThe year in which the card will expire.
formFactorstringThe form factor of the card. Possible values: virtual, physical.
lastFourstringLast last four digits of the card number.
numberstringThe primary account number (PAN) of the card.
The PAN is masked by default and returned only for single-use virtual cards.
threeDSecurestringAllocates 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.
descriptionstringMax length: 300Your description for the payment instrument, maximum 300 characters.
idstringThe unique identifier of the payment instrument.
issuingCountryCodestringThe two-character ISO 3166-1 alpha-2 country code where the payment instrument is issued. For example, NL or US.
paymentInstrumentGroupIdstringThe unique identifier of the payment instrument group to which the payment instrument belongs.
referencestringMax length: 150Your reference for the payment instrument, maximum 150 characters.
statusstringThe 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 theissuingCountryCode
. 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.
statusCommentstringThe status comment provides additional information for the statusReason of the payment instrument.
statusReasonstringThe 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.typestringType of payment instrument.
Possible value: card, bankAccount.
-
400 - Bad Request
A problem reading or understanding the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA 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.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.