Category links

API Links

Digital Wallets

Nowadays, digital wallets are widely accepted payment instruments. The CoreCard system can accept and process digital wallet transactions, offered by wallet service providers such as Google Pay, Samsung Pay, and Apple Pay. 

When a card is registered with any digital wallet, it initiates a token request to the token manager of the affiliated card network (i.e., MDES for Mastercard, VTS for VISA) to obtain a digital token against the card PAN. The card network then verifies whether or not the card number is within the allowed account ranges for tokenization to the digital wallet in context. Additionally, the card network asks CoreCard to verify that the card account is in good standing and can be provisioned and used to perform transactions. Once the CoreCard system grants approval, the token manager allocates a digital token against the card PAN and the token details are shared with the CoreCard system. Tokens can be allocated in the active state, or they may require other activation methods as per issuer terms and agreements with the affiliated card network. The process of getting a digital token is also called digitalization. 

Once a digital token is allocated to the card PAN, CoreCard stores the information related to the digital token. This information can be retrieved and the token status modified at the cardholder's request or due to card PAN replacement or reissue.

 

SVG Image

Get Transaction Token Details

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/GetTxnTokenDetails

POST /api/CoreCredit/DigitalWallets/GetTxnTokenDetails

Use this API to obtain a list of all tokens with available details mapped out on a card account using the Institution ID and Admin Number. The API retrieves token details such as token type, a token's last 4 digits, token expiry date, token status, token requester ID and device ID.

Note

As per PCI norms, a token cannot be stored in clear as such API fetches the last 4 digits of a token number. Another API object “TokenNumberHash” fetches the encrypted value of the token number created by the system.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

InstitutionID

integer

Mandatory

Unique identification number for Institution. Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard.

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129409,
  "InstitutionID": 10
}
Response fields detail
Fields Description

TokenList

array

Header of token list System

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "TokenList": [
        {
          "Skey": 1.0,
          "TokenNumberLastFourDigit": "0188",
          "TokenNumberHash": -1537407615,
          "TokenStatus": "A",
          "TokenType": "C",
          "TokenRequesterID": "01234567890",
          "TokenReferenceID": null,
          "TokenExpiryDate": "03/31/2018 00:00:00",
          "DeviceID": "",
          "DeviceName": "",
          "DeviceType": "01",
          "DeviceNumber": null,
          "TokenWalletID": "203="
        }
      ]
    }
  }
}

Update Transaction Token Status

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/UpdateTxnTokenStatus

POST /api/CoreCredit/DigitalWallets/UpdateTxnTokenStatus

Use this API to update the PAN token status by using the last four digits of a token number and new token status to be updated. The token status can be set as active, inactive, or closed, as required.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

Skey

decimal

Mandatory

Unique number for each token. Valid Values: 0-9 Example: 12345

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Example: 12345 Condition: At least one of AccountNumber\ AdminNumber is required.

ProductID

integer

Mandatory

ProductID Valid Values: 0-9 Example: 12345

AccountNumber

string

Conditional

Account number of cardholder Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037 Condition: At least one of AccountNumber\ AdminNumber is required.

Allowable Values:

19

TokenNumberLast4Digits

string

Mandatory

Last 4 digits of Token number Valid Values:0-9 Format: XXXX Example: 1234

Allowable Values:

4

NewTokenStatus

string

Mandatory

New Token Status Valid Values: A - Active C - Close I - Inactive

Allowable Values:

1

Sample request body
{
  "Source": "WEB",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "Skey": 1.0,
  "AdminNumber": 129409,
  "ProductID": 3351,
  "AccountNumber": null,
  "TokenNumberLast4Digits": "0188",
  "NewTokenStatus": "I"
}
Response fields detail
Fields Description

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": null
  }
}

GetTAVSignature

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/GetTAVSignature

POST /api/CoreCredit/DigitalWallets/GetTAVSignature

The purpose of this API is to get TAV signature for MDES Push Provisioning.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Admin Number of Primary Account Number Valid Values: 0-9 Format:XXXXX Example:12345

CardExpirationDate

string

Optional

Expiration date and month of PAN Valid Values: 0-9 Format:MMYY Example:0121

Allowable Values:

4

TavVersionNumber

string

Mandatory

TAV Format Valid Values:3 Format:X Example:3

Allowable Values:

1

DataValidUntilTimestamp

string

Mandatory

ISO 8601 format of the date and time(with Time Zone) the TAV expires and will no longer be honored Valid Values:0-9

