Skip to main content
PATCH
Partially Update Card

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-audit-user
string

Optional audit user header

Path Parameters

id
string<uuid>
required

Unique identifier of the card that you want to update.

Body

application/json

Details of the card that you want to update.

chipEnabled
boolean

Whether the card should be visible in card terminal or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.

Example:

true

digitalLayoutCode
string

The digital layout code for the card. Max character limit is 36.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9-]+$
Example:

9

applicationName
string

Name of the application. Max character limit is 16. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.

Required string length: 1 - 16
Pattern: ^[a-zA-Z ]+$
Example:

"Credit Application"

contactPriorityLevel
integer<int32>

The contact priority level for given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.

Required range: x >= 0
contactlessPriorityLevel
integer<int32>

The contactless priority level of the given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.

Required range: x >= 0
printed
boolean

Indicates whether the specific card would be printed or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.

Example:

true

cardholderId
string<uuid>

Unique identifier of a resource.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

accountId
string

Unique identifier of an account.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9-]+$
Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"

automaticRenewal
boolean

A flag indicating whether automatic renewal is enabled or not.

plastic
object
cardStatus
enum<string>
  • ACTIVE - Card is active and is enabled for normal usage.
  • BLOCKED - Card is temporarily blocked.
  • BLOCKED_SUSPECTED_FRAUD - Card is temporarily blocked due to suspected fraud.
  • CLOSED_DUE_TO_FRAUD - Card has been closed due to fraud.
  • CLOSED_LOST - Card has been closed due to being lost.
  • CLOSED_STOLEN - Card has been closed due to being stolen.
  • CLOSED - Card has been manually closed.
  • CLOSED_EXPIRED - Card has no active or initial card versions and cannot be used.
Available options:
ACTIVE,
BLOCKED,
BLOCKED_SUSPECTED_FRAUD,
CLOSED_DUE_TO_FRAUD,
CLOSED_LOST,
CLOSED_STOLEN,
CLOSED,
CLOSED_EXPIRED
Example:

"ACTIVE"

impactTokenStatus
boolean
default:true

If set to true, the card status change will impact the status of all tokens. If set to false, the card status change will not impact the status of all tokens.

pinStatus
enum<string>
  • GENERATED - A pin should be randomly generated for the card.
Available options:
GENERATED
Example:

"GENERATED"

additionalValues
object

You can include up to 30 additional key-value pairs in the embossing file sent to the card manufacturer.

  • Keys must follow the pattern: ^[a-zA-Z0-9-]{1,36}$ (only letters, numbers, and hyphens, with a maximum length of 36 characters).
  • Values must follow the pattern: ^[a-zA-Z0-9|\-_ +.@éàèùçâêîôûëïü'/=]{1,1000}$.

Enfuce does not perform any additional validation on these key-value pairs beyond ensuring they match the specified patterns.

These fields are intended for storing data without further processing. If you need to store a complex structure, you can base64 encode the value. The encoded value will be passed as entered, without modifications.

Important: Any usage of these fields should be agreed upon with the manufacturer.

Example:
feeConfigId
string | null

Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.

Required string length: 1 - 36
Pattern: ^[a-zA-Z0-9_-]+$
Example:

"SILVER"

Response

Successful update of the card.

description
string

A description of the response returned.

id
string<uuid>

A unique identifier assigned to identify the endpoint request.

Example:

"20218aae-b15e-406c-9e9f-23735cd86a48"