ADadyen
Payment instruments

Update a payment instrument

Changed on

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.

patch/paymentInstruments/{id}

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/paymentInstruments/{id}
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

Path parameters

idstring required

The unique identifier of the payment instrument.

Request body

balanceAccountIdstring

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

status'active' | 'closed' | 'inactive' | 'suspended'

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

Comment for the status of the payment instrument.

Required if statusReason is other.

statusReason'accountClosure' | 'damaged' | 'endOfLife' | 'expired' | 'lost' | 'other' | 'stolen' | 'suspectedFraud' | 'transactionRule'

The reason for updating the status of the payment instrument.

Possible values: lost, stolen, damaged, suspectedFraud, expired, endOfLife, accountClosure, other. If the reason is other, you must also send the statusComment parameter describing the status change.

Response

OK - the request has succeeded.

balanceAccountIdstring required

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

descriptionstring

Your description for the payment instrument, maximum 300 characters.

idstring required

The unique identifier of the payment instrument.

issuingCountryCodestring required

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

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.

status'active' | 'closed' | 'inactive' | 'suspended'

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

Comment for the status of the payment instrument.

Required if statusReason is other.

statusReason'accountClosure' | 'damaged' | 'endOfLife' | 'expired' | 'lost' | 'other' | 'stolen' | 'suspectedFraud' | 'transactionRule'

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.

type'bankAccount' | 'card' required

The type of payment instrument.

Possible values: card, bankAccount.

Changes

  • v20ec7e1e654c7Revision changes
    • info

      added discriminator to / response property for the response status

  • v2a4fab1c7333bRevision changes
    • info

      added the new optional request property //

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status