Card lifecycle

Move a card through its states after issuance — status changes, replacement, renewal, blocking and closure.

Service that retrieves detailed credit card information based on card data

POST

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

/prepaid/api/getPrepaidCardInfo

Retrieves detailed information about a prepaid card.

Service that retrieves detailed credit card information based on card data › Request Body

GetPrepaidCardInfoRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardNumber

string | null

Card Number - [Optional]

Service that retrieves detailed credit card information based on card data › Responses

Success

GetPrepaidCardInfoResponse

object

Card Info - [Optional]

POST/prepaid/api/getPrepaidCardInfo

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getPrepaidCardInfo \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "cardNumber": "cardNumber"
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "cardNumber": "cardNumber"
}

json

Example Responses

{
  "cardInfo": {
    "shadowCardNumber": "shadowCardNumber",
    "maskedCardNumber": "maskedCardNumber",
    "cardRefNumber": "cardRefNumber",
    "mainCardRefNumber": "mainCardRefNumber",
    "customerNumber": 0,
    "mainCustomerNumber": 0,
    "relatedCardRefNumber": "relatedCardRefNumber",
    "supplementaryCardFlag": true,
    "cardRefCurrentCardFlag": true,
    "branchCode": 0,
    "branchName": "branchName",
    "ownerName": "ownerName",
    "ownerSecondName": "ownerSecondName",
    "ownerSurname": "ownerSurname",
    "embossName": "embossName",
    "productNumber": "productNumber",
    "productSegmentCode": "productSegmentCode",
    "cardStatusCode": "cardStatusCode",
    "cardStatusDscr": "cardStatusDscr",
    "cardStatusReasonCode": "cardStatusReasonCode",
    "cardStatusReasonDscr": "cardStatusReasonDscr",
    "virtualFlag": true,
    "productName": "productName",
    "productShortName": "productShortName",
    "tenantId": "tenantId",
    "emvFlag": true,
    "magneticStripeFlag": true,
    "contactlessFlag": true,
    "rewardEarningFlag": true,
    "cardBrand": "cardBrand",
    "cardBrandDescription": "cardBrandDescription",
    "cardDeliveryType": "cardDeliveryType",
    "expiryDateStr": "expiryDateStr",
    "provisionStatusFlag": true,
    "digitalCardFlag": true,
    "insertDate": "2024-08-25T15:00:00Z",
    "cvv2RetryCount": 0,
    "pinRetryCount": 0,
    "barcode": "barcode",
    "fromShadowCardNumber": "fromShadowCardNumber",
    "toShadowCardNumber": "toShadowCardNumber",
    "requestDate": "2024-08-25T15:00:00Z",
    "requestChannel": "requestChannel",
    "embossReasonCode": "embossReasonCode",
    "embossReasonDescription": "embossReasonDescription",
    "embossReasonSubCode": "embossReasonSubCode",
    "embossReasonSubDesc": "embossReasonSubDesc",
    "cardStatusChangeDate": "2024-08-25T15:00:00Z",
    "firstTrnDate": "2024-08-25T15:00:00Z",
    "lastTrnDate": "2024-08-25T15:00:00Z",
    "firstPinSetDate": "2024-08-25T15:00:00Z",
    "lastPinSetDate": "2024-08-25T15:00:00Z",
    "lastPinChangeDate": "2024-08-25T15:00:00Z",
    "deliveryAddress": "deliveryAddress",
    "isFirstPinSet": "isFirstPinSet",
    "sendingBranchCode": "sendingBranchCode",
    "sendingAddressType": "sendingAddressType",
    "productGroupCode": "productGroupCode",
    "productGroupDescription": "productGroupDescription",
    "fromMaskedCardNumber": "fromMaskedCardNumber",
    "toMaskedCardNumber": "toMaskedCardNumber",
    "disabledFlag": true,
    "sensitiveData": {
      "pan": "pan",
      "cvv2": "cvv2"
    },
    "pendingReplaceApplicationExists": true,
    "pinStatus": "pinStatus",
    "cardStatusChangeChannel": "cardStatusChangeChannel",
    "securityFlag": true,
    "citizenshipNumber": "citizenshipNumber",
    "taxNumber": "taxNumber",
    "customerNameSurname": "customerNameSurname",
    "cardSeqNumber": 0,
    "isDelivered": true
  }
}