Allowable Values:

29

FinancialAccountInformation

string

Optional

Identifier of the financial account being tokenized Valid Values:0-9

Allowable Values:

78

TokenUniqueReference

string

Optional

Token Unique Reference associated with the token. Valid Values:0-9

Allowable Values:

64

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129432,
  "CardExpirationDate": "0423",
  "TavVersionNumber": "3",
  "DataValidUntilTimestamp": "2019-12-27T10:05:45-05:00",
  "FinancialAccountInformation": null,
  "TokenUniqueReference": null
}
Response fields detail
Fields Description

AdminNumber

integer

Admin Number of Primary Account Number Valid Values: 0-9 Format:XXXX Example:200

IncludedFieldsInOrder

string

Concatenated string of fields in TAV signature, separated by “|”,in their order in signature. Example:dataValidUntilTimestamp|accountNumber|accountExpiry|financialAccountInformation|tokenUniqueReference

DigitalSignature

string

Digital signature calculated over a concatenated string of the included field values separated by a | delimiter, in the same order as specified in the IncludedFieldsInOrder field. Example:6523026E6214927059B98F8DC859EF5B2B6F7F6D9E7DAC13B38DCE6F0991F5F37DB7F9B95BD4BA8F9E6157CA1A5C8B5F880E044DD1A0D0F667F0D80619AE2637EF04BE80C4A05A8C98AA090A15EA29A43BC0846D6074724105839E8D7FC582F607C0CC40C29BF2586AE4CBE29E43E32665923838ED331CD56A557322B

Sample response body

{
  "application/json": {
    "Message": "Signature generated successfully",
    "Status": true,
    "ErrorCode": "ERR01620",
    "ResponseData": {
      "AdminNumber": 129432,
      "IncludedFieldsInOrder": "dataValidUntilTimestamp|accountNumber|accountExpiry|financialAccountInformation|tokenUniqueReference",
      "DigitalSignature": "6523026E6214927059B98F8DC859EF5B2B6F7F6D9E7DAC13B38DCE6F0991F5F37DB7F9B95BD4BA8F9E6157CA1A5C8B5F880E044DD1A0D0F667F0D80619AE2637EF04BE80C4A05A8C98AA090A15EA29A3BC0846D6074724105839E8D7FC582F607C0CC40C29BF2586AE4CBE29E43E32665923838ED331CD56A557322B7CCC296D9DC3B14A39377F928A668FF393CF46B8A4972A0905076AAF8115D16BCC87131906E9E09C4273389FB2EB474AFCA61958D377D415CE8E9ADECF0D011FC3C084ACC5EA3AF9CA5300960BA9C668972086CB08D4D313958EB444F9A887E96F98483D6FF4E198815DC7BF4C72322E473E9CEF83E27E2F9BCA8762E3121D4FD1FD32B"
    }
  }
}

MDESPushProvisioning

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/MDESPushProvisioning

POST /api/CoreCredit/DigitalWallets/MDESPushProvisioning

The purpose of this API is to provide TAV data which is required for Push Provisioning a card into wallets.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format:XXXXX Example:12345

WalletApplication

string

Mandatory

This value identifies the type of Wallet Valid Values: 01=Google 02=Samsung 03=Apple Example:01

Allowable Values:

2

TavVersionNumber

string

Mandatory

TAV Format Valid Values:3 Format:X Example:3

Allowable Values:

1

DataValidUntilTimestamp

string

Mandatory

ISO 8601 format of the date and time(with Time Zone) the TAV expires and will no longer be honored Valid Values:0-9

Allowable Values:

29

PANUniqueReference

string

Optional

PAN Unique Reference associated with the token Valid Values:0-9

Allowable Values:

64

TokenUniqueReference

string

Optional

Token Unique Reference associated with the token. Valid Values:0-9

Allowable Values:

64

FinancialAccountInformation

string

Optional

Identifier of the financial account being tokenized Valid Values:0-9

Allowable Values:

78

AccountExpiry

string

Optional

Expiration Year and month of PAN as required with communication with MasterCard for Push Provisioning Valid Values: 0-9 Format:MMYY Example:0822

Allowable Values:

4

CardholderName

string

Optional

Name of the Card holder Example: John Joe Condition: Name of the cardholder in the format lastname/firstname or firstname lastname.

Allowable Values:

27

BillingAddress

Optional

