Entrada (del emisor)

Get virtual card list information

post

This method can be used to retrieve the list of virtual card(s) that belongs to a funding card.

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Cuerpo

application/json

issuerCardRefIdstring · máx: 48Requerido

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

Respuestas

200

getCardInfo response payload

application/json

issuerCardRefIdstring · máx: 48Requerido

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

post

/getCardInfo

HTTPcURLJavaScriptPython

POST /gtep/igwapi/v2.0/getCardInfo HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "issuerCardRefId": "text"
}

{
  "issuerCardRefId": "text",
  "virtualCardList": [
    {
      "virtualCardId": "text",
      "issuerCardRefId": "text",
      "walletProviderId": "text",
      "walletCardRefId": "text",
      "walletVirtualCardId": "text",
      "deviceInformation": {
        "tokenStorageId": "text",
        "originalTokenStorageId": "text",
        "tokenStorageType": "text",
        "originalTokenStorageType": "text",
        "manufacturer": "text",
        "brand": "text",
        "model": "text",
        "tac": "text",
        "osVersion": "text",
        "firmwareVersion": "text",
        "phoneNumber": "text",
        "fourLastDigitPhoneNumber": "text",
        "deviceName": "text",
        "deviceId": "text",
        "androidIdLastTwo": "text",
        "deviceParentId": "text",
        "language": "text",
        "deviceStateFlags": "text",
        "serialNumber": "text",
        "timeZone": "text",
        "timeZoneSetting": "NETWORK_SET",
        "simSerialNumber": "text",
        "IMEI": "text",
        "phoneLostTime": "text",
        "networkOperator": "text",
        "networkType": "CELLULAR"
      },
      "deviceBindingList": [
        {
          "deviceBindingReference": "text"
        }
      ],
      "cardholderVerificationList": [
        {
          "status": "PENDING",
          "timestamp": "text",
          "lifeCycleTraceID": 1
        }
      ],
      "provisioningTime": "text",
      "lastReplenishTime": "text",
      "isPrimary": true,
      "status": "DEPLOYMENT_ONGOING",
      "tokenAssuranceLevel": "text"
    }
  ]
}

Get Token Info

post

This method can be used to retrieve information associated to a specific token, including the token value itself, if available.

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Cuerpo

application/json

issuerCardRefIdstring · máx: 48Requerido

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

virtualCardIdstring · mín: 1 · máx: 64Requerido

Identifier of the virtual card to update

Respuestas

200

getTokenInfo response payload

application/json

issuerCardRefIdstring · máx: 48Requerido

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

virtualCardIdstring · mín: 1 · máx: 64Requerido

Identifier of the virtual card to update

walletCardRefIdstring · mín: 1 · máx: 128Opcional

Wallet funding card unique identifier Conditional: If provided by Wallet provider.

walletProviderIdstring · mín: 1 · máx: 64Requerido

Wallet Provider identifier, defined by Thales

When TSH acts as OEM Pay broker for Domestic scheme:

walletProviderId	Description
APPLE_PAY	Apple Pay Wallet
SPAYHCE	Samsung Pay Wallet
ANDROID_PAY	Google Pay Wallet

When TSH acts as ITSP:

walletProviderId	Description
APPLE_PAY	Apple Pay Wallet
SAMSUNG_PAY	Samsung Pay Wallet
GOOGLE_PAY	Google Pay Wallet
GARMIN_PAY	Garmin Pay Wallet
FITBIT_PAY	Firbit Pay Wallet
FACEBOOK	Facebook eCom Wallet
VISA_CHECKOUT	Visa Checkout eCom Wallet
NETFLIX	Netflix eCom Wallet

For other wallet (such as HCE Wallet), id is provided during on-boarding phase

walletVirtualCardIdstring · mín: 1 · máx: 128Opcional

Wallet virtual card unique identifier Conditional: If provided by Wallet provider.

tokenSuffixstring · mín: 4 · máx: 4Requerido

Last 4 digits of the token

tokenDetailsstring · mín: 1 · máx: 8196Opcional