json

application/json

Service that updates a card to a renewable status and performs card renewal

POST

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

/prepaid/api/changeAndReplaceCard

Changes and replaces a prepaid card, updating associated data.

Service that updates a card to a renewable status and performs card renewal › Request Body

ChangeAndReplaceCardRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardStatusCode

string | null

Card Status Code - [Optional]

cardStatusReasonCode

string | null

Card Status Reason Code - [Optional]

closeRequestDate

string | null · date-time

Close Request Date - [Optional]

object

Replace Info - [Optional]

Service that updates a card to a renewable status and performs card renewal › Responses

Success

ChangeAndReplaceCardResponse

toStatusActive

boolean · required

To Status Active - [Optional]

object

Replace Result - [Optional]

POST/prepaid/api/changeAndReplaceCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/changeAndReplaceCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "cardStatusCode": "cardStatusCode",
  "cardStatusReasonCode": "cardStatusReasonCode",
  "closeRequestDate": "2024-08-25T15:00:00Z",
  "replaceInfo": {
    "deliveryType": "deliveryType",
    "deliveryAddressType": "deliveryAddressType",
    "deliveryBranchCode": 0,
    "embossName": "embossName",
    "cardEmbossReason": "cardEmbossReason",
    "cardEmbossSubReason": "cardEmbossSubReason",
    "productNumber": "productNumber",
    "permissions": {
      "eCommercePermitted": true,
      "mailOrderPermitted": true,
      "internationalPurchasePermitted": true
    },
    "cardSendAddressId": 0
  }
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "cardStatusCode": "cardStatusCode",
  "cardStatusReasonCode": "cardStatusReasonCode",
  "closeRequestDate": "2024-08-25T15:00:00Z",
  "replaceInfo": {
    "deliveryType": "deliveryType",
    "deliveryAddressType": "deliveryAddressType",
    "deliveryBranchCode": 0,
    "embossName": "embossName",
    "cardEmbossReason": "cardEmbossReason",
    "cardEmbossSubReason": "cardEmbossSubReason",
    "productNumber": "productNumber",
    "permissions": {
      "eCommercePermitted": true,
      "mailOrderPermitted": true,
      "internationalPurchasePermitted": true
    },
    "cardSendAddressId": 0
  }
}

json

Example Responses

{
  "toStatusActive": true,
  "replaceResult": {
    "shadowCardNumber": "shadowCardNumber",
    "newCardGenerated": true,
    "productChanged": true,
    "expiryDate": "2024-08-25T15:00:00Z",
    "cardRefNumber": "cardRefNumber",
    "maskedCardNumber": "maskedCardNumber"
  }
}

json

application/json

Service that allows modifying the card’s status information

POST

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

/prepaid/api/changeCardStatus

Changes the status of a prepaid card.

Service that allows modifying the card’s status information › Request Body

ChangeCardStatusRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardStatusCode

string | null

Card Status Code - [Optional]

cardStatusReasonCode

string | null

Card Status Reason Code - [Optional]

channel

string | null

Channel - [Optional]

closeRequestDate

string | null · date-time

Close Request Date - [Optional]

Service that allows modifying the card’s status information › Responses

Success

ChangeCardStatusResponse

toStatusActive

boolean · required

To Status Active - [Optional]

Card renewal service

POST

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

/prepaid/api/replaceCard

Replaces a prepaid card with a new one.

Card renewal service › Request Body

ReplaceCardRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

embossName

string | null

Emboss Name - [Optional]

deliveryType