BillingAddress

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.1",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129432,
  "WalletApplication": "01",
  "TavVersionNumber": "3",
  "DataValidUntilTimestamp": "2019-12-27T10:05:45-05:00",
  "PANUniqueReference": null,
  "TokenUniqueReference": null,
  "FinancialAccountInformation": null,
  "AccountExpiry": "0423",
  "CardholderName": "John Joe",
  "BillingAddress": {
    "AddressLine1": "123 HWY",
    "AddressLine2": "Park Avenue ",
    "City": "Los Angeles",
    "CountrySubdivision": "US",
    "PostalCode": "45781",
    "Country": "US"
  }
}
Response fields detail
Fields Description

AdminNumber

int64

Details can be obtained by admin number (Embossing Acctid) Valid Values: 0-9 Format:XXXXX Example:12345

TAV

string

Tokenization Authentication Value

Allowable Values:

8000

CardInfo

string

Card Info will be Mandatory for WalletApplication =01 and 02. For walletapplication =03 Card info will not be delivered.

Allowable Values:

8000

Sample response body

{
  "application/json": {
    "Message": "Push Provisioning data generated successfully",
    "Status": true,
    "ErrorCode": "ERR05116",
    "ResponseData": {
      "AdminNumber": 129432,
      "TAV": "eyJ2ZXJzaW9uIjoiMyIsInNpZ25hdHVyZUFsZ29yaXRobSI6IlJTQS1TSEEyNTYiLCJkYXRhVmFsaWRVbnRpbFRpbWVzdGFtcCI6IjIwMjAtMDYtMjhUMjM6NTk6NTctMDU6MDAiLCJpbmNsdWRlZEZpZWxkc0luT3JkZXIiOiJkYXRhVmFsaWRVbnRpbFRpbWVzdGFtcHxhY2NvdW50TnVtYmVyIiwic2lnbmF0dXJlIjoiWWpMM0grMmpZcFdjbTFQNHNIUCs1bGZYWE0veldDQncwV1hJQ2w4SGNoaGpwVDhtNU5QZVdqZGJCWWljaityRmdQVUNCbkpERWUyOUd6UlJCM2t4Rm1pQWYraHZSMFh2QjFUT1JDbFJGKy9HZG5henlWaDBTa0o1aDJVTkdLSTFpbk43dHZqNjVYRmdBWnNOL3VQRWt6cnlzbzlKTys4S0VrS0diVTV2NEZwQWg1a2x6dnB3YU5uTUtBRzhxcUxuRlNEbzJsdHVGRzVUUktFcWl0UXRzeStSSlRjWXgwSDZhOVNGVGJWVllQWmNKZ3lCOC90ajFOTnlUTXV5enNDMEVZbkJCOTllNHFKWmhTeElQbG9nelpJOXB3aUxFMzFocU56czZUNUQ0TExlMGxNSlhnSkwvL3NBd04zMGtLalkyMU03bzRCYTRtb0xlUXcvbHdMRDhRPT0ifQ",
      "CardInfo": "eyJwYW5VbmlxdWVSZWZlcmVuY2UiOiIxMjM0NTYiLCJ0b2tlblVuaXF1ZVJlZmVyZW5jZUZvclBhbkluZm8iOm51bGwsInB1YmxpY0tleUZpbmdlcnByaW50IjoiNEM0RUFENTkyN0YwREY4MTE3RjE3OEVFQTkzMDhEQUE1OEUyN0MyQiIsImVuY3J5cHRlZEtleSI6IjVBMTU4OThDQUREMEUyQUYzNUNDNUZDQTE2QUVCODI2NURDQUM4MjYwMjFCOEVFODkwNDYzMDlGNEI1QzYxOEZCRTczRjk5Rjg1QjEyODgxODkxQTlCRjA1RkJDMTZCMzg2QzhCQzA2MDRGM0ZCN0VCRjk1NkQyMUUwRjU5QkVCRTFEQjAxOUEzMzFCMjRCOTcwQzUxNUQ2NDEzODk0MkQ1OUYzOUE5MTU5MTIyNTE1RDhDOTU4MEE3RUZDRjIwRTdFOEIyREYxMDc2Q0ZFMTBERDhDQkFBNUVGRjJBN0VDMkRCNkEzNkNBRURCMTEyODMwMUY3QzY5NEI4MThCRTM1NEE4ODRBNjlBRUUzNDJCQkM4RUI0NUVBOTQyOUNGQTM3NjE1NTg3QjBDNzA5Q0RENjg5MDMyMEIxNTE3NURGMUQ1NEQ3NjczQjYyMDYwM0IyMkVBRjU3NUI5NTY1RTE5RUNGQTQ4NDU4Q0Y5ODlGNzdGRDg5NDAzNTE4Qzk0N0FBRENERTFDNTRERDNFMkRBMDFBMzgwMEUxQzUwNUFGNzBENTc0NDhCNTE5OTBGQTE0RjhGRjQyQUE3QjkyRjgwMTZDNTcxODM4RTlEMUE2RDkzQkY3MkVFNUNCMTE4NTM0NDhGQTJEMzc0RTI3RkIyQzNGQzU3NjVFNzI2ODczIiwib2FlcEhhc2hpbmdBbGdvcml0aG0iOiJTSEEyNTYiLCJpdiI6IjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwIiwiZW5jcnlwdGVkRGF0YSI6IjI5MjREMzg2NTM1"
    }
  }
}

