Card issuance and personalisation

Create individual, corporate and virtual cards, and check which products a customer is eligible to hold before you issue.

Service that lists the products a customer is eligible for, based on customer number

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/getApplicableProductsByCustomerNumber

Retrieves the list of card products applicable to a specific customer. Filters by main customer number and optional product group. Returns product details including name, number, brand, short name, digital capability, and tenant ID.

Service that lists the products a customer is eligible for, based on customer number › Request Body

GetApplicableProductsByCustomerNumberRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

channel

string | null

Channel - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

object

Filter - [Optional]

Service that lists the products a customer is eligible for, based on customer number › Responses

Success

GetApplicableProductsByCustomerNumberResponse

array | null

List Of Product - [Optional]

POST/debit/api/getApplicableProductsByCustomerNumber

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getApplicableProductsByCustomerNumber \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "filter": {
    "productGroupCode": "productGroupCode"
  }
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "filter": {
    "productGroupCode": "productGroupCode"
  }
}

json

Example Responses

{
  "listOfProduct": [
    {
      "productNumber": "productNumber",
      "productName": "productName",
      "productShortName": "productShortName",
      "brand": "brand",
      "digitalAbility": true,
      "tenantId": "tenantId"
    }
  ]
}

json

application/json

Service for creating a Individual Bank Card

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/createIndividualCard

Creates an individual debit card for a customer, handling product selection, accounts, permissions, digital card flags, addresses, and miscellaneous options. Returns card references, masked and shadow card numbers, warnings, application ID if created asynchronously, and attached account list.

Part of:

Journey 01 · Launching a new card product — step 2, Issue against accounts

Service for creating a Individual Bank Card › Request Body

CreateIndividualCardRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

branchCode

integer · int32 · required

Branch Code - [Optional]

channel

string | null

Channel - [Optional]

productNumber

string | null

Product Number - [Optional]

nameOnCard

string | null

Name On Card - [Optional]

cardDeliveryType

string | null

Card Delivery Type - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

array | null

List Of Account - [Optional]

object

Permissions - [Optional]

object

Card Misc Option - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

applicationContractId

string | null

Application Contract Id - [Optional]

contractType

string | null

Contract Type - [Optional]

contractVersionNumber

string | null

Contract Version Number - [Optional]

Service for creating a Individual Bank Card › Responses

Success

CreateIndividualResponse

recordId

integer | null · int64

Record Id - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

applicationId

integer | null · int64

Application Id - [Optional]

array | null

Attach Account List - [Optional]

POST/debit/api/createIndividualCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createIndividualCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true
  },
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId",
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber"
}'

Example Request Body

{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true
  },
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId",
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber"
}

json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "applicationId": 0,
  "attachAccountList": [
    {
      "accountNumber": 0,
      "accountRecordId": 0
    }
  ]
}

json

application/json

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/createIndividualSupplementaryCard

Create Individual Supplementary Card

Request Body

CreateIndividualSupplementaryCardRequest

customerNumber

integer · int64 · required

Customer Number

branchCode

integer · int32 · required

Branch Code

channel

string | null

Channel

productNumber

string | null

Product Number

shadowCardNumber

string | null

Shadow Card Number

nameOnCard

string | null

Name On Card

cardDeliveryType

string | null

Card Delivery Type

cardSendAddressType

string | null

Card Send Address Type

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code

cardSendAddressId

integer | null · int64

Card Send Address Id

array | null

List Of Account

object

Permissions

object

Card Misc Option

enrollMasterpass

boolean | null

Enroll Masterpass

applicationDate

string | null · date-time

Application Date

applicationContractId

string | null

Application Contract Id

contractType

string | null

Contract Type

contractVersionNumber

string | null

Contract Version Number

Responses

Success

CreateIndividualSupplementaryCardResponse

recordId

integer | null · int64

Record Id

maskedCardNumber

string | null

Masked Card Number

shadowCardNumber

string | null

Shadow Card Number

cardRefNumber

string | null

Card Ref Number

mainCardRefNumber

string | null

Main Card Ref Number

object | null

Warnings

applicationId

integer | null · int64

Application Id

array | null

Attach Account List

POST/debit/api/createIndividualSupplementaryCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createIndividualSupplementaryCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true
  },
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId",
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber"
}'

