{"info":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","description":"<html><head></head><body><p>The purpose of this document is to describe the various operations available in Magensa TokenExchange v2.0 and their required &amp; optional input/output parameters. It also provides sample REST requests &amp; responses as reference for client developers.</p>\n<p>TokenExchange v2.0 enables clients to easily create &amp; redeem secure tokens for various sensitive data. This helps mitigate the risk of storing and use of sensitive data through industry-standard encryption algorithms and implementations.</p>\n<p>This service comprises of two endpoints, one primarily for creation of tokens and the other for redemption of tokens. This endpoint information is provided for each of the operations listed. Also, both endpoints provide swagger documentation at …/TokenV2Create/swagger/ and …/TokenV2Redeem/swagger/ respectively.</p>\n<p>TokenExchange v2.0 service provides the ability to create various types of tokens. For the generic “Token” type, the service creates the token that contains the secured data and returns it to the client. The client would have to store the token and later, provide it as input to redeem it. The other generic token type is “StoredToken” where the service creates and stores the token in user-defined containers and returns only the container name and the short token-key name to the client. Here, clients will need to set up containers to organize and store their tokens and can choose token-key names for a container to be auto-generated or user-generated. The various options available for auto-generated token-key names can be found in the section for “StoredToken” create operation. In case of user-generated token-key names, a regex expression can be provided for input validation. The client would have to provide the container name and token-key name as input to redeem it.</p>\n<p>Besides the two generic types, TokenExchange v2.0 also creates a few other token types, namely “PaymentToken” and “InvoiceToken”. Once created, these tokens are typically used in other Magensa services. Please contact your customer representative or support to better understand their workflows.</p>\n<p>The authentication for all TokenExchange v2.0 service calls require an “Authorization” HTTP header set as per HTTP BasicAuthentication scheme. The value should be the Base64 encoding of your Magensa credentials in the string format “CustomerCode/Username:Password”.</p>\n<h1 id=\"tokenexchange-v20-operations\">TokenExchange v2.0 Operations</h1>\n<p>Please note: A container must be created (or pre-exist) before Tokens can be created.</p>\n<p>Container names are globally unique.</p>\n<h2 id=\"tokenv2createapitokencreate\">/TokenV2Create/api/Token/create</h2>\n<h3 id=\"input-properties\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>tokenDataInput *</td>\n<td>string</td>\n<td>JSON string with token data type-id and corresponding token data.  <br>Supported token data types:  <br>1: PlainText  <br>2: HexString (upper-case only &amp; length multiple of 16 using ‘0’ padding)  <br>3: Encrypted Bulk Data (MagTek reader command 30 output)  <br>  <br>E.g., for plain-text token data:  <br><code>\"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\"</code></td>\n</tr>\n<tr>\n<td>validUntilUTC *</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>token</td>\n<td>string</td>\n<td>Token</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/Token/create Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/token/create\">https://svc71.magensa.net/Tokenv2Create/api/token/create</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 195</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"tokenDataInput\": \"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\",\n  \"validUntilUTC\": \"2050-12-31\",\n  \"tokenName\": \"Token Name\",\n  \"miscData\": \"Misc Data\",\n  \"customerTranRef\": \"X\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/Token/create Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 00:55:51 GMT</p>\n<p>Content-Length: 730</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"666cd40c-2791-4bbd-9839-0ac3aa079752\",\n  \"timestamp\": \"2020-12-29 00:55:51Z\",\n  \"customerTranRef\": \"X\",\n  \"token\": \"FA820120DFE0012434313631313765652D613963312D343033382D623434322D633533313666623530643065DFE00205312E322E30DFE0041B323035302D31322D33315430303A30303A30302E30303030303030DFE0050454657374DFE0061C323032302D31322D32395430303A35353A35312E343530353834315ADFE0071039393030303030303030303030303032DFE0080731303036313437DFE0092436363663643430632D323739312D346262642D393833392D306163336161303739373532DFE0111034C2A33CA35C0C98D33FD846217177DDDFE0120A90100100000000002517DFE0210A546F6B656E204E616D65DFE022094D6973632044617461DFE00320E3992711AFE69492357B7DB6A556CE352A9F6863A80B86FA653702BF5AE45CED\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2redeemapitokenredeem\">/TokenV2Redeem/api/Token/redeem</h2>\n<h3 id=\"input-properties-1\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>token</td>\n<td>string</td>\n<td>Token</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-1\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>tokenID</td>\n<td>string</td>\n<td>Token GUID</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>version</td>\n<td>string</td>\n<td>Token version</td>\n</tr>\n<tr>\n<td>validUntilUTC</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenData</td>\n<td>string</td>\n<td>Token data</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>transactionSourceID</td>\n<td>string</td>\n<td>Transaction source ID</td>\n</tr>\n<tr>\n<td>createdForMagTranID</td>\n<td>string</td>\n<td>Transaction ID of service call that created the token</td>\n</tr>\n<tr>\n<td>createdAt</td>\n<td>DateTime</td>\n<td>Timestamp when token was created</td>\n</tr>\n<tr>\n<td>redeemedAt</td>\n<td>DateTime</td>\n<td>Timestamp when token was redeemed</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Redeem/api/Token/redeem Request:</strong></p>\n<p>POST <a href=\"https://svc72.magensa.net/Tokenv2Redeem/api/token/redeem\">https://svc72.magensa.net/Tokenv2Redeem/api/token/redeem</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 626</p>\n<p>Host: svc72.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\",\n  \"token\": \"FA820120DFE0012434313631313765652D613963312D343033382D623434322D633533313666623530643065DFE00205312E322E30DFE0041B323035302D31322D33315430303A30303A30302E30303030303030DFE0050454657374DFE0061C323032302D31322D32395430303A35353A35312E343530353834315ADFE0071039393030303030303030303030303032DFE0080731303036313437DFE0092436363663643430632D323739312D346262642D393833392D306163336161303739373532DFE0111034C2A33CA35C0C98D33FD846217177DDDFE0120A90100100000000002517DFE0210A546F6B656E204E616D65DFE022094D6973632044617461DFE00320E3992711AFE69492357B7DB6A556CE352A9F6863A80B86FA653702BF5AE45CED\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Redeem/api/Token/redeem Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:00:57 GMT</p>\n<p>Content-Length: 488</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"625afa54-4b7c-450e-92fe-6dfe5b0434b4\",\n  \"timestamp\": \"2020-12-29 01:00:57Z\",\n  \"customerTranRef\": \"X\",\n  \"tokenID\": \"416117ee-a9c1-4038-b442-c5316fb50d0e\",\n  \"tokenName\": \"Token Name\",\n  \"version\": \"1.2.0\",\n  \"validUntilUTC\": \"2050-12-31T00:00:00\",\n  \"tokenData\": \"Token Data\",\n  \"miscData\": \"Misc Data\",\n  \"transactionSourceID\": null,\n  \"createdForMagTranID\": \"666cd40c-2791-4bbd-9839-0ac3aa079752\",\n  \"createdAt\": \"2020-12-29T00:55:51.4505841Z\",\n  \"redeemedAt\": \"2020-12-29T01:00:57.1745722Z\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapistoredtokencreate\">/TokenV2Create/api/StoredToken/create</h2>\n<h3 id=\"input-properties-2\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>tokenDataInput *</td>\n<td>string</td>\n<td>JSON string with token data type-id and corresponding token data.  <br>  <br>Supported token data types:  <br>  <br>1: PlainText  <br>  <br>2: HexString (upper-case only &amp; length multiple of 16 using ‘0’ padding)  <br>  <br>3: Encrypted Bulk Data (MagTek reader command 30 output)  <br>  <br>E.g., for plain-text token data:  <br>  <br>\"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\"</td>\n</tr>\n<tr>\n<td>validUntilUTC *</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>containerName *</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>tokenKey</td>\n<td>string</td>\n<td>Token key if user-generated token key</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-2\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>containerName</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>tokenKey</td>\n<td>string</td>\n<td>Stored Token key</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/StoredToken/create Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/storedtoken/create\">https://svc71.magensa.net/Tokenv2Create/api/storedtoken/create</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 242</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenDataInput\": \"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\",\n  \"validUntilUTC\": \"2050-12-31\",\n  \"tokenName\": \"Stored Token Name\",\n  \"miscData\": \"This is a stored token\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/StoredToken/create Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:05:34 GMT</p>\n<p>Content-Length: 186</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"e4091992-e1ec-4b39-8a12-ca6671c3b4ce\",\n  \"timestamp\": \"2020-12-29 01:05:13Z\",\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenKey\": \"0000000000107\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2redeemapistoredtokenredeem\">/TokenV2Redeem/api/StoredToken/redeem</h2>\n<h3 id=\"input-properties-3\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>containerName *</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>tokenKey *</td>\n<td>string</td>\n<td>Token key</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-3\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>tokenID</td>\n<td>string</td>\n<td>Token GUID</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>version</td>\n<td>string</td>\n<td>Token version</td>\n</tr>\n<tr>\n<td>validUntilUTC</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenData</td>\n<td>string</td>\n<td>Token data</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>transactionSourceID</td>\n<td>string</td>\n<td>Transaction source ID</td>\n</tr>\n<tr>\n<td>createdForMagTranID</td>\n<td>string</td>\n<td>Transaction ID of service call that created the token</td>\n</tr>\n<tr>\n<td>createdAt</td>\n<td>DateTime</td>\n<td>Timestamp when token was created</td>\n</tr>\n<tr>\n<td>redeemedAt</td>\n<td>DateTime</td>\n<td>Timestamp when token was redeemed</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Redeem/api/StoredToken/redeem Request:</strong></p>\n<p>POST <a href=\"https://svc72.magensa.net/Tokenv2Redeem/api/storedtoken/redeem\">https://svc72.magensa.net/Tokenv2Redeem/api/storedtoken/redeem</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 85</p>\n<p>Host: svc72.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenKey\": \"0000000000107\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Redeem/api/StoredToken/redeem Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:08:43 GMT</p>\n<p>Content-Length: 559</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"5a475665-91c5-42a1-b5ce-d2257bc9e6a6\",\n  \"timestamp\": \"2020-12-29 01:08:23Z\",\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenKey\": \"0000000000107\",\n  \"tokenID\": \"5c3c0c43-48b4-4c2d-af56-f5d58cdfc60a\",\n  \"tokenName\": \"Stored Token Name\",\n  \"version\": \"1.2.0\",\n  \"validUntilUTC\": \"2050-12-31T00:00:00\",\n  \"tokenData\": \"Token Data\",\n  \"miscData\": \"This is a stored token\",\n  \"transactionSourceID\": null,\n  \"createdForMagTranID\": \"e4091992-e1ec-4b39-8a12-ca6671c3b4ce\",\n  \"createdAt\": \"2020-12-29T01:05:13.4706242Z\",\n  \"redeemedAt\": \"2020-12-29T01:08:23.4074188Z\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapipaymenttokencreate\">/TokenV2Create/api/PaymentToken/create</h2>\n<h3 id=\"input-properties-4\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>pan *</td>\n<td>string</td>\n<td>PAN (length: 15-19)</td>\n</tr>\n<tr>\n<td>expirationDate *</td>\n<td>string</td>\n<td>Expiration Date as “YYMM”</td>\n</tr>\n<tr>\n<td>billingZIP</td>\n<td>string</td>\n<td>Billing ZIP (length: 5)</td>\n</tr>\n<tr>\n<td>cvv</td>\n<td>string</td>\n<td>CVV (length: 3-4)</td>\n</tr>\n<tr>\n<td>validUntilUTC *</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>transactionSourceID</td>\n<td>integer</td>\n<td>Transaction source ID (for Payment token, “5” or NULL)</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-4\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>token</td>\n<td>string</td>\n<td>Payment Token</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/PaymentToken/create Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/paymenttoken/create\">https://svc71.magensa.net/Tokenv2Create/api/paymenttoken/create</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 209</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\",\n  \"pan\": \"4444333322221111\",\n  \"expirationDate\": \"2012\",\n  \"billingZIP\": \"90740\",\n  \"cvv\": \"1234\",\n  \"validUntilUTC\": \"2050-12-31\",\n  \"tokenName\": \"Token Name\",\n  \"miscData\": \"Misc Data\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/PaymentToken/create Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:11:42 GMT</p>\n<p>Content-Length: 836</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"28a1d6c2-a8fa-4195-aeb5-d9951600b571\",\n  \"timestamp\": \"2020-12-29 01:11:42Z\",\n  \"customerTranRef\": \"X\",\n  \"token\": \"FA820155DFE0012466373662636462662D346231652D346536632D386461362D643265643964386537643835DFE00205312E322E30DFE0041B323035302D31322D33315430303A30303A30302E30303030303030DFE0050454657374DFE0061C323032302D31322D32395430313A31313A34322E343439323335355ADFE0071039393030303030303030303030303032DFE0080731303036313437DFE0092432386131643663322D613866612D343139352D616562352D643939353136303062353731DFE011401FF5D7AB2CF73A75C7A32D60454063C806C19552D729685E0E737BD419E50A74A6ECFEC250D6BFF0480D791D9303A4CE499BE68DAD94AD5A7C564292F895FE32DFE0120A90100100000000002519DFE0210A546F6B656E204E616D65DFE022094D6973632044617461DFE0250135DFE003200C336BA416A35D993846DB44B40A2F51FFAFD483316D00069B8EFB584DA7AFE0\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapiinvoicetokencreate\">/TokenV2Create/api/InvoiceToken/create</h2>\n<h3 id=\"input-properties-5\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>companyName *</td>\n<td>string</td>\n<td>Company Name (length: 2-42)</td>\n</tr>\n<tr>\n<td>Amount *</td>\n<td>string</td>\n<td>Amount (with 2 decimal places)</td>\n</tr>\n<tr>\n<td>taxAmount</td>\n<td>string</td>\n<td>Tax Amount (with 2 decimal places)</td>\n</tr>\n<tr>\n<td>taxPercent</td>\n<td>string</td>\n<td>Tax Percentage (with 3 decimal places)</td>\n</tr>\n<tr>\n<td>transactionReferenceNumber</td>\n<td>string</td>\n<td>Client transaction reference number (length: 3-16)</td>\n</tr>\n<tr>\n<td>termsAndTransactionInfo</td>\n<td>string</td>\n<td>Terms and transaction info (max length: 140)</td>\n</tr>\n<tr>\n<td>additionalInfo</td>\n<td>Array of key-value pair</td>\n<td>Additional info, an array (max length: 24) of key (max length: 32) and value (max length: 42) pairs</td>\n</tr>\n<tr>\n<td>processorName</td>\n<td>string</td>\n<td>Processor Name</td>\n</tr>\n<tr>\n<td>logoURL</td>\n<td>string</td>\n<td>Logo URL (max length: 255)</td>\n</tr>\n<tr>\n<td>primaryColor</td>\n<td>string</td>\n<td>Primary color in HEX (length: 4-7). For e.g., “FFFF”</td>\n</tr>\n<tr>\n<td>secondaryColor</td>\n<td>string</td>\n<td>Secondary color in HEX (length: 4-7)</td>\n</tr>\n<tr>\n<td>companyNameFontColor</td>\n<td>string</td>\n<td>Company Name font color in HEX (length: 4-7)</td>\n</tr>\n<tr>\n<td>validUntilUTC *</td>\n<td>DateTime</td>\n<td>Token valid until in UTC</td>\n</tr>\n<tr>\n<td>tokenName</td>\n<td>string</td>\n<td>Token Name</td>\n</tr>\n<tr>\n<td>miscData</td>\n<td>string</td>\n<td>Misc. data</td>\n</tr>\n<tr>\n<td>transactionSourceID</td>\n<td>integer</td>\n<td>Transaction source ID (for Invoice token, “1” or NULL)</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-5\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>tokenKey</td>\n<td>string</td>\n<td>Invoice Token key</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/InvoiceToken/create Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/invoicetoken/create\">https://svc71.magensa.net/Tokenv2Create/api/invoicetoken/create</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 626</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"validUntilUTC\": \"2050-12-31\",\n  \"companyName\": \"Inc.\",\n  \"amount\": \"10.00\",\n  \"taxAmount\": \"0.75\",\n  \"taxPercent\": \"7.500\",\n  \"transactionReferenceNumber\": \"12345\",\n  \"processorName\": \"Processor Name\",\n  \"additionalInfo\": [\n    {\n      \"Key\": \"Key-01\",\n      \"Value\": \"Value-01\"\n    },\n    {\n      \"Key\": \"Key-02\",\n      \"Value\": \"Value-02\"\n    },\n    {\n      \"Key\": \"Key-03\",\n      \"Value\": \"Value-03\"\n    }\n  ],\n  \"logoURL\": \"https://logourl.com\",\n  \"primaryColor\": \"FFFF\",\n  \"secondaryColor\": \"FFFF\",\n  \"companyNameFontColor\": \"FFFF\",\n  \"termsAndTransactionInfo\": \"asdf\",\n  \"tokenName\": \"Invoice Token Name\",\n  \"miscData\": \"This is an Invoice token\",\n  \"customerTranRef\": \"X\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/InvoiceToken/create Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:14:12 GMT</p>\n<p>Content-Length: 185</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n\"magTranID\":\"5baaa2b8-ad37-459a-ae44-5a632c55e904\",\n\"timestamp\":\"2020-12-29 01:13:57Z\",\n\"customerTranRef\":\"X\",\n\"tokenKey\":\"D49D0249-70F7-45FD-A92D-17390384FA36\",\n\"code\":\"0\",\n\"message\":\"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapicontainercreate\">/TokenV2Create/api/Container/create</h2>\n<h3 id=\"input-properties-6\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>containerName *</td>\n<td>string</td>\n<td>Container Name (max length: 50)</td>\n</tr>\n<tr>\n<td>containerTypeID</td>\n<td>integer</td>\n<td>0: Private (default)  <br>  <br>1: Shared</td>\n</tr>\n<tr>\n<td>tokenKeyTypeID *</td>\n<td>integer</td>\n<td>1: Auto-generated token key  <br>  <br>2: User-provided token key</td>\n</tr>\n<tr>\n<td>autoGenKeyMask</td>\n<td>string</td>\n<td>Auto-generated token key mask  <br>  <br>For e.g., ‘#########’ for a 9-character token key</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderTypeID</td>\n<td>integer</td>\n<td>1: Decimal / Numeric  <br>  <br>2: HEX  <br>  <br>3: Alphabetic  <br>  <br>4: Alpha-Numeric  <br>  <br>5: GUID</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderChar</td>\n<td>string</td>\n<td>Auto-generated token key mask character</td>\n</tr>\n<tr>\n<td>autoGenKeyPadChar</td>\n<td>string</td>\n<td>Auto-generated token key mask pad character</td>\n</tr>\n<tr>\n<td>userGenKeyRegex</td>\n<td>string</td>\n<td>User-generated token key validation regex</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-6\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>containerName</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/Container/create Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/container/create\">https://svc71.magensa.net/Tokenv2Create/api/container/create</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 209</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"containerName\": \"00001\",\n  \"tokenKeyTypeID\": 1,\n  \"autoGenKeyMask\": \"#############\",\n  \"autoGenKeyPlaceholderTypeID\": 1,\n  \"autoGenKeyPlaceholderChar\": \"#\",\n  \"autoGenKeyPadChar\": \"0\",\n  \"customerTranRef\": \"X\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/Container/create Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 22 Dec 2020 21:09:46 GMT</p>\n<p>Content-Length: 159</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"7989101b-67a7-420b-b077-ad434520cb24\",\n  \"timestamp\": \"2020-12-22 21:09:44Z\",\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapicontainerget\">/TokenV2Create/api/Container/get</h2>\n<h3 id=\"input-properties-7\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>containerName *</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-7\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>containerName</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>containerTypeID</td>\n<td>integer</td>\n<td>0: Private  <br>  <br>1: Shared</td>\n</tr>\n<tr>\n<td>containerTypeDescription</td>\n<td>string</td>\n<td>Private, Shared</td>\n</tr>\n<tr>\n<td>tokenKeyTypeID</td>\n<td>integer</td>\n<td>1: Auto-generated token key  <br>  <br>2: User-provided token key</td>\n</tr>\n<tr>\n<td>tokenKeyTypeDescription</td>\n<td>string</td>\n<td>Auto-generated token key, User-provided token key</td>\n</tr>\n<tr>\n<td>autoGenKeyMask</td>\n<td>string</td>\n<td>Auto-generated token key mask  <br>  <br>For e.g., ‘#########’ for a 9-character token key</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderTypeID</td>\n<td>integer</td>\n<td>1: Decimal / Numeric  <br>  <br>2: HEX  <br>  <br>3: Alphabetic  <br>  <br>4: Alpha-Numeric  <br>  <br>5: GUID</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderTypeDescription</td>\n<td>string</td>\n<td>Decimal, HEX, Alphabetic, Alpha-Numeric, GUID</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderChar</td>\n<td>string</td>\n<td>Auto-generated token key mask character</td>\n</tr>\n<tr>\n<td>autoGenKeyPadChar</td>\n<td>string</td>\n<td>Auto-generated token key mask pad character</td>\n</tr>\n<tr>\n<td>userGenKeyRegex</td>\n<td>string</td>\n<td>User-generated token key validation regex</td>\n</tr>\n<tr>\n<td>tokenCount</td>\n<td>integer</td>\n<td>Number of tokens in container</td>\n</tr>\n<tr>\n<td>nextAutoGenKey</td>\n<td>string</td>\n<td>Next token key in container if auto-generated</td>\n</tr>\n<tr>\n<td>dateCreated</td>\n<td>string</td>\n<td>Date container was created</td>\n</tr>\n<tr>\n<td>dateModified</td>\n<td>string</td>\n<td>Date container was modified</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/Container/get Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/container/get\">https://svc71.magensa.net/Tokenv2Create/api/container/get</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 55</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/Container/get Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:20:50 GMT</p>\n<p>Content-Length: 563</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"2a07ce41-c060-411e-8f8e-e20a58af3ec6\",\n  \"timestamp\": \"2020-12-29 01:20:50Z\",\n  \"customerTranRef\": \"X\",\n  \"container\": {\n    \"containerName\": \"00001\",\n    \"tokenKeyTypeID\": 1,\n    \"tokenKeyTypeDescription\": \"Auto-Generated Token Key\",\n    \"autoGenKeyMask\": \"#############\",\n    \"autoGenKeyPlaceholderTypeID\": 1,\n    \"autoGenKeyPlaceholderTypeDescription\": \"Decimal\",\n    \"autoGenKeyPlaceholderChar\": \"#\",\n    \"autoGenKeyPadChar\": \"0\",\n    \"userGenKeyRegEx\": null,\n    \"tokenCount\": 100,\n    \"nextAutoGenKey\": \"0000000000108\",\n    \"dateCreated\": \"2020-05-29 17:38:56Z\",\n    \"dateModified\": \"2020-12-29 01:05:13Z\"\n  },\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h2 id=\"tokenv2createapicontainerlist\">/TokenV2Create/api/Container/list</h2>\n<h3 id=\"input-properties-8\">INPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID</td>\n</tr>\n</tbody>\n</table>\n</div><p>Note: * = Required</p>\n<h3 id=\"output-properties-8\">OUTPUT PROPERTIES</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Property</th>\n<th>Value</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>magTranID</td>\n<td>string</td>\n<td>Transaction ID from target service provider</td>\n</tr>\n<tr>\n<td>timestamp</td>\n<td>string</td>\n<td>Transaction timestamp from Magensa</td>\n</tr>\n<tr>\n<td>customerTranRef</td>\n<td>string</td>\n<td>Client-assigned transaction reference ID from input</td>\n</tr>\n<tr>\n<td>code</td>\n<td>string</td>\n<td>Result code. For e.g., ‘0’ for success</td>\n</tr>\n<tr>\n<td>message</td>\n<td>string</td>\n<td>Result Message. For e.g., ‘OK’ for success</td>\n</tr>\n<tr>\n<td>containerName</td>\n<td>string</td>\n<td>Container Name</td>\n</tr>\n<tr>\n<td>containerTypeID</td>\n<td>integer</td>\n<td>0: Private  <br>  <br>1: Shared</td>\n</tr>\n<tr>\n<td>containerTypeDescription</td>\n<td>string</td>\n<td>Private, Shared</td>\n</tr>\n<tr>\n<td>tokenKeyTypeID</td>\n<td>integer</td>\n<td>1: Auto-generated token key  <br>  <br>2: User-provided token key</td>\n</tr>\n<tr>\n<td>tokenKeyTypeDescription</td>\n<td>string</td>\n<td>Auto-generated token key, User-provided token key</td>\n</tr>\n<tr>\n<td>autoGenKeyMask</td>\n<td>string</td>\n<td>Auto-generated token key mask  <br>  <br>For e.g., ‘#########’ for a 9-character token key</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderTypeID</td>\n<td>integer</td>\n<td>1: Decimal / Numeric  <br>  <br>2: HEX  <br>  <br>3: Alphabetic  <br>  <br>4: Alpha-Numeric  <br>  <br>5: GUID</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderTypeDescription</td>\n<td>string</td>\n<td>Decimal, HEX, Alphabetic, Alpha-Numeric, GUID</td>\n</tr>\n<tr>\n<td>autoGenKeyPlaceholderChar</td>\n<td>string</td>\n<td>Auto-generated token key mask character</td>\n</tr>\n<tr>\n<td>autoGenKeyPadChar</td>\n<td>string</td>\n<td>Auto-generated token key mask pad character</td>\n</tr>\n<tr>\n<td>userGenKeyRegex</td>\n<td>string</td>\n<td>User-generated token key validation regex</td>\n</tr>\n<tr>\n<td>tokenCount</td>\n<td>integer</td>\n<td>Number of tokens in container</td>\n</tr>\n<tr>\n<td>nextAutoGenKey</td>\n<td>string</td>\n<td>Next token key in container if auto-generated</td>\n</tr>\n<tr>\n<td>dateCreated</td>\n<td>string</td>\n<td>Date container was created</td>\n</tr>\n<tr>\n<td>dateModified</td>\n<td>string</td>\n<td>Date container was modified</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Sample /TokenV2Create/api/Container/list Request:</strong></p>\n<p>POST <a href=\"https://svc71.magensa.net/Tokenv2Create/api/container/list\">https://svc71.magensa.net/Tokenv2Create/api/container/list</a> HTTP/1.1</p>\n<p>Accept-Encoding: gzip,deflate</p>\n<p>Content-Type: application/json</p>\n<p>Authorization: Basic {AUTHORIZATION HEADER VALUE}</p>\n<p>Content-Length: 28</p>\n<p>Host: svc71.magensa.net</p>\n<p>Connection: Keep-Alive</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerTranRef\": \"X\"\n}\n\n</code></pre>\n<p><strong>Sample /TokenV2Create/api/Container/list Response:</strong></p>\n<p>HTTP/1.1 200 OK</p>\n<p>Content-Type: application/json; charset=utf-8</p>\n<p>Server: Microsoft-IIS/10.0</p>\n<p>X-Powered-By: ASP.NET</p>\n<p>Date: Tue, 29 Dec 2020 01:24:46 GMT</p>\n<p>Content-Length: 566</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"magTranID\": \"033ddd6f-4d6c-4426-83f4-65fa048bec18\",\n  \"timestamp\": \"2020-12-29 01:24:46Z\",\n  \"customerTranRef\": \"X\",\n  \"containers\": [\n    {\n      \"containerName\": \"00001\",\n      \"tokenKeyTypeID\": 1,\n      \"tokenKeyTypeDescription\": \"Auto-Generated Token Key\",\n      \"autoGenKeyMask\": \"#############\",\n      \"autoGenKeyPlaceholderTypeID\": 1,\n      \"autoGenKeyPlaceholderTypeDescription\": \"Decimal\",\n      \"autoGenKeyPlaceholderChar\": \"#\",\n      \"autoGenKeyPadChar\": \"0\",\n      \"userGenKeyRegEx\": null,\n      \"tokenCount\": 100,\n      \"nextAutoGenKey\": \"0000000000108\",\n      \"dateCreated\": \"2020-05-29 17:38:56Z\",\n      \"dateModified\": \"2020-12-29 01:05:13Z\"\n    }\n  ],\n  \"code\": \"0\",\n  \"message\": \"OK\"\n}\n\n</code></pre>\n<h1 id=\"fault-codes-and-reasons\">Fault Codes and Reasons</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Fault Code</th>\n<th>Fault Reason</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>2101</td>\n<td>Container create failed</td>\n</tr>\n<tr>\n<td>2102</td>\n<td>Container get failed</td>\n</tr>\n<tr>\n<td>2103</td>\n<td>Container list failed</td>\n</tr>\n<tr>\n<td>2104</td>\n<td>Token storage failed</td>\n</tr>\n<tr>\n<td>2105</td>\n<td>Token get failed</td>\n</tr>\n<tr>\n<td>2106</td>\n<td>TokenInputData parsing failed</td>\n</tr>\n<tr>\n<td>2107</td>\n<td>Token parsing failed</td>\n</tr>\n<tr>\n<td>2108</td>\n<td>Token slot is not valid</td>\n</tr>\n<tr>\n<td>2109</td>\n<td>Token verification failed</td>\n</tr>\n<tr>\n<td>2110</td>\n<td>Token authorization failed</td>\n</tr>\n<tr>\n<td>2111</td>\n<td>Token has expired</td>\n</tr>\n<tr>\n<td>2112</td>\n<td>Token decryption failed</td>\n</tr>\n<tr>\n<td>2113</td>\n<td>ValidUntilUTC is not valid</td>\n</tr>\n<tr>\n<td>2114</td>\n<td>PAN is not valid</td>\n</tr>\n<tr>\n<td>2115</td>\n<td>Expiration date is not valid</td>\n</tr>\n<tr>\n<td>2116</td>\n<td>AdditionalInfo is not valid</td>\n</tr>\n<tr>\n<td>2117</td>\n<td>Amount is not valid</td>\n</tr>\n<tr>\n<td>2118</td>\n<td>CompanyName is not valid</td>\n</tr>\n<tr>\n<td>2119</td>\n<td>CompanyNameFontColor is not valid</td>\n</tr>\n<tr>\n<td>2120</td>\n<td>LogoURL is not valid</td>\n</tr>\n<tr>\n<td>2121</td>\n<td>Color is not valid</td>\n</tr>\n<tr>\n<td>2122</td>\n<td>TaxAmount is not valid</td>\n</tr>\n<tr>\n<td>2123</td>\n<td>TaxPercent is not valid</td>\n</tr>\n<tr>\n<td>2124</td>\n<td>TermsAndTransactionInfo is not valid</td>\n</tr>\n<tr>\n<td>2125</td>\n<td>TransactionReferenceNumber is not valid</td>\n</tr>\n<tr>\n<td>2126</td>\n<td>Billing ZIP is not valid</td>\n</tr>\n<tr>\n<td>2127</td>\n<td>CVV is not valid</td>\n</tr>\n<tr>\n<td>2128</td>\n<td>Transaction Source ID is not valid</td>\n</tr>\n<tr>\n<td>5000</td>\n<td>Unexpected Error</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"TokenExchange v2.0 Operations","slug":"tokenexchange-v20-operations"},{"content":"Fault Codes and Reasons","slug":"fault-codes-and-reasons"}],"owner":"33729815","collectionId":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","publishedId":"2sAYdkJVEy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-05T16:25:12.000Z"},"item":[{"name":"/Token/create","id":"bf929fe4-d9a1-4909-84ef-0d40e1d47818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\"tokenDataInput\": \"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\",\n\"validUntilUTC\": \"2050-12-31\",\n\"tokenName\": \"Token Name\",\n\"miscData\": \"Misc Data\",\n\"customerTranRef\": \"X\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/token/create","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","token","create"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf929fe4-d9a1-4909-84ef-0d40e1d47818"},{"name":"/Token/redeem","id":"25426878-b1d0-4951-84a7-feb74c67e5f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\",\n  \"token\": \"FA820120DFE0012434313631313765652D613963312D343033382D623434322D633533313666623530643065DFE00205312E322E30DFE0041B323035302D31322D33315430303A30303A30302E30303030303030DFE0050454657374DFE0061C323032302D31322D32395430303A35353A35312E343530353834315ADFE0071039393030303030303030303030303032DFE0080731303036313437DFE0092436363663643430632D323739312D346262642D393833392D306163336161303739373532DFE0111034C2A33CA35C0C98D33FD846217177DDDFE0120A90100100000000002517DFE0210A546F6B656E204E616D65DFE022094D6973632044617461DFE00320E3992711AFE69492357B7DB6A556CE352A9F6863A80B86FA653702BF5AE45CED\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Redeem/api/token/redeem","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Redeem","api","token","redeem"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"25426878-b1d0-4951-84a7-feb74c67e5f9"},{"name":"/StoredToken/create","id":"cb13ca7e-2e61-4ea7-a1d7-60731e3cac83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenDataInput\": \"{\\\"TokenDataTypeID\\\": \\\"1\\\",\\\"PlainText\\\": \\\"Token Data\\\"}\",\n  \"validUntilUTC\": \"2050-12-31\",\n  \"tokenName\": \"Stored Token Name\",\n  \"miscData\": \"This is a stored token\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/storedtoken/create","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","storedtoken","create"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb13ca7e-2e61-4ea7-a1d7-60731e3cac83"},{"name":"/StoredToken/redeem","id":"1080a0b6-cbe4-4057-a0bb-0de924ea2dba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\",\n  \"tokenKey\": \"0000000000107\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/storedtoken/redeem","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","storedtoken","redeem"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"1080a0b6-cbe4-4057-a0bb-0de924ea2dba"},{"name":"/PaymentToken/create","id":"078af0d3-89c4-4c03-bf59-c700b87cca2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\",\n  \"pan\": \"4444333322221111\",\n  \"expirationDate\": \"2012\",\n  \"billingZIP\": \"90740\",\n  \"cvv\": \"1234\",\n  \"validUntilUTC\": \"2050-12-31\",\n  \"tokenName\": \"Token Name\",\n  \"miscData\": \"Misc Data\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/paymenttoken/create","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","paymenttoken","create"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"078af0d3-89c4-4c03-bf59-c700b87cca2f"},{"name":"/InvoiceToken/create","id":"24b8f036-5fa3-4cb3-9157-0acfb4dd2ef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"validUntilUTC\": \"2050-12-31\",\n  \"companyName\": \"Inc.\",\n  \"amount\": \"10.00\",\n  \"taxAmount\": \"0.75\",\n  \"taxPercent\": \"7.500\",\n  \"transactionReferenceNumber\": \"12345\",\n  \"processorName\": \"Processor Name\",\n  \"additionalInfo\": [\n    {\n      \"Key\": \"Key-01\",\n      \"Value\": \"Value-01\"\n    },\n    {\n      \"Key\": \"Key-02\",\n      \"Value\": \"Value-02\"\n    },\n    {\n      \"Key\": \"Key-03\",\n      \"Value\": \"Value-03\"\n    }\n  ],\n  \"logoURL\": \"https://logourl.com\",\n  \"primaryColor\": \"FFFF\",\n  \"secondaryColor\": \"FFFF\",\n  \"companyNameFontColor\": \"FFFF\",\n  \"termsAndTransactionInfo\": \"asdf\",\n  \"tokenName\": \"Invoice Token Name\",\n  \"miscData\": \"This is an Invoice token\",\n  \"customerTranRef\": \"X\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/invoicetoken/create","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","invoicetoken","create"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"24b8f036-5fa3-4cb3-9157-0acfb4dd2ef0"},{"name":"/Container/create","id":"a0535467-cbac-436e-98e3-345125541e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"containerName\": \"00001\",\n  \"tokenKeyTypeID\": 1,\n  \"autoGenKeyMask\": \"#############\",\n  \"autoGenKeyPlaceholderTypeID\": 1,\n  \"autoGenKeyPlaceholderChar\": \"#\",\n  \"autoGenKeyPadChar\": \"0\",\n  \"customerTranRef\": \"X\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/container/create","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","container","create"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0535467-cbac-436e-98e3-345125541e4e"},{"name":"/Container/get","id":"1847d7e8-044e-4c05-95c7-0a3ee43c4859","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\",\n  \"containerName\": \"00001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/container/get","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","container","get"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"1847d7e8-044e-4c05-95c7-0a3ee43c4859"},{"name":"/Container/List","id":"116f611d-8509-4c8c-8377-1d0757d9202d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"customerTranRef\": \"X\"\n}","options":{"raw":{"language":"json"}}},"url":"https://svc2.magensa.net/Tokenv2Create/api/container/list","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","id":"16ffb3fe-047f-45d7-b18d-ec1a8a231d05","name":"Token Exchange v2","type":"collection"}},"urlObject":{"path":["Tokenv2Create","api","container","list"],"host":["https://svc2.magensa.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"116f611d-8509-4c8c-8377-1d0757d9202d"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{CustomerCode}}/{{Username}}"},{"key":"password","value":"{{Password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"6f2c1f04-2f54-42fd-9f1b-ade8e0bce7b3","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"64023fb9-c0b6-4c5c-a0a0-2259430e9e5f","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"Tokenv2BaseURL","value":"https://svc2.magensa.net","type":"default"}]}