VISAPushProvisioning

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/VISAPushProvisioning

POST /api/CoreCredit/DigitalWallets/VISAPushProvisioning

Push provisioning allows issuer mobile apps to push customer’s PAN data securely to participating third-party Wallet Providers for VTS token provisioning.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Description: Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Example: 12345

cvv2

integer

Optional

Description: CVV2 value of Card.

Name

string

Mandatory

Description: The full name on the Visa card associated with the enrolled payment instrument.

Allowable Values:

256

ExpirationDate

Group with details of Expiration of Card

BillingAddress

Mandatory

Billing address associated with the payment instrument.

intent

Mandatory

Description: The intent of the encryptor. Valid Values: PUSH_PROV_MOBILE, PUSH_PROV_ONFILE

isIDnV

string

Mandatory

Description: String field to specify if the Issuer wants IDandV to be performed. Valid Values: "true" or "false"

Provider

Mandatory

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129305,
  "cvv2": 1234,
  "Name": "Your Name",
  "ExpirationDate": {
    "Month": 12,
    "Year": 2017
  },
  "BillingAddress": {
    "line1": "801Metro Center Blvd",
    "line2": "801MetroCÆÇÊÔ",
    "city": "Foster City",
    "state": "CA",
    "country": "US",
    "PostalCode": "94404"
  },
  "Provider": {
    "clientAppID": "MyApp",
    "clientDeviceID": "ed6abb56323ba656521ac476",
    "clientWalletProvider": "40000000047",
    "clientWalletAccountID": "walletid",
    "intent": 0,
    "isIDnV": "false"
  }
}
Response fields detail
Fields Description

ErrorFound

string

Indicates result of API processing. If error found then "Yes", else "No".

ErrorNumber

string

Return Error Code in case of Error.

ErrorMessage

string

Return Error Message in case of Error.

AdminNumber

integer

Admin Number of Primary Account Number.

EncryptedPayload

string

Encrypted Payload calculated over the field values of Input.

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ErrorFound": "NO",
      "ErrorNumber": "ERR01620",
      "ErrorMessage": "Encrypted payload generated successfully",
      "AdminNumber": 129305,
      "EncryptedPayload": "OUIyMDlGNjdENkY0QUM3QUY0QUMxQ0I3QUM3M0FDNDUwNjVDQUJFM0UxRUIwMjg2RDgzMzgzNzQzQjNDRTg4N0Q4OUY4NDZCODkwMjc3OTZDRUM4MjZENUFGRDAwODgxMDlDODM2RjRCRTczQzMxQkU3REQ3NkEwODdCMkM0NjExNkFFOTRDNTBDOTVGOEE3QzNGRkU4RTM5RjA2QzBDNDc4RENCN0REMjAxMkM1MzNFRTY4MzU1RkQxMzREMEJCNzIyRTUwOEIzNkI3QTQ4RkU5RTQ4OUFCM0E1ODcxQzYxNzNBQjI1QzM5MjQ5RTFGMjg4RDJDQTcyNkZCQjEwMA=="
    }
  }
}

VISAPushProvisioningMBPAC

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/VISAPushProvisioningMBPAC

POST /api/CoreCredit/DigitalWallets/VISAPushProvisioningMBPAC

Push provisioning allows issuer mobile apps to push customer’s PAN data securely to participating third-party Wallet Providers for VTS token provisioning.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Description: Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Example: 12345

nonce

string

Mandatory

Description: Required for Issuer mobile banking app initiated provisioning requests to Apple. Contains the contents of the nonce field, in hexBinary, received by the issuer from Apple’s servers. This is used to verify that the same device is used with the issuer’s mobile banking app and the provisioning request sent to Visa and helps prevent replay.