Example Request Body

{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "cardSendAddressId": 0,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true
  },
  "cardMiscOption": {
    "optionType": "optionType",
    "optionValue": "optionValue"
  },
  "enrollMasterpass": true,
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId",
  "contractType": "contractType",
  "contractVersionNumber": "contractVersionNumber"
}

json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "applicationId": 0,
  "attachAccountList": [
    {
      "accountNumber": 0,
      "accountRecordId": 0
    }
  ]
}

json

application/json

Service for creating a Corporate Bank Card

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/createCorporateCard

Creates a corporate debit card for a customer, handling product selection, accounts, delivery options, permissions, and digital card flags. Returns card references, masked and shadow card numbers, warnings, and application ID if created asynchronously.

Service for creating a Corporate Bank Card › Request Body

CreateCorporateCardRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

branchCode

integer · int32 · required

Branch Code - [Optional]

channel

string | null

Channel - [Optional]

productNumber

string | null

Product Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number

nameOnCard

string | null

Name On Card - [Optional]

secondNameOnCard

string | null

Second Name On Card

cardDeliveryType

string | null

Card Delivery Type - [Optional]

cardSendAddressType

string | null

Card Send Address Type - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code - [Optional]

object

Permissions - [Optional]

array | null

List Of Account - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

applicationContractId

string | null

Application Contract Id - [Optional]

Service for creating a Corporate Bank Card › Responses

Success

CreateCorporateCardResponse

recordId

integer | null · int64

Record Id - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

mainShadowCardNumber

string | null

Main Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

object | null

Warnings - [Optional]

applicationId

integer | null · int64

Application Id - [Optional]

POST/debit/api/createCorporateCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createCorporateCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardSendAddressId": 0,
  "cardDeliveryBranchCode": 0,
  "permissions": {
    "eCommercePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}'

Example Request Body

{
  "channel": "channel",
  "productNumber": "productNumber",
  "customerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "nameOnCard": "nameOnCard",
  "secondNameOnCard": "secondNameOnCard",
  "branchCode": 0,
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardSendAddressId": 0,
  "cardDeliveryBranchCode": 0,
  "permissions": {
    "eCommercePermitted": true
  },
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ],
  "applicationDate": "2024-08-25T15:00:00Z",
  "applicationContractId": "applicationContractId"
}

json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "mainShadowCardNumber": "mainShadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "applicationId": 0
}

json

application/json

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/createDummyCorporateCard

Create Dummy Corporate Card

Request Body

CreateDummyCorporateCardRequest

customerNumber

integer · int64 · required

Customer Number

branchCode

integer · int32 · required

Branch Code

channel

string | null

Channel

productNumber

string | null

Product Number

cardDeliveryType

string | null

Card Delivery Type

cardSendAddressType

string | null

Card Send Address Type

cardDeliveryBranchCode

integer | null · int32

Card Delivery Branch Code

nameOnCard

string | null

Name On Card

applicationDate

string | null · date-time

Application Date

Responses

Success

CreateDummyCorporateCardResponse

cardMasterRecordId

integer · int64 · required

Card Master Record Id

secureCardMasterRecordId

integer · int64 · required

Secure Card Master Record Id

cardRefNumber

string | null

Card Ref Number

mainCardRefNumber

string | null

Main Card Ref Number

shadowCardNumber

string | null

Shadow Card Number

POST/debit/api/createDummyCorporateCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createDummyCorporateCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "customerNumber": 0,
  "productNumber": "productNumber",
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "branchCode": 0,
  "nameOnCard": "nameOnCard",
  "applicationDate": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "channel": "channel",
  "customerNumber": 0,
  "productNumber": "productNumber",
  "cardDeliveryType": "cardDeliveryType",
  "cardSendAddressType": "cardSendAddressType",
  "cardDeliveryBranchCode": 0,
  "branchCode": 0,
  "nameOnCard": "nameOnCard",
  "applicationDate": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardMasterRecordId": 0,
  "secureCardMasterRecordId": 0
}

json

application/json

Service for creating a Virtual Card

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/createVirtualCard