string | null

Delivery Type - [Optional]

deliveryAddressType

string | null

Delivery Address Type - [Optional]

deliveryBranchCode

integer | null · int32

Delivery Branch Code - [Optional]

cardEmbossReason

string | null

Card Emboss Reason - [Optional]

cardEmbossSubReason

string | null

Card Emboss Sub Reason - [Optional]

productNumber

string | null

Product Number - [Optional]

instantIssuingFlag

boolean | null

Instant Issuing Flag - [Optional]

embossBranchCode

integer | null · int32

Emboss Branch Code - [Optional]

object

Permissions - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

Card renewal service › Responses

Success

ReplaceCardResponse

newCardGenerated

boolean · required

New Card Generated - [Optional]

productChanged

boolean · required

Product Changed - [Optional]

expiryDate

string · date-time · required

Expiry Date - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

POST/prepaid/api/replaceCard

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/replaceCard \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "embossName": "embossName",
  "deliveryType": "deliveryType",
  "deliveryAddressType": "deliveryAddressType",
  "deliveryBranchCode": 0,
  "cardEmbossReason": "cardEmbossReason",
  "cardEmbossSubReason": "cardEmbossSubReason",
  "productNumber": "productNumber",
  "instantIssuingFlag": true,
  "embossBranchCode": 0,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "cardSendAddressId": 0
}'

Example Request Body

{
  "channel": "channel",
  "shadowCardNumber": "shadowCardNumber",
  "embossName": "embossName",
  "deliveryType": "deliveryType",
  "deliveryAddressType": "deliveryAddressType",
  "deliveryBranchCode": 0,
  "cardEmbossReason": "cardEmbossReason",
  "cardEmbossSubReason": "cardEmbossSubReason",
  "productNumber": "productNumber",
  "instantIssuingFlag": true,
  "embossBranchCode": 0,
  "permissions": {
    "eCommercePermitted": true,
    "mailOrderPermitted": true,
    "internationalPurchasePermitted": true
  },
  "cardSendAddressId": 0
}

json

Example Responses

{
  "shadowCardNumber": "shadowCardNumber",
  "newCardGenerated": true,
  "productChanged": true,
  "expiryDate": "2024-08-25T15:00:00Z",
  "cardRefNumber": "cardRefNumber",
  "maskedCardNumber": "maskedCardNumber"
}

json

application/json

Service that lists detailed card information

POST

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

/prepaid/api/getCardList

Retrieves the list of prepaid cards for a customer.

Service that lists detailed card information › Request Body

GetCardListRequest

isCorporateAllCardList

boolean · required

Is Corporate All Card List - [Optional]

customerNumber

integer | null · int64

Customer Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

barcode

string | null

Barcode - [Optional]

cardNumber

string | null

Card Number - [Optional]

purpose

string | null

Purpose - [Optional]

channelCode

string | null

Channel Code - [Optional]

branchCode

integer | null · int32

Branch Code

customerNameSurname

string | null

Customer Name Surname

identificationNumber

string | null

Identification Number

courierStatus

string | null

Courier Status

Service that lists detailed card information › Responses

Success

GetCardListResponse

array | null

List Of Card - [Optional]

POST/prepaid/api/getCardList

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelPrepaid/prepaid/api/getCardList \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "barcode": "barcode",
  "cardNumber": "cardNumber",
  "purpose": "purpose",
  "channelCode": "channelCode",
  "isCorporateAllCardList": true,
  "branchCode": 0,
  "customerNameSurname": "customerNameSurname",
  "identificationNumber": "identificationNumber",
  "courierStatus": "courierStatus"
}'

Example Request Body

{
  "customerNumber": 0,
  "mainCustomerNumber": 0,
  "shadowCardNumber": "shadowCardNumber",
  "barcode": "barcode",
  "cardNumber": "cardNumber",
  "purpose": "purpose",
  "channelCode": "channelCode",
  "isCorporateAllCardList": true,
  "branchCode": 0,
  "customerNameSurname": "customerNameSurname",
  "identificationNumber": "identificationNumber",
  "courierStatus": "courierStatus"
}