Additional information about the token of the virtual card This field is conditional to the TSP and provided only during enrolment. The tokenInfo is the json (cf http://www.json.org/ ) representation of the Token.

This value is encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

• The content encryption algorithm used is AES256/CBC/PKCS7Padding using a randomly generated AES key.

• The key encryption algorithm is either RSAES-PKCS1-v1_5 (RSA/NONE/PKCS1Padding) or RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256), using the certificate provided during onboarding.
  The key encryption algorithm is defined during onboarding and is by default (if ommitted) the RSA/NONE/PKCS1Padding for legacy purpose.
  It is recommended to configure RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) for new issuers.

• The encryption result is then encoded using base64.
  

• The public key length in the certificate can be 2048-bit or 4096-bit.

Once deciphered, the cardInfo contains the following information:

JSON field parameter name	description	MOC	Length
pan	The token PAN	M	Up to 19
exp	The token expiry date in the format MMYY. It is not provided for UPI scheme.	C	4
fpan	The funding PAN. It is provided for Domestic scheme.	C	Up to 19
fpanExpiryDate	The card expiry date in the format MMYY. It is provided for Domestic scheme.	C	4
paymentAccountReference	The payment account reference. It can be provided for Domestic scheme.	O	58
originalToken	The device-based token used to request the digitization	O	Up to 19
originalTokenReferenceID	The unique reference of the original Token	O	Up to 32
originalTokenAssuranceLevel	The assurance level of the orginal Token - RFU	O	2

NOTE

originalToken,originalTokenReferenceID and originalTokenAssuranceLevel are provided ONLY by VISA in case of a Token for Token digitization flow.

tokenTypestring · máx: 16Opcional

The type of token the TSP has created or for which the request is sent. It applies to VISA, MasterCard and UPI. Following values are supported:

• SE (token for a secure element)
• HCE (token for Host Card Emulated device)
• COF (token for a card on file)
• ECOM (token for ecommerce)
• QRC (token for QRCode)

productIdstring · mín: 1 · máx: 32Opcional

Unique identifier of the card product associated to the token. Provided for domestic scheme.

publicKeyIdentifierstring · mín: 1 · máx: 32Opcional

Identifier of the publick key used to secure the tokenDetails

provisioningTimestring · máx: 32Opcional

If available, the provisioning time the Virtual card. In format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

lastReplenishTimestring · máx: 32Opcional

If available, the last replenishment time of the Virtual card credentials. In format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

lastStatusChangeTimestring · máx: 32Opcional

If available, the time of the last change occured on the token state. In format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

statusstring · enumRequerido

Current status of the token

Valores posibles:

tokenAssuranceLevelstring · máx: 2Opcional

The token assurance level indicates the level of assurance of the token. This is given by the ID&V method that has been used to authenticate the consumer on the specific token for example when the token is created (during the digitization flow) or, in case of a COF token, when a binding flow is executed.

Following values are supported:

• 00 (ID&V not performed)
• 10 (Card Issuer Account Verification)
• 11 (Card Issuer Interactive Verification - 1 Factor)
• 12 (Card Issuer Interactive Verification - 2 Factor)
• 13 (Card Issuer Oriented Non-Interactive Cardholder Authentication)
• 14 (Card Issuer Asserted Authentication)

NOTE: applies only to VISA

isPrimarybooleanOpcional

Boolean Flag indicating whether the token is primary or auxiliary.

Default: true

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

post

/getTokenInfo

HTTPcURLJavaScriptPython

POST /gtep/igwapi/v2.0/getTokenInfo HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "issuerCardRefId": "text",
  "virtualCardId": "text"
}

{
  "issuerCardRefId": "text",
  "virtualCardId": "text",
  "walletCardRefId": "text",
  "walletProviderId": "text",
  "walletVirtualCardId": "text",
  "tokenRequestor": {
    "id": "text",
    "originalTokenRequestorId": "text",
    "walletId": "text",
    "name": "text",
    "tspId": "text"
  },
  "deviceInformation": {
    "tokenStorageId": "text",
    "tokenStorageType": "text",
    "manufacturer": "text",
    "brand": "text",
    "model": "text",
    "osVersion": "text",
    "firmwareVersion": "text",
    "phoneNumber": "text",
    "fourLastDigitPhoneNumber": "text",
    "deviceName": "text",
    "deviceId": "text",
    "deviceParentId": "text",
    "language": "text",
    "serialNumber": "text",
    "timeZone": "text",
    "timeZoneSetting": "NETWORK_SET",
    "simSerialNumber": "text",
    "IMEI": "text",
    "networkOperator": "text",
    "networkType": "CELLULAR"
  },
  "deviceBindingList": [
    {
      "deviceBindingReference": "text"
    }
  ],
  "tokenSuffix": "text",
  "tokenDetails": "text",
  "tokenType": "text",
  "productId": "text",
  "publicKeyIdentifier": "text",
  "provisioningTime": "text",
  "lastReplenishTime": "text",
  "lastStatusChangeTime": "text",
  "status": "DEPLOYMENT_ONGOING",
  "tokenAssuranceLevel": "text",
  "isPrimary": true
}