Allowable Values:

256

authcode

string

Mandatory

Description: Required. Contains a 6-character code generated by the issuer that is specific to the current provisioning request. Used by Issuer and Visa to identify specific activation codes in problem resolution or authentication related questions. Format is alphanumeric (allowed characters include: ‘0’ through ‘9’ and ‘A’ through ‘Z’ – characters must be in uppercase – must not contain all zeros or all spaces).

Allowable Values:

6

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129305,
  "nonce": "49a990f48f00",
  "authcode": "Z0P73B"
}
Response fields detail
Fields Description

ErrorFound

string

Indicates result of API processing. If error found then "Yes", else "No".

ErrorNumber

string

Return Error Code in case of Error.

ErrorMessage

string

Return Error Message in case of Error.

ActivationData

string

Encrypted Activation Data calculated over the field values of Input.

AdminNumber

int64

Admin Number of Primary Account Number.

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ErrorFound": "NO",
      "ErrorNumber": "ERR01620",
      "ErrorMessage": "Encrypted payload generated successfully",
      "ActivationData": "TUJQQUMtMS1GSy01Mjg4OTguMS0tVERFQS0yOUJENERBMzhGNzM3NjQ1RDQ2OUNGREEwQzI0OTg4Qzc5NjIzNjg1NzFBNjk0NTgzNUQzMEY5QjE5OTUxOTVBRTY3OEExOTEwOTBFNEJERTBFOUQyM0MxMjJDODRBOTE=",
      "AdminNumber": 129305
    }
  }
}

VISAPushProvisioningMBPAD

Action: POST

Endpoint: /api/CoreCredit/DigitalWallets/VISAPushProvisioningMBPAD

POST /api/CoreCredit/DigitalWallets/VISAPushProvisioningMBPAD

Push provisioning allows issuer mobile apps to push customer’s PAN data securely to participating third-party Wallet Providers for VTS token provisioning.

Request fields detail
Fields Description

Source

string

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

50

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

15

DateFormat

string

Optional

Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS

Allowable Values:

25

CurrencyCode

string

Optional

Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840

Allowable Values:

10

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

10

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

10

ExternalIP

string

IP Address of end user of API

Allowable Values:

50

SessionID

string

Optional

Session identifier of the API Example: 000028;026;1349906692

Allowable Values:

100

APIVersion

string

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

Allowable Values:

10

CallerID

string

Optional

Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR)

Allowable Values:

20

CalledID

string

Optional

Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR)

Allowable Values:

20

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AdminNumber

int64

Mandatory

Description: Details can be obtained by admin number (Embossing Acctid). Valid Values: 0-9 Format: XXXXX Example: 12345

expiry

string

Mandatory

Expiration Date of the Card in MMYY format. Format: MMYY Example: 0220

Allowable Values:

4

datetime

string

Mandatory

The date and time that the issuer constructs the Provisioning Authentication Data. This is expressed in Greenwich Mean Time (GMT), in ccyymmddhhmmss format. Format: ccyymmddhhmmss Example: 20191204224500

Allowable Values:

256

Sample request body
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AdminNumber": 129305,
  "expiry": "1223",
  "datetime": "20191204224500"
}
Response fields detail
Fields Description

ErrorFound

string

Indicates result of API processing. If error found then "Yes", else "No".

ErrorNumber

string

Return Error Code in case of Error.

ErrorMessage

string

Return Error Message in case of Error.

AuthenticationData

string

Encrypted Authentication Data calculated over the field values of Input.

AdminNumber

int64

Admin Number of Primary Account Number.

Sample response body

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ErrorFound": "NO",
      "ErrorNumber": "ERR01620",
      "ErrorMessage": "Encrypted payload generated successfully",
      "AuthenticationData": "TUJQQUQtMS1GSy01Mjg4OTguMS0tVERFQS0wRDBFMDdGRDVENTBGNjM4RTg4NjEwMUVGMDk3NzAyMzJBMUE2QjkyQzFBQ0VGMkMwRTgyODAzNDNCQzk3RkVENDkzNEUyREMwN0M0OUE0MjQwRTBCQkI3RDM1MTAxNkUxOTA1NkM1RUJCRUM4Rjc2MkQ3MEMzQkQwNUE5N0UyRUM5OUUxRjRDRUIxMDREREI=",
      "AdminNumber": 129305
    }
  }
}