Creates a virtual debit card linked to an existing shadow card, handling accounts and Masterpass enrollment. Returns card references, masked and shadow card numbers, attached accounts, warnings, and sensitive card data including PAN, CVV, and expiry date.

Service for creating a Virtual Card › Request Body

CreateVirtualCardRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

enrollMasterpass

boolean | null

Enroll Masterpass - [Optional]

array | null

List Of Account - [Optional]

Service for creating a Virtual Card › Responses

Success

CreateVirtualCardResponse

recordId

integer · int64 · required

Record Id - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

relatedCardRefNumber

string | null

Related Card Ref Number - [Optional]

object | null

Warnings - [Optional]

object

Sensitive Card Data - [Optional]

array | null

Attach Account List - [Optional]

POST/debit/api/createVirtualCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/createVirtualCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "enrollMasterpass": true,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "enrollMasterpass": true,
  "listOfAccount": [
    {
      "accountType": "accountType",
      "accountNumber": 0,
      "accountOrderFlag": true,
      "currencyCode": "currencyCode",
      "fxAutoConversionFlag": true
    }
  ]
}

json

Example Responses

{
  "recordId": 0,
  "maskedCardNumber": "maskedCardNumber",
  "shadowCardNumber": "shadowCardNumber",
  "cardRefNumber": "cardRefNumber",
  "mainCardRefNumber": "mainCardRefNumber",
  "relatedCardRefNumber": "relatedCardRefNumber",
  "warnings": {
    "key": "string"
  },
  "sensitiveCardData": {
    "pan": "pan",
    "expiryDateStr": "expiryDateStr",
    "cvv": "cvv"
  },
  "attachAccountList": [
    {
      "accountNumber": 0,
      "accountRecordId": 0
    }
  ]
}

json

application/json

Service that lists cards currently in the printing process

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/getPendingCardEmbossList

Retrieves pending embossing information for a debit card using its shadow card number. Returns details including card sequence, emboss and application dates, reason codes and descriptions, emboss status, product type, masked card number, shadow card number, and validity flag.

Service that lists cards currently in the printing process › Request Body

GetPendingCardEmbossListRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists cards currently in the printing process › Responses

Success

GetPendingCardEmbossListResponse

cardSeqNumber

integer | null · int32

Card Seq Number - [Optional]

embossDate

string | null · date-time

Emboss Date - [Optional]

applicationDate

string | null · date-time

Application Date - [Optional]

embossReasonCode

string | null

Emboss Reason Code - [Optional]

embossReasonDescription

string | null

Emboss Reason Description - [Optional]

embossReasonSubCode

string | null

Emboss Reason Sub Code - [Optional]

embossReasonSubDesc

string | null

Emboss Reason Sub Desc - [Optional]

embossStatus

string | null

Emboss Status - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

productTypeCode

string | null

Product Type Code - [Optional]

productTypeDescription

string | null

Product Type Description - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

validFlag

boolean | null

Valid Flag - [Optional]

POST/debit/api/getPendingCardEmbossList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/api/getPendingCardEmbossList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "shadowCardNumber": "shadowCardNumber"
}'

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "cardSeqNumber": 0,
  "embossDate": "2024-08-25T15:00:00Z",
  "applicationDate": "2024-08-25T15:00:00Z",
  "embossReasonCode": "embossReasonCode",
  "embossReasonDescription": "embossReasonDescription",
  "embossReasonSubCode": "embossReasonSubCode",
  "embossReasonSubDesc": "embossReasonSubDesc",
  "embossStatus": "embossStatus",
  "maskedCardNumber": "maskedCardNumber",
  "productTypeCode": "productTypeCode",
  "productTypeDescription": "productTypeDescription",
  "shadowCardNumber": "shadowCardNumber",
  "validFlag": true
}

json

application/json

Service that cancels card issuance based on the Shadow Card Number

POST

https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit

/debit/api/cancelCardEmbossByShadowCardNumber

Cancels the embossing of a debit card using the shadow card number and channel. Logs the operation and validates the request before processing.

Service that cancels card issuance based on the Shadow Card Number › Request Body

CancelCardEmbossByShadowCardNumberRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

channel

string | null

Channel - [Optional]

Service that cancels card issuance based on the Shadow Card Number › Responses

Success

No data returned

Card applications Card lifecycle