Update funding card information

post

This method can be used by the Issuer to update either the card funding data OR the card metadata information:

• new expiry date value (in case of card renewal) or new PAN and expiry date (in case of card replacement)

OR

• new productId (in case of card replacement) (Not supported for Discover)

OR

• card metadata update (Not supported for Mastercard, American Express and Discover)

NOTE: it is not possible to update at the same time funding card data and card metadata.

The issuer receives a notifyVirtualCardChange per virtualCard (active or suspended) linked to the funding card that is updated.

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Cuerpo

application/json

issuerCardRefIdstring · máx: 48Requerido

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

newIssuerCardRefIdstring · mín: 1 · máx: 48Opcional

New issuerCardRefId to be updated, provided only if the issuerCardRefId change after a PAN,exp or productId replacement.
Note, the newIssuerCardRefId is not mandatory and it is preferable to keep the same issuerCardRefId after updateCard
This field has been added to the API for issuers that are not able to manage the same identifier following a PAN/exp date update.

fpanDetailsstring · máx: 8192Opcional

Old and new FPAN details (for example in case of card renewal)
This value is encrypted using the PKCS#7 encryption scheme defined in RFC 2315/5652 using following encryption parameters:

• The content encryption algorithm used is AES256/CBC/PKCS7Padding
• The key encryption algorithm is RSA/NONE/OAEPWithSHA256AndMGF1Padding (with MGF1 using SHA-256) using the TSH certificate provided during onboarding.
• The encryption result shall be provided as hexadecimal string.
  

The format of the data is:
{
"oldFPAN": "[0-9]{16,19}",
"oldExpDate": "MMYY",
"oldPSN": "[a-fA-F0-9]{2}",
"newFPAN": "[0-9]{16,19}",
"newExpDate": "MMYY",
"newPSN": "[a-fA-F0-9]{2}"
}
NOTE1: all fields are MANDATORY...
NOTE2: oldPSN and newPSN apply ONLY to AMEX

Pattern: ^[a-fA-F0-9]+

publicKeyIdentifierstring · mín: 1 · máx: 32Opcional

Identifier of the key used to encrypt fpanDetails.
Provided by Thales to Issuer during onboarding.

newProductIdstring · mín: 1 · máx: 32Opcional

New ProductId to be used for digital card (for example: product upgrade).
This field is mutually exclusive to "fpanDetails" AND "metadata".

NOTE:

• UPI: not applicable.
• Mastercard: the supported range is 0-10

Respuestas

200

Successful (no response body)

Sin contenido

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

post

/updateCard

HTTPcURLJavaScriptPython

