Get a payment instrument

get/paymentInstruments/{id}

API Version

Returns the details of a payment instrument.

Endpoint destination URL

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

Path Parameters

Required

Optional

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.
additionalBankAccountIdentificationsarrayDeprecated in version 2
Please use bankAccount object instead
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
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.
activationstring
Overrides the activation label design ID defined in the configurationProfileId. The activation label is attached to the card and contains the activation instructions.
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 configurationProfileId.
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 ID of the card image. This is the image that will be printed on the full front of the card.
carrierstring
Overrides the carrier design ID defined in the configurationProfileId. The carrier is the letter or packaging to which the card is attached.
carrierImageIdstring
The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
configurationProfileIdstring
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.
currencystring
The three-letter ISO-4217 currency code of the card. For example, EUR.
envelopestring
Overrides the envelope design ID defined in the configurationProfileId.
insertstring
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.
languagestring
The two-letter ISO-639-1 language code of the card. For example, en.
logoImageIdstring
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.
pinMailerstring
Overrides the PIN mailer design ID defined in the configurationProfileId. The PIN mailer is the letter on which the PIN is printed.
shipmentMethodstring
Overrides the logistics company defined in the configurationProfileId.
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
The name of the city.
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.

line1string
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.
line2string
The number of the building.

For example, if the address is Simon Carmiggeltstraat 6-50, provide 6-50.
line3string
Additional information about the delivery address.
postalCodestring
The postal code. Maximum length:

5 digits for an address in the US.

10 characters for an address in all other countries.

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

companystring
The company name of the contact.
emailstring
The email address of the contact.
fullPhoneNumberstring
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"
nameobject
The name of the contact.
firstNamestring
Max length: 80
The first name.
lastNamestring
Max length: 80
The last name.
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 contact's website.
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
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.

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

statusCommentstring
The status comment provides additional information for the statusReason of the payment instrument.
statusReasonstring
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.
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.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
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.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
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.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
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.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
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.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
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.

Get a payment instrument

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error