Bulk Card Lifecycle v1

Bulk Card Lifecycle is available through debiX BULK. This use case enables issuers to trigger bulk card lifecycle messages.

Currently, the messages OrderCard and DeleteCard are supported. Each message is wrapped in an envelope providing metadata such as API version and payload type. A subset of the metadata must also be provided as JMS properties.

JSON Schema

Message Envelope

message-envelope.json

message-envelope.json

Payload

The payload must be delivered as a stringified JSON inside the envelope. The payload type is defined below.

Order Card

The issuer can trigger bulk card orders for physical or virtual cards.

Erroneous orders must be reversed via the debiX API by calling POST /api/debix/bank/cardtoken/v2/cards/{cardToken}/reverse-order or POST /api/debix/bank/v2/cards/reverse-order.

order-card-payload.json

order-card-payload.json

Delete Card

delete-card-payload.json

delete-card-payload.json

Other Definitions

Common Definitions

common-definitions.json

common-definitions.json

JMS Properties

A subset of the metadata provided in the envelope must also be set as JMS Properties, mainly to facilitate message deserialization. The required JMS properties are:

• correlationId
• bulkMessageType
• bulkMessageApiVersion

Schematic Example