POST /gtep/igwapi/v2.0/updateCard HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Content-Type: application/json
Accept: */*
Content-Length: 771

{
  "issuerCardRefId": "text",
  "newIssuerCardRefId": "text",
  "fpanDetails": "text",
  "publicKeyIdentifier": "text",
  "newProductId": "text",
  "metadata": {
    "cardIssuer": "text",
    "foregroundColor": "text",
    "backgroundColor": "text",
    "labelColor": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "contactWebsite": "text",
    "contactName": "text",
    "contactEmail": "text",
    "contactNumber": "text",
    "privacyPolicyURL": "text",
    "termsAndConditionsURL": "text",
    "supportsTokenNotifications": "text",
    "supportsFPANNotifications": "text",
    "appLaunchURL": "text",
    "appLaunchURLScheme": "text",
    "transactionServiceURL": "text",
    "transactionPushTopic": "text",
    "messageServiceURL": "text",
    "messagePushTopic": "text"
  },
  "newCardMetadata": {
    "cardholderName": "text",
    "fpanLastDigits": "text",
    "fpanBin": "text",
    "fpanExpiryDate": "text"
  }
}

Sin contenido

Update virtual card state

post

This method is used by the Issuer to update the status of:

• a specific virtual card

• all the virtual cards associated to a funding PAN on every device

The issuer can use the request GetCardInfo to retrieve id of the card or virtual card etc of user in order to call UpdateCardState.

Status of operation is notified to the Issuer through NotifyCardStatusChange

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Cuerpo

application/json

issuerCardRefIdstring · máx: 48Opcional

The unique identifier of the funding card state to update.
If provided, it update the state of all active or suspended tokens that belongs to the funding card identified by issuerCardRefId mandatory if virtualCardId is not provided

virtualCardIdstring · máx: 64Opcional

The unique identifier of the virtual card state to update.
mandatory if issuerCardRefId is not provided

deviceBindingReferencestring · máx: 64Opcional

reference of the device binding process/link to the Virtual Card.The deviceBindingReference is used only with action UNBIND_DEVICE and APPROVE_DEVICE_BINDING (VTS only. Note that this field corresponds to the deviceIndex)

actionstring · enum · máx: 32Requerido

action to update the state Note: ERASE aims to be use in the context of GDPR compliancy, TSH will take care of erasing everything related to the given card/tokens when receiving this action.

Valores posibles:

reasonintegerOpcional

Reason of the token(s) state update
Here is the possible values:

• 11 : User decision
• 21 : Issuer decision
• 31 : Device lost
• 32 : Device stolen

Respuestas

200

Successful (no response body)

Sin contenido

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

post

/updateCardState

HTTPcURLJavaScriptPython

POST /gtep/igwapi/v2.0/updateCardState HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "issuerCardRefId": "text",
  "virtualCardId": "text",
  "deviceBindingReference": "text",
  "action": "SUSPEND",
  "reason": 1
}

Sin contenido

send a text message to the wallet

post

Overview

This method is used by the Issuer to send a textual message to the user, handle by the wallet application

This feature is only supported by Apple Pay and when Thales acts as a OEM broker for domestic schemes

Deep Link

The "Deep Link mechanism" consist in having the wallet application launching issuer mobile banking application when the end user press on message displayed . The Wallet application will launch the application and provides, as a parameter, the 'messageToken' to the issuer application so it can identifyc the message.

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Cuerpo

application/json

virtualCardIdstring · mín: 1 · máx: 64Opcional

Identifier of the virtual card to update

issuerCardRefIdstring · máx: 48Opcional

The unique identifier of the funding card.
This value is generated and manage by the issuer.
This value can be updated in case of funding PAN replacement by the issuer.

languagestring · mín: 1 · máx: 16Requerido

The value for this language localization code is an IETF Language (https://en.wikipedia.org/wiki/IETF_language_tag) Tag, such as “en-us”. Region Designator should be one of the valid ISO 3166-1 alpha-2 codes, which can be found in this link: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 Language Designator should use the two-letter ISO 639-1 standard (preferred) or the three-letter ISO 639-2 standard, which can be found in this link : https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

messagestring · mín: 1 · máx: 128Requerido

Textual message that must be sent to end user

messageTokenstring · mín: 1 · máx: 64Opcional

An optional value provided in case the issuer mobile application support deep link If messageToken is provided, the wallet application will enable the deep link feature for this particular message

expirationDatestring · mín: 1 · máx: 32Opcional

Expiration date of the message RFC3339 format.

Respuestas

200

sendMessage response payload

Sin contenido

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

post

/sendMessage

HTTPcURLJavaScriptPython

POST /gtep/igwapi/v2.0/sendMessage HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "virtualCardId": "text",
  "issuerCardRefId": "text",
  "language": "text",
  "message": "text",
  "messageToken": "text",
  "expirationDate": "text"
}

Sin contenido

check if TSH is healthy

get

This method is used by TSH to monitor Issuer health for monitoring purpose

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Requerido

Unique identifier of a give session (enrolment session or Life Cycle Management session), used to link inbound and outbound requests of the same session together

x-issuer-idstring · mín: 10 · máx: 10Requerido

Unique identifier used to identify the issuer

Respuestas

204

succesfull

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

500

Internal Server Error

get

/healthCheck

HTTPcURLJavaScriptPython

GET /gtep/igwapi/v2.0/healthCheck HTTP/1.1
Host: api.dbp.thalescloud.io
x-correlation-id: text
x-issuer-id: text
Accept: */*

Sin contenido