Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Update card

Update a fleet card

This operation will update given fields given a card id

patch/v4/{fleetTemplate}/{id}

Path parameters

fleetTemplate'D_CARD' | 'FLEET_CARD' | 'FLEET_CARD2' | 'FLEET_CARD3' | 'FLEET_CARD4' required

Specific fleet template

idstring biginteger required

The card id for given card

Query parameters

auditUserstring required

The audit user to log the request

Request body

accountIdstring

The account id card is linked to

customerIdstring

The customer id card is linked to

reasonstring

Reason for contract status change

segment'SEGMENT_A' | 'SEGMENT_B' | 'SEGMENT_C' | 'SEGMENT_D' | 'SEGMENT_E' | 'SEGMENT_F'

Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API

status'CARD_OK' | 'CARD_BLOCKED' | 'SUSPECTED_FRAUD' | 'CARD_CLOSED_DUE_TO_FRAUD' | 'CARD_NO_RENEWAL' | 'CARD_LOST' | 'CARD_STOLEN' | 'CARD_CLOSED'
pinStatus'D' | 'W' | 'S'

This flag will indicate current status for PIN generation. If not specified system will automatically assign D as default and make sure a PIN is calculated during next embossing process. If set to W, then card will be excluded from embossing process until a PIN has been set and status has been updated to S. It is also possible to revert to D, in order for system to generate PIN. Note that system will update to status S automatically when a PIN is set successfully.

New card

In order for a new card to not get a system generated PIN then pinStatus flag must be set to W when created, this will then halt the embossing process for given card until a PIN has been set.

Reissue card

When reissuing a card it is possible to set pinStatus to W in order to hold embossing process for given card until a PIN has been set. Update pinStatus is done on same card id that is reissued.

Replace card

When replacing a card it is possible to set pinStatus to W in order to hold embossing process for given card until a PIN has been set. Update pinStatus is done on new card id that is returned when replacing.

  • D - default and a random PIN will be generated
  • W - waiting for PIN to be manually set
  • S - PIN has been set successfully
digitalLayoutCodestring

Id used for digital wallet artwork and other related assets. Use of this need to be agreed with Enfuce separately

allowedPurchaseCategories'UNRESTRICTED' | 'ALL_FUELS_INCL_VEHICLE_GOODS_AND_SERVICES' | 'ALL_FUELS' | 'RESTRICTED_FUELS' | 'NO_PRODUCTS'
branchIdstring

Field that can be populated in order to group cards together

branchNamestring

Field that can be populated in order to group cards together

extraTerminalInformation'NONE' | 'VEHICLE_ID_AND_ODOMETER' | 'VEHICLE_ID' | 'ODOMETER'

Example request

{
  "accountId": "1234567890",
  "customerId": "1234567890",
  "embossing": {
    "companyName": "Enfuce Financial Services",
    "externalLayoutCode": "BlueCard",
    "firstName": "Monica",
    "lastName": "Liikamaa",
    "additionalEmbossingName": "Card User Name",
    "manufacturer": "FACTORY_X",
    "physical": true
  },
  "usageLimits": [
    {
      "values": [
        {
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200
        }
      ]
    }
  ],
  "digitalLayoutCode": "abc123abc",
  "scheduledClosing": {
    "time": "2099-12-31T03:00:00.000Z"
  },
  "cardAddress": {
    "country": "FIN"
  },
  "pinAddress": {
    "country": "FIN"
  }
}

Response

Successful update of the card

descriptionstring

Short description of the result of the action

idstring

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