json

Example Responses

{
  "listOfCard": [
    {
      "shadowCardNumber": "shadowCardNumber",
      "maskedCardNumber": "maskedCardNumber",
      "cardRefNumber": "cardRefNumber",
      "mainCardRefNumber": "mainCardRefNumber",
      "customerNumber": 0,
      "mainCustomerNumber": 0,
      "relatedCardRefNumber": "relatedCardRefNumber",
      "supplementaryCardFlag": true,
      "cardRefCurrentCardFlag": true,
      "branchCode": 0,
      "branchName": "branchName",
      "ownerName": "ownerName",
      "ownerSecondName": "ownerSecondName",
      "ownerSurname": "ownerSurname",
      "embossName": "embossName",
      "productNumber": "productNumber",
      "productSegmentCode": "productSegmentCode",
      "cardStatusCode": "cardStatusCode",
      "cardStatusDscr": "cardStatusDscr",
      "cardStatusReasonCode": "cardStatusReasonCode",
      "cardStatusReasonDscr": "cardStatusReasonDscr",
      "virtualFlag": true,
      "productName": "productName",
      "productShortName": "productShortName",
      "tenantId": "tenantId",
      "emvFlag": true,
      "magneticStripeFlag": true,
      "contactlessFlag": true,
      "rewardEarningFlag": true,
      "cardBrand": "cardBrand",
      "cardBrandDescription": "cardBrandDescription",
      "cardDeliveryType": "cardDeliveryType",
      "expiryDateStr": "expiryDateStr",
      "provisionStatusFlag": true,
      "digitalCardFlag": true,
      "insertDate": "2024-08-25T15:00:00Z",
      "cvv2RetryCount": 0,
      "pinRetryCount": 0,
      "barcode": "barcode",
      "fromShadowCardNumber": "fromShadowCardNumber",
      "toShadowCardNumber": "toShadowCardNumber",
      "requestDate": "2024-08-25T15:00:00Z",
      "requestChannel": "requestChannel",
      "embossReasonCode": "embossReasonCode",
      "embossReasonDescription": "embossReasonDescription",
      "embossReasonSubCode": "embossReasonSubCode",
      "embossReasonSubDesc": "embossReasonSubDesc",
      "cardStatusChangeDate": "2024-08-25T15:00:00Z",
      "firstTrnDate": "2024-08-25T15:00:00Z",
      "lastTrnDate": "2024-08-25T15:00:00Z",
      "firstPinSetDate": "2024-08-25T15:00:00Z",
      "lastPinSetDate": "2024-08-25T15:00:00Z",
      "lastPinChangeDate": "2024-08-25T15:00:00Z",
      "deliveryAddress": "deliveryAddress",
      "isFirstPinSet": "isFirstPinSet",
      "sendingBranchCode": "sendingBranchCode",
      "sendingAddressType": "sendingAddressType",
      "productGroupCode": "productGroupCode",
      "productGroupDescription": "productGroupDescription",
      "fromMaskedCardNumber": "fromMaskedCardNumber",
      "toMaskedCardNumber": "toMaskedCardNumber",
      "disabledFlag": true,
      "sensitiveData": {
        "pan": "pan",
        "cvv2": "cvv2"
      },
      "pendingReplaceApplicationExists": true,
      "pinStatus": "pinStatus",
      "cardStatusChangeChannel": "cardStatusChangeChannel",
      "securityFlag": true,
      "citizenshipNumber": "citizenshipNumber",
      "taxNumber": "taxNumber",
      "customerNameSurname": "customerNameSurname",
      "cardSeqNumber": 0,
      "isDelivered": true
    }
  ]
}

json

application/json

Card issuance and personalisation No-name cards

Service that retrieves detailed credit card information based on card data

