Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Update plastic

Update plastic

This operation will update a given plastic for a card

post/v3/{id}/plastic/{plasticId}/update/{propertyToUpdate}

Path parameters

idstring biginteger required

The card id for given card

plasticIdstring biginteger required

The plastic id for given plastic

propertyToUpdate'ACTIVATE' | 'CANCEL' required

This operation will update a given plastic for a card. Depending on what property you want to update:

  • ACTIVATE - If a plastic is not automatically active, then it is possible to manually activate it. This setting depends on default configuration
  • CANCEL - If embossing has not been run it is possible to cancel production of a physical card. When this is done the plastic and that id will be deleted and not visible anymore. Note this can only be done as long a plastic is in status INACTIVE.

Cancelling a new card order

When production of physical plastic is cancelled, the cancellation will not affect to the status of the card. So even plastic order is cancelled the status of the card remains the same. If a completely new card is cancelled, then it is important to update card status to Card Closed.

Cancelling a reissued card

When production of physical plastic is cancelled, the cancellation will not affect to the status of the card. Reissue cases there usually isn't a need to change the status of the card if intention is that end user still wants to use the current card.

Query parameters

auditUserstring required

The audit user to log the request

Response

Successful update of plastic

descriptionstring

Short description of the result of the action

idstring

Will contain the ID of the resource that has been created or updated