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 defined on a card

POST

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

/debit/api/getCardPermissions

Retrieves the permissions set on a debit card based on ShadowCardNumber. Returns a list of DebitCardPermissions including restriction codes, descriptions, permission indicators, channel, and security flags. Uses _dbtServiceProxy.GetCardPermissions for fetching data.

Service that lists restrictions defined on a card › Request Body

GetCardPermissionsRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists restrictions defined on a card › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/debit/api/getCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 restrictions on a card

POST

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

/debit/api/saveCardPermissions

Saves or updates card permissions for a specific card. Accepts card reference number, shadow card number, channel, and a list of permission items with start/end dates and restriction codes. Returns the count of changed permissions and their record IDs.

Service that adds or removes restrictions on a card › 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 restrictions on a card › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

Changed Count - [Optional]

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/debit/api/saveCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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

POST

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

/debit/api/saveCardBnplPermission

Saves or updates Buy Now Pay Later (BNPL) permissions for a card. Accepts card reference number, channel, and BNPL permission details to enable or disable BNPL features on the card.

Request Body

SaveCardBnplPermissionRequest

bnplFlag

boolean · required

Bnpl Flag - [Optional]

channel

string | null

Channel - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Responses

Success

SaveCardBnplPermissionResponse

bnplFlag

boolean · required

Bnpl Flag - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that updates Digital Slip delivery preferences

POST

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

/debit/api/changeCardMiscOption

Changes miscellaneous options of a debit card, supporting individual or all cards for a customer, and returns the list of log record IDs.

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/debit/api/changeCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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/IntegrationDigitalChannelDebit

/debit/api/getCardMiscOption

Retrieves miscellaneous options for debit cards based on filters such as OptionType, CustomerNumber, MainCardRefNumber, CardRefNumber, and flags for all main cards or all cards. Returns a list of CardMiscOptionData containing the option type, option value, customer number, main card reference, and card reference. Uses _dbtServiceProxy.GetCardMiscOption for fetching the data.

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/debit/api/getCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 PIN and card security

Debit 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 defined on a card

POST

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

/debit/api/getCardPermissions

Service that lists restrictions defined on a card › Request Body

GetCardPermissionsRequest

shadowCardNumber

string | null

Shadow Card Number - [Optional]

Service that lists restrictions defined on a card › Responses

Success

GetCardPermissionsResponse

array | null

Card Permissions List - [Optional]

POST/debit/api/getCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 restrictions on a card

POST

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

/debit/api/saveCardPermissions

Service that adds or removes restrictions on a card › 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 restrictions on a card › Responses

Success

SaveCardPermissionsResponse

changedCount

integer · int32 · required

Changed Count - [Optional]

listOfRecordId

array | null

List Of Record Id - [Optional]

POST/debit/api/saveCardPermissions

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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

POST

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

/debit/api/saveCardBnplPermission

Saves or updates Buy Now Pay Later (BNPL) permissions for a card. Accepts card reference number, channel, and BNPL permission details to enable or disable BNPL features on the card.

Request Body

SaveCardBnplPermissionRequest

bnplFlag

boolean · required

Bnpl Flag - [Optional]

channel

string | null

Channel - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Responses

Success

SaveCardBnplPermissionResponse

bnplFlag

boolean · required

Bnpl Flag - [Optional]

cardRefNumber

string | null

Card Ref Number - [Optional]

Service that updates Digital Slip delivery preferences

POST

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

/debit/api/changeCardMiscOption

Changes miscellaneous options of a debit card, supporting individual or all cards for a customer, and returns the list of log record IDs.

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/debit/api/changeCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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/IntegrationDigitalChannelDebit

/debit/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/debit/api/getCardMiscOption

curl https://devcard.sim-ant.com/SandBox/IntegrationDigitalChannelDebit/debit/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 PIN and card security