| Status name | Description | Authorisations rejected | Clearing transactions posting blocked |
|---|---|---|---|
| Card OK | Card is open and in normal status. Card has to be in this status in order for it to be renewed. | No | No |
| Card Blocked | Temporary block on the card that will prevent approval of authorisations. Can be used instead of account level temporary block if target is to block only a specific card. | Yes | No |
| Suspected Fraud | Temporary block on the card that will prevent approval of authorisations. Functionality the same as for "Card blocked", the different code allows to differentiate between the blocks. | Yes | No |
| Card No Renewal | Status set to prevent following card renewal. Does not affect card functionality in any way, only renewal. | No | No |
| Card Closed Due To Fraud | Used to close a card due to known fraud. | Yes | No |
| Card Lost | Used to close a card because it is lost. | Yes | No |
| Card Stolen | Used to close a card because it is stolen. | Yes | No |
| Card Closed | Used to close card by request from customer or bank, reason for closure is set with status update reason. Allows still clearing transaction posting. | Yes | No |
Endpoints for creating a card
- name: Update card description:Endpoints for updating a card
- name: Get card description: Endpoints for fetching a card - name: Get plastic description: Endpoints for fetching a plastic - name: Update plastic description:Endpoints for updating a plastic
- name: Get application description: Endpoints for fetching an application - name: Update application description:Endpoints for updating an application
paths: /v3/{id}: get: tags: - Get card summary: Get card description: This operation will respond with a card operationId: getCardUsingGET parameters: - name: auditUser in: query description: The audit user to log the request required: true schema: type: string - name: id in: path description: The card id for given card required: true schema: type: string format: biginteger responses: '200': description: Successful lookup of the card content: application/json: schema: $ref: '#/components/schemas/cardV3Response' '401': $ref: '#/components/responses/error401' '403': $ref: '#/components/responses/error403' '404': description: Card does not exist content: application/json: schema: $ref: '#/components/schemas/errorResponse' '500': $ref: '#/components/responses/error500' deprecated: true components: schemas: cardV3Response: allOf: - $ref: '#/components/schemas/listV3CardResponse' - properties: cardAddress: $ref: '#/components/schemas/address' description: Address used to deliver card cardDeliveryType: $ref: '#/components/schemas/cardDeliveryType' cardTemplate: type: string description: Template name for which the card is connected to statusDate: $ref: '#/components/schemas/statusDate' embossing: $ref: '#/components/schemas/embossing' expiration: $ref: '#/components/schemas/expiration' pinAddress: $ref: '#/components/schemas/address' description: Address used to deliver pin pinAttempts: $ref: '#/components/schemas/pinAttempts' pinDeliveryType: $ref: '#/components/schemas/pinDeliveryType' regionAndEcommBlocking: $ref: '#/components/schemas/regionAndEcommBlocking' reason: $ref: '#/components/schemas/reason' description: Reason for card status change segment: $ref: '#/components/schemas/segment' usageLimits: type: array items: $ref: '#/components/schemas/usageLimit' pinStatus: $ref: '#/components/schemas/pinStatus' title: cardV3Response errorResponse: type: object properties: code: type: string description: An error code indicating what kind of error. I.e. HTTP error code message: type: string description: Error message in human-readable format id: type: string format: uuid description: Unique error identifier errorCode: type: string description: Enfuce code for a specific error type errorType: type: string description: Error type enum: - STATIC_VALIDATION_ERROR - DYNAMIC_VALIDATION_ERROR - INTEGRATION_ERROR - SECURITY_ERROR - UNEXPECTED_ERROR errorReason: type: string description: Free-form text explaining the error reason timestamp: type: string format: date-time description: Datetime when error occurred listV3CardResponse: type: object properties: accountId: $ref: '#/components/schemas/accountId' id: $ref: '#/components/schemas/id' customerId: $ref: '#/components/schemas/customerId' cardRole: $ref: '#/components/schemas/cardRole' status: $ref: '#/components/schemas/cardStatus' truncatedCardNumber: type: string title: listV3CardResponse address: type: object required: - address1 - city - country - zipCode properties: address1: type: string minLength: 1 maxLength: 255 example: Kings street 12 address2: type: string maxLength: 255 address3: type: string maxLength: 255 address4: type: string maxLength: 255 city: type: string minLength: 1 maxLength: 255 example: Mariehamn country: $ref: '#/components/schemas/country' region: type: string maxLength: 32 example: Åland Islands zipCode: type: string minLength: 1 maxLength: 32 example: 22100 title: address cardDeliveryType: type: string description: Valid card delivery types in API enum: - CUSTOM_1 - CUSTOM_2 - CUSTOM_3 - CUSTOM_4 - CUSTOM_5 - MAIL - COURIER title: cardDeliveryType statusDate: type: string format: date-time description: Last updated on example: '2020-05-12T13:18:05' embossing: type: object description: > Default set of allowed characters for fields embossed onto the card: A-Z, a-z, Áá, Ää, Åå, Ææ, Éé, Íí, Ðð, Óó, Öö, Øø, Úú, Üü, Ýý, Þþ, 0-9, symbols -/.,&+' and space. For printed cards allowed characters are: (including the above) ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüý þÿĀāĂ㥹ĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹ ĺĻļĽľĿŀŁłŃńŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵ ŶŷŸŹźŻżŽžſǪǫȘșȚțȪȫȮȯȲȳḐḑṢṣẞỌọ Printed or others characters sets must be agreed in advance. properties: additionalField1: type: string description: > Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put. maxLength: 32 additionalField2: type: string description: > Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put. maxLength: 32 additionalField3: type: string description: > Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put. maxLength: 32 additionalField4: type: string description: > Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put. maxLength: 32 additionalField5: type: string description: > Field value is forwarded to embossing house in order to be used as additional embossing lines. In order to use this field selected embossing house must in advance agree where this is put. maxLength: 32 companyName: type: string description: '' maxLength: 26 example: Enfuce Financial Services externalLayoutCode: type: string description: > Code forwarded to embossing house in order to select which plastic layout to use. In order to use this field selected embossing house must in advance agree on name for each layout. maxLength: 32 example: BlueCard firstName: type: string description: > The length of firstName should not exceed 26 characters length. A combined length of firstName and lastName should not exceed 26 characters length. maxLength: 26 example: Monica lastName: type: string description: > The length of lastName should not exceed 26 characters length. A combined length of firstName and lastName should not exceed 26 characters length. maxLength: 26 example: Liikamaa additionalEmbossingName: type: string description: > Optional additional embossing name to be printed on the card as a second line, alongside the primary embossing name. Usage of this field and its placement on the card must be agreed with the relevant card bureau. maxLength: 26 example: Card User Name manufacturer: type: string description: > Name of manufacturer for the card. This has to be agreed in advance with Enfuce in order to support multiple embossing houses. pattern: '[A-Z0-9_\-]{1,32}' example: FACTORY_X physical: type: boolean description: > This tag will indicate will there be a physical representation of the card. If true, the card will be placed for card personalisation and end user will receive a physical plastic. If false, the card will not be placed for card personalisation and end user will not receive a physical plastic. example: true expiration: type: object properties: year: type: integer format: int32 description: Expiration year in format YYYY example: 2019 month: type: integer format: int32 description: Expiration month in format MM example: 1 title: expiration pinAttempts: type: object description: These values refer to online PIN, not offline PIN. properties: counter: type: integer description: Current number of online PIN attempts on card max: type: integer description: Max allowed online PIN attempts on card title: pinAttempts pinDeliveryType: type: string description: Valid pin delivery types in API enum: - CUSTOM_1 - CUSTOM_2 - CUSTOM_3 - CUSTOM_4 - CUSTOM_5 - MAIL - COURIER - EPIN title: pinDeliveryType regionAndEcommBlocking: type: object description: Card ecomm and geo-region blocking properties: ecomm: type: boolean description: Block e-comm usage africa: type: boolean description: Block Africa region asia: type: boolean description: Block Asia region europe: type: boolean description: Block Europe region home: type: boolean description: Block home region northAmerica: type: boolean description: Block North-America region oceania: type: boolean description: Block Oceania region southAmerica: type: boolean description: Block South-America region title: regionAndEcommBlocking reason: type: string description: Reason for contract status change maxLength: 32 title: reason segment: type: string description: >- Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API enum: - SEGMENT_A - SEGMENT_B - SEGMENT_C - SEGMENT_D - SEGMENT_E - SEGMENT_F title: segment usageLimit: type: object allOf: - $ref: '#/components/schemas/baseUsageLimit' - properties: values: type: array items: $ref: '#/components/schemas/limitValues' title: usageLimit pinStatus: type: string description: > 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 enum: - D - W - S accountId: type: string description: The account id card is linked to example: '1234567890' id: type: string description: Unique card id for given card example: '1234567890' customerId: type: string description: The customer id card is linked to example: '1234567890' cardRole: type: string description: > A role needs to be provided for the connection to the account. Role is one way to categorize between primary and supplementary card holders. Role MAIN will always create a card to have same account holder and card holder. For a supplementary card there is a possibility to differ between account and card holder. enum: - MAIN - SUPPLEMENTARY cardStatus: type: string description: > - CARD_OK - Card is open and in normal status. Card has to be in this status in order for it to be renewed - CARD_BLOCKED - Temporary block on the card that will prevent approval of authorisations. Can be used instead of account level temporary block if target is to block only a specific card - SUSPECTED_FRAUD - Temporary block on the card that will prevent approval of authorisations. Functionality the same as for "Card blocked", the different code allows to differentiate between the blocks - CARD_CLOSED_DUE_TO_FRAUD - Used to close a card due to known fraud - CARD_NO_RENEWAL - Status set to prevent following card renewal. Does not affect card functionality in any way, only renewal - CARD_LOST - Used to close a card because it is lost - CARD_STOLEN - Used to close a card because it is stolen - CARD_CLOSED - Used to close card by request from customer or bank, reason for closure is set with status update reason. Allows still clearing transaction posting - CARD_EXPIRED - Final card closure status, that blocks also clearing transaction posting enum: - CARD_OK - CARD_BLOCKED - SUSPECTED_FRAUD - CARD_CLOSED_DUE_TO_FRAUD - CARD_NO_RENEWAL - CARD_LOST - CARD_STOLEN - CARD_CLOSED - CARD_EXPIRED title: cardStatus country: type: string description: >- A valid ISO 3166-1 alpha-3 country code, except for QZZ (UNMIK in Kosovo) and ROM for Romania. pattern: '[A-Z]{3}' example: FIN baseUsageLimit: type: object properties: code: type: string enum: - 24H - DAILY - MONTHLY - WEEKLY - ANNUAL_YEARLY - ROLLING_YEARLY description: | Usage Limiter Time Periods Available usage limiters include: * __24H__ - A sliding window limiter covering the last 24 hours. * __WEEKLY__ - Limits usage for the current week, starting on Monday. * __MONTHLY__ - Limits usage for the current month, starting on the 1st. __Note:__ The following usage limiters are not part of the standard usage limiter setup. The use of these fields and their values depends on the institution's configuration and must be coordinated with Enfuce before use. * __DAILY__ - Limits usage for the current day, starting at 00:00. * __ANNUAL_YEARLY__ - Limits usage for the current year, starting on 1st January. * __ROLLING_YEARLY__ - A sliding window limiter covering the year until now. (DAILY, WEEKLY, MONTHLY and ANNUAL_YEARLY are reset at midnight UTC) title: baseUsageLimit limitValues: type: object properties: code: type: string enum: - ATM - RETAIL - ALL description: > Note that all values must be present when set. Usage limiter values are: * __ATM__ - ATM max withdrawal limit * __RETAIL__ - Retail max purchase limit * __ALL__ - All usage max limit reset: type: boolean description: > If set to true this specific usage limit will be reset to product default and any other values sent in to the request will be ignored. Example: If __usageLimits.values.reset__ = true then all values below will be ignored and the default configuration will apply. usageLimits.values.singleAmount = 1000 usageLimits.values.sumAmount = 1200 usageLimits.values.count = 5 example: true singleAmount: type: number description: | The max allowed amount of a single transaction. Example: Maximum allowed spend per transaction is 1000 usageLimits.values.singleAmount = 1000 usageLimits.values.sumAmount = 0 usageLimits.values.count = 0 example: 1000 count: type: integer description: | The max number of transactions allowed under a time period. Example: Maximum number of allowed transactions under a certain period of time is 5 usageLimits.values.singleAmount = 0 usageLimits.values.sumAmount = 0 usageLimits.values.count = 5 example: 5 sumAmount: type: number description: | The max allowed amount under a time period. Example: Maximum allowed spend under a certain period of time is 1200. usageLimits.values.singleAmount = 0 usageLimits.values.sumAmount = 1200 usageLimits.values.count = 0 example: 1200 title: limitValue responses: error401: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' error403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/errorResponse' error500: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/errorResponse' ````