POST

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

/prepaid/api/getPrepaidCardInfo

Retrieves detailed information about a prepaid card.

Service that retrieves detailed credit card information based on card data › Request Body

GetPrepaidCardInfoRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardNumber

string | null

Card Number - [Optional]

Service that retrieves detailed credit card information based on card data › Responses

Success

GetPrepaidCardInfoResponse

object

Card Info - [Optional]

Service that updates a card to a renewable status and performs card renewal

POST

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

/prepaid/api/changeAndReplaceCard

Changes and replaces a prepaid card, updating associated data.

Service that updates a card to a renewable status and performs card renewal › Request Body

ChangeAndReplaceCardRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardStatusCode

string | null

Card Status Code - [Optional]

cardStatusReasonCode

string | null

Card Status Reason Code - [Optional]

closeRequestDate

string | null · date-time

Close Request Date - [Optional]

object

Replace Info - [Optional]

Service that updates a card to a renewable status and performs card renewal › Responses

Success

ChangeAndReplaceCardResponse

toStatusActive

boolean · required

To Status Active - [Optional]

object

Replace Result - [Optional]

Service that allows modifying the card’s status information

POST

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

/prepaid/api/changeCardStatus

Changes the status of a prepaid card.

Service that allows modifying the card’s status information › Request Body

ChangeCardStatusRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardStatusCode

string | null

Card Status Code - [Optional]

cardStatusReasonCode

string | null

Card Status Reason Code - [Optional]

channel

string | null

Channel - [Optional]

closeRequestDate

string | null · date-time

Close Request Date - [Optional]

Service that allows modifying the card’s status information › Responses

Success

ChangeCardStatusResponse

toStatusActive

boolean · required

To Status Active - [Optional]

Card renewal service

POST

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

/prepaid/api/replaceCard

Replaces a prepaid card with a new one.

Card renewal service › Request Body

ReplaceCardRequest

channel

string | null

Channel - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

embossName

string | null

Emboss Name - [Optional]

deliveryType

string | null

Delivery Type - [Optional]

deliveryAddressType

string | null

Delivery Address Type - [Optional]

deliveryBranchCode

integer | null · int32

Delivery Branch Code - [Optional]

cardEmbossReason

string | null

Card Emboss Reason - [Optional]

cardEmbossSubReason

string | null

Card Emboss Sub Reason - [Optional]

productNumber

string | null

Product Number - [Optional]

instantIssuingFlag

boolean | null

Instant Issuing Flag - [Optional]

embossBranchCode

integer | null · int32

Emboss Branch Code - [Optional]

object

Permissions - [Optional]

cardSendAddressId

integer | null · int64

Card Send Address Id - [Optional]

Card renewal service › Responses

Success

ReplaceCardResponse

newCardGenerated

boolean · required

New Card Generated - [Optional]

productChanged

boolean · required

Product Changed - [Optional]

expiryDate

string · date-time · required

Expiry Date - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

maskedCardNumber

string | null

Masked Card Number - [Optional]

Service that lists detailed card information

POST

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

/prepaid/api/getCardList

Retrieves the list of prepaid cards for a customer.

Service that lists detailed card information › Request Body

GetCardListRequest

isCorporateAllCardList

boolean · required

Is Corporate All Card List - [Optional]

customerNumber

integer | null · int64

Customer Number - [Optional]

mainCustomerNumber

integer | null · int64

Main Customer Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

barcode

string | null

Barcode - [Optional]

cardNumber

string | null

Card Number - [Optional]

purpose

string | null

Purpose - [Optional]

channelCode

string | null

Channel Code - [Optional]

branchCode

integer | null · int32

Branch Code

customerNameSurname

string | null

Customer Name Surname

identificationNumber

string | null

Identification Number

courierStatus

string | null

Courier Status

Service that lists detailed card information › Responses

Success

GetCardListResponse

array | null

List Of Card - [Optional]