Permissions and restrictions

Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.

Service that lists restrictions applied to the card

POST

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

/credit/api/getCardPermissions

Retrieves permission restrictions for a credit card by shadow card number. Maps results from Lifecycle service to CreditCardPermissions objects including restriction codes, descriptions, permission indicators, channel, and security flags.

Part of:

Journey 02 · Managing a card product — step 1, Read current controls

Service that lists restrictions applied to the card › Request Body

GetCardPermissionsRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists restrictions applied to the card › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/credit/api/getCardPermissions

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "cardPermissionsList": [
    {
      "restrictionCode": "restrictionCode",
      "restrictionCodeDescription": "restrictionCodeDescription",
      "restrictionPermissionIndicator": "restrictionPermissionIndicator",
      "restrictionPermissionIndicatorDescription": "restrictionPermissionIndicatorDescription",
      "channel": "channel",
      "securityFlag": true
    }
  ]
}

json

application/json

Service that adds or removes card restrictions

POST

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

/credit/api/saveCardPermissions

Saves the card permissions including restrictions, start date, end date, and transaction ID for the specified card.

Part of:

Journey 02 · Managing a card product — step 2, Update permissions

Service that adds or removes card restrictions › Request Body

SaveCardPermissionsRequest

channel

string | null

Channel - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

array | null

Permissions - [Optional]

Service that adds or removes card restrictions › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

Changed Count - [Optional]

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/credit/api/saveCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}

json

Example Responses

{
  "changedCount": 0,
  "listOfRecordId": [
    0
  ]
}

json

application/json

Service that updates Digital Slip delivery preferences

POST

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

/credit/api/changeCardMiscOption

Updates miscellaneous options for a credit card or a set of cards. Sends OptionType and OptionValue along with customer/card identifiers to the Lifecycle service and returns the list of CardMiscOptionLogRecordIds created for the change.

Service that updates Digital Slip delivery preferences › Request Body

ChangeCardMiscOptionRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

allMainCardFlag

boolean · required

All Main Card Flag - [Optional]

allCardFlag

boolean · required

All Card Flag - [Optional]

channel

string | null

Channel - [Optional]

optionType

string | null

Option Type - [Optional]

optionValue

string | null

Option Value - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that updates Digital Slip delivery preferences › Responses

Success

CardMiscOptionResponse

listOfCardMiscOptionLogRecordId

array | null

List Of Card Misc Option Log Record Id - [Optional]

POST/credit/api/changeCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "channel",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

Example Responses

{
  "listOfCardMiscOptionLogRecordId": [
    0
  ]
}

json

application/json

Service that lists Digital Slip preferences

POST

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

/credit/api/getCardMiscOption

Retrieves miscellaneous option settings for credit cards based on channel, option type, customer number, main card reference, individual or all card flags, and card reference. Maps results from Lifecycle service to CardMiscOptionData objects including option type, value, customer number, and card references.

Service that lists Digital Slip preferences › Request Body

GetCardMiscOptionRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

allMainCardFlag

boolean · required

All Main Card Flag - [Optional]

allCardFlag

boolean · required

All Card Flag - [Optional]

channel

string | null

Channel - [Optional]

optionType

string | null

Option Type - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that lists Digital Slip preferences › Responses

Success

GetCardMiscOptionResponse

array | null

Card Misc Option Data List - [Optional]

POST/credit/api/getCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "channel",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

Example Responses

{
  "cardMiscOptionDataList": [
    {
      "customerNumber": 0,
      "mainCardRefNumber": "mainCardRefNumber",
      "cardRefNumber": "cardRefNumber",
      "optionType": "optionType",
      "optionValue": "optionValue"
    }
  ]
}

json

application/json

Operation limits Instalments

Credit Digital Channels Integration

Permissions and restrictions

Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.

Service that lists restrictions applied to the card

POST

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

/credit/api/getCardPermissions

Part of:

Journey 02 · Managing a card product — step 1, Read current controls

Service that lists restrictions applied to the card › Request Body

GetCardPermissionsRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists restrictions applied to the card › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/credit/api/getCardPermissions

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

Example Request Body

{
  "shadowCardNumber": "shadowCardNumber"
}

json

Example Responses

{
  "cardPermissionsList": [
    {
      "restrictionCode": "restrictionCode",
      "restrictionCodeDescription": "restrictionCodeDescription",
      "restrictionPermissionIndicator": "restrictionPermissionIndicator",
      "restrictionPermissionIndicatorDescription": "restrictionPermissionIndicatorDescription",
      "channel": "channel",
      "securityFlag": true
    }
  ]
}

json

application/json

Service that adds or removes card restrictions

POST

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

/credit/api/saveCardPermissions

Saves the card permissions including restrictions, start date, end date, and transaction ID for the specified card.

Part of:

Journey 02 · Managing a card product — step 2, Update permissions

Service that adds or removes card restrictions › Request Body

SaveCardPermissionsRequest

channel

string | null

Channel - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

shadowCardNumber

string | null

Shadow Card Number - [Optional]

array | null

Permissions - [Optional]

Service that adds or removes card restrictions › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

Changed Count - [Optional]

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/credit/api/saveCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/saveCardPermissions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}'

Example Request Body

{
  "channel": "channel",
  "cardRefNumber": "cardRefNumber",
  "shadowCardNumber": "shadowCardNumber",
  "permissions": [
    {
      "restrictionCode": "restrictionCode",
      "permitted": true,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "transactionId": "transactionId"
    }
  ]
}

json

Example Responses

{
  "changedCount": 0,
  "listOfRecordId": [
    0
  ]
}

json

application/json

Service that updates Digital Slip delivery preferences

POST

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

/credit/api/changeCardMiscOption

Service that updates Digital Slip delivery preferences › Request Body

ChangeCardMiscOptionRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

allMainCardFlag

boolean · required

All Main Card Flag - [Optional]

allCardFlag

boolean · required

All Card Flag - [Optional]

channel

string | null

Channel - [Optional]

optionType

string | null

Option Type - [Optional]

optionValue

string | null

Option Value - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that updates Digital Slip delivery preferences › Responses

Success

CardMiscOptionResponse

listOfCardMiscOptionLogRecordId

array | null

List Of Card Misc Option Log Record Id - [Optional]

POST/credit/api/changeCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/changeCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "channel",
  "optionType": "optionType",
  "optionValue": "optionValue",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

Example Responses

{
  "listOfCardMiscOptionLogRecordId": [
    0
  ]
}

json

application/json

Service that lists Digital Slip preferences

POST

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

/credit/api/getCardMiscOption

Service that lists Digital Slip preferences › Request Body

GetCardMiscOptionRequest

customerNumber

integer · int64 · required

Customer Number - [Optional]

allMainCardFlag

boolean · required

All Main Card Flag - [Optional]

allCardFlag

boolean · required

All Card Flag - [Optional]

channel

string | null

Channel - [Optional]

optionType

string | null

Option Type - [Optional]

mainCardRefNumber

string | null

Main Card Ref Number - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that lists Digital Slip preferences › Responses

Success

GetCardMiscOptionResponse

array | null

Card Misc Option Data List - [Optional]

POST/credit/api/getCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelCredit/credit/api/getCardMiscOption \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "channel",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}'

Example Request Body

{
  "channel": "channel",
  "optionType": "optionType",
  "customerNumber": 0,
  "mainCardRefNumber": "mainCardRefNumber",
  "cardRefNumber": "cardRefNumber",
  "allMainCardFlag": true,
  "allCardFlag": true
}

json

Example Responses

{
  "cardMiscOptionDataList": [
    {
      "customerNumber": 0,
      "mainCardRefNumber": "mainCardRefNumber",
      "cardRefNumber": "cardRefNumber",
      "optionType": "optionType",
      "optionValue": "optionValue"
    }
  ]
}

json

application/json

Operation limits Instalments