UNPKG

cybersource-rest-client

Version:

Node.js SDK for the CyberSource REST API

116 lines (76 loc) 4.33 kB
# CyberSource.TokenApi All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**getCardArtAsset**](TokenApi.md#getCardArtAsset) | **GET** /tms/v2/tokens/{instrumentIdentifierId}/{tokenProvider}/assets/{assetType} | Retrieve Card Art [**postTokenPaymentCredentials**](TokenApi.md#postTokenPaymentCredentials) | **POST** /tms/v2/tokens/{tokenId}/payment-credentials | Generate Payment Credentials for a TMS Token <a name="getCardArtAsset"></a> # **getCardArtAsset** > InlineResponse200 getCardArtAsset(instrumentIdentifierId, tokenProvider, assetType) Retrieve Card Art Retrieves Card Art for a specific Instrument Identifier. The Card Art is a visual representation of the cardholder's payment card. Card Art is only available if a Network Token is successfully provisioned. ### Example ```javascript var CyberSource = require('CyberSource'); var apiInstance = new CyberSource.TokenApi(); var instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier. var tokenProvider = "tokenProvider_example"; // String | The token provider. var assetType = "assetType_example"; // String | The type of asset. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getCardArtAsset(instrumentIdentifierId, tokenProvider, assetType, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. | **tokenProvider** | **String**| The token provider. | **assetType** | **String**| The type of asset. | ### Return type [**InlineResponse200**](InlineResponse200.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/json;charset=utf-8 <a name="postTokenPaymentCredentials"></a> # **postTokenPaymentCredentials** > 'String' postTokenPaymentCredentials(tokenId, postPaymentCredentialsRequest, opts) Generate Payment Credentials for a TMS Token | | | | | --- | --- | --- | |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier. ### Example ```javascript var CyberSource = require('CyberSource'); var apiInstance = new CyberSource.TokenApi(); var tokenId = "tokenId_example"; // String | The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. var postPaymentCredentialsRequest = new CyberSource.PostPaymentCredentialsRequest(); // PostPaymentCredentialsRequest | var opts = { 'profileId': "profileId_example" // String | The Id of a profile containing user specific TMS configuration. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.postTokenPaymentCredentials(tokenId, postPaymentCredentialsRequest, opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tokenId** | **String**| The Id of a token representing a Customer, Payment Instrument or Instrument Identifier. | **postPaymentCredentialsRequest** | [**PostPaymentCredentialsRequest**](PostPaymentCredentialsRequest.md)| | **profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional] ### Return type **'String'** ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/jose;charset=utf-8