From 2317d605ece11fd3fc33ded1e52cc6a7b91291f8 Mon Sep 17 00:00:00 2001
From: "Shiva Shankaran, Akshaya"
+* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
+* param.
+ */
+{{/emitJSDoc}} exports.prototype.paramToString = function(param) {
+ if (param == undefined || param == null) {
+ return '';
+ }
+ if (param instanceof Date) {
+ return param.toJSON();
+ }
+ return param.toString();
+ };
+
+{{#emitJSDoc}} /**
+ * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
+ * NOTE: query parameters are not handled here.
+ * @param {String} path The path to append to the base URL.
+ * @param {Object} pathParams The parameter values to append.
+ * @returns {String} The encoded path with parameter values substituted.
+ */
+{{/emitJSDoc}} exports.prototype.buildUrl = function(path, pathParams) {
+ if (!path.match(/^\//)) {
+ path = '/' + path;
+ }
+ var url = this.basePath + path;
+ var _this = this;
+ url = url.replace(/\{([\w-]+)\}/g, function(fullMatch, key) {
+ var value;
+ if (pathParams.hasOwnProperty(key)) {
+ value = _this.paramToString(pathParams[key]);
+ } else {
+ value = fullMatch;
+ }
+ return encodeURIComponent(value);
+ });
+ return url;
+ };
+
+{{#emitJSDoc}} /**
+ * Checks whether the given content type represents JSON.
+ * JSON content type examples:
+ *
+ *
+ * @param {String} contentType The MIME content type to check.
+ * @returns {Boolean} true if contentType represents JSON, otherwise false.
+ */
+{{/emitJSDoc}} exports.prototype.isJsonMime = function(contentType) {
+ return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
+ };
+
+{{#emitJSDoc}} /**
+ * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+ * @param {Array.true if param represents a file.
+ */
+{{/emitJSDoc}} exports.prototype.isFileParam = function(param) {
+ // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
+ if (typeof require === 'function') {
+ var fs;
+ try {
+ fs = require('fs');
+ } catch (err) {}
+ if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
+ return true;
+ }
+ }
+ // Buffer in Node.js
+ if (typeof Buffer === 'function' && param instanceof Buffer) {
+ return true;
+ }
+ // Blob in browser
+ if (typeof Blob === 'function' && param instanceof Blob) {
+ return true;
+ }
+ // File in browser (it seems File object is also instance of Blob, but keep this for safe)
+ if (typeof File === 'function' && param instanceof File) {
+ return true;
+ }
+ return false;
+ };
+
+{{#emitJSDoc}} /**
+ * Normalizes parameter values:
+ *
+ *
+ * @param {Object.csv
+ * @const
+ */
+ CSV: ',',
+ /**
+ * Space-separated values. Value: ssv
+ * @const
+ */
+ SSV: ' ',
+ /**
+ * Tab-separated values. Value: tsv
+ * @const
+ */
+ TSV: '\t',
+ /**
+ * Pipe(|)-separated values. Value: pipes
+ * @const
+ */
+ PIPES: '|',
+ /**
+ * Native array. Value: multi
+ * @const
+ */
+ MULTI: 'multi'
+ };
+
+ /**
+ * Builds a string representation of an array-type actual parameter, according to the given collection format.
+ * @param {Array} param An array parameter.
+ * @param {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
+ * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
+ * param as is if collectionFormat is multi.
+ */
+{{/emitJSDoc}} exports.prototype.buildCollectionParam = function buildCollectionParam(param, collectionFormat) {
+ if (param == null) {
+ return null;
+ }
+ switch (collectionFormat) {
+ case 'csv':
+ return param.map(this.paramToString).join(',');
+ case 'ssv':
+ return param.map(this.paramToString).join(' ');
+ case 'tsv':
+ return param.map(this.paramToString).join('\t');
+ case 'pipes':
+ return param.map(this.paramToString).join('|');
+ case 'multi':
+ // return the array directly as SuperAgent will handle it as expected
+ return param.map(this.paramToString);
+ default:
+ throw new Error('Unknown collection format: ' + collectionFormat);
+ }
+ };
+
+{{#emitJSDoc}} /**
+ * Applies authentication headers to the request.
+ * @param {Object} request The request object created by a superagent() call.
+ * @param {Array.data will be converted to this type.
+ * @returns A value of the specified type.
+ */
+{{/emitJSDoc}} exports.prototype.deserialize = function deserialize(response, returnType) {
+ if (response == null || returnType == null || response.status == 204) {
+ return null;
+ }
+ // Rely on SuperAgent for parsing response body.
+ // See http://visionmedia.github.io/superagent/#parsing-response-bodies
+ var data = response.body;
+ if (data == null || (typeof data === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length)) {
+ // SuperAgent does not always produce a body; use the unparsed response as a fallback
+ data = response.text;
+ }
+ return exports.convertToType(data, returnType);
+ };
+
+ // Code added by Infosys dev team
+
+ var AuthenticationSDK = require('cybersource-rest-auth');
+ /**
+ * This method will set the merchantConfig object global
+ *
+ * @param {Configuration} configObject merchantConfiguration properties.
+ */
+ exports.prototype.setConfiguration = function (configObject) {
+
+ this.merchantConfig = new AuthenticationSDK.MerchantConfig(configObject);
+ this.constants = AuthenticationSDK.Constants;
+ this.basePath = this.constants.HTTP_URL_PREFIX + this.merchantConfig.getRequestHost();
+ this.logger = AuthenticationSDK.Logger.getLogger(this.merchantConfig);
+ }
+
+ /**
+ * This method is to generate headers for http and jwt authentication.
+ *
+ * @param {String} httpMethod
+ * @param {String} requestTarget
+ * @param {String} requestBody
+ */
+ exports.prototype.callAuthenticationHeader = function (httpMethod, requestTarget, requestBody, headerParams) {
+
+ this.merchantConfig.setRequestTarget(requestTarget);
+ this.merchantConfig.setRequestType(httpMethod)
+ this.merchantConfig.setRequestJsonData(requestBody);
+
+ this.logger.info('Authentication Type : ' + this.merchantConfig.getAuthenticationType());
+ this.logger.info(this.constants.REQUEST_TYPE + ' : ' + httpMethod.toUpperCase());
+
+ var token = AuthenticationSDK.Authorization.getToken(this.merchantConfig, this.logger);
+
+ if (this.merchantConfig.getAuthenticationType().toLowerCase() === this.constants.JWT) {
+ token = 'Bearer ' + token;
+ headerParams['Authorization'] = token;
+ this.logger.info(this.constants.AUTHORIZATION + ' : ' + token);
+ }
+ else if (this.merchantConfig.getAuthenticationType().toLowerCase() === this.constants.HTTP) {
+ var date = new Date(Date.now()).toUTCString();
+
+ if (httpMethod.toLowerCase() === this.constants.POST
+ || httpMethod.toLowerCase() === this.constants.PATCH
+ || httpMethod.toLowerCase() === this.constants.PUT) {
+ var digest = AuthenticationSDK.PayloadDigest.generateDigest(this.merchantConfig, this.logger);
+ digest = this.constants.SIGNATURE_ALGORITHAM + digest;
+ this.logger.info(this.constants.DIGEST + " : " + digest);
+ headerParams['digest'] = digest;
+ }
+
+ headerParams['v-c-merchant-id'] = this.merchantConfig.getMerchantID();
+ headerParams['date'] = date;
+ headerParams['host'] = this.merchantConfig.getRequestHost();
+ headerParams['signature'] = token;
+ headerParams['User-Agent'] = this.constants.USER_AGENT_VALUE;
+
+ this.logger.info('v-c-merchant-id : ' + this.merchantConfig.getMerchantID());
+ this.logger.info('date : ' + date);
+ this.logger.info('host : ' + this.merchantConfig.getRequestHost());
+ this.logger.info('signature : ' + token);
+ this.logger.info('User-Agent : ' + headerParams['User-Agent']);
+ this.logger.info(this.constants.END_TRANSACTION);
+ }
+
+ return headerParams;
+ }
+
+{{#emitJSDoc}}{{^usePromises}} /**
+ * Callback function to receive the result of the operation.
+ * @callback module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient~callApiCallback
+ * @param {String} error Error message, if any.
+ * @param data The data returned by the service call.
+ * @param {String} response The complete HTTP response.
+ */
+
+{{/usePromises}} /**
+ * Invokes the REST service using the supplied settings and parameters.
+ * @param {String} path The base URL to invoke.
+ * @param {String} httpMethod The HTTP method to use.
+ * @param {Object.data will be converted to this type.
+ * @returns An instance of the specified type or null or undefined if data is null or undefined.
+ */
+{{/emitJSDoc}} exports.convertToType = function(data, type) {
+ if (data === null || data === undefined)
+ return data
+
+ switch (type) {
+ case 'Boolean':
+ return Boolean(data);
+ case 'Integer':
+ return parseInt(data, 10);
+ case 'Number':
+ return parseFloat(data);
+ case 'String':
+ return String(data);
+ case 'Date':
+ return this.parseDate(String(data));
+ case 'Blob':
+ return data;
+ default:
+ if (type === Object) {
+ // generic object, return directly
+ return data;
+ } else if (typeof type === 'function') {
+ // for model type like: User
+ return type.constructFromObject(data);
+ } else if (Array.isArray(type)) {
+ // for array type like: ['String']
+ var itemType = type[0];
+ return data.map(function(item) {
+ return exports.convertToType(item, itemType);
+ });
+ } else if (typeof type === 'object') {
+ // for plain object type like: {'String': 'Integer'}
+ var keyType, valueType;
+ for (var k in type) {
+ if (type.hasOwnProperty(k)) {
+ keyType = k;
+ valueType = type[k];
+ break;
+ }
+ }
+ var result = {};
+ for (var k in data) {
+ if (data.hasOwnProperty(k)) {
+ var key = exports.convertToType(k, keyType);
+ var value = exports.convertToType(data[k], valueType);
+ result[key] = value;
+ }
+ }
+ return result;
+ } else {
+ // for unknown type, return the data directly
+ return data;
+ }
+ }
+ };
+
+{{#emitJSDoc}} /**
+ * Constructs a new map or array model from REST data.
+ * @param data {Object|Array} The REST data.
+ * @param obj {Object|Array} The target object or array.
+ */
+{{/emitJSDoc}} exports.constructFromObject = function(data, obj, itemType) {
+ if (Array.isArray(data)) {
+ for (var i = 0; i < data.length; i++) {
+ if (data.hasOwnProperty(i))
+ obj[i] = exports.convertToType(data[i], itemType);
+ }
+ } else {
+ for (var k in data) {
+ if (data.hasOwnProperty(k))
+ obj[k] = exports.convertToType(data[k], itemType);
+ }
+ }
+ };
+
+{{#emitJSDoc}} /**
+ * The default API client implementation.
+ * @type {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient}
+ */
+{{/emitJSDoc}} exports.instance = new exports();
+
+ return exports;
+}));
diff --git a/generator/cybersource-javascript-template/README.mustache b/generator/cybersource-javascript-template/README.mustache
new file mode 100644
index 00000000..4962803a
--- /dev/null
+++ b/generator/cybersource-javascript-template/README.mustache
@@ -0,0 +1,183 @@
+# {{projectName}}
+
+{{moduleName}} - JavaScript client for {{projectName}}
+{{#appDescription}}
+{{{appDescription}}}
+{{/appDescription}}
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: {{appVersion}}
+- Package version: {{projectVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/),
+please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install {{{projectName}}} --save
+```
+
+##### Local development
+
+To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
+into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+npm link
+```
+
+Finally, switch to the directory you want to use your {{{projectName}}} from, and run:
+
+```shell
+npm link /path/to/{{baseName}} property.
+ * @enum {{=<% %>=}}{<%datatype%>}<%={{ }}=%>
+ * @readonly
+ */{{/emitJSDoc}}
+ exports.{{datatypeWithEnum}} = {
+ {{#allowableValues}}
+ {{#enumVars}}
+{{#emitJSDoc}}
+ /**
+ * value: {{{value}}}
+ * @const
+ */
+{{/emitJSDoc}}
+ "{{name}}": {{{value}}}{{^-last}},
+ {{/-last}}
+ {{/enumVars}}
+ {{/allowableValues}}
+ };
diff --git a/generator/cybersource-javascript-template/es6/.babelrc.mustache b/generator/cybersource-javascript-template/es6/.babelrc.mustache
new file mode 100644
index 00000000..bcb6ee8d
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/.babelrc.mustache
@@ -0,0 +1,3 @@
+{
+ "presets": ["es2015", "stage-0"]
+}
\ No newline at end of file
diff --git a/generator/cybersource-javascript-template/es6/ApiClient.mustache b/generator/cybersource-javascript-template/es6/ApiClient.mustache
new file mode 100644
index 00000000..17e90001
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/ApiClient.mustache
@@ -0,0 +1,593 @@
+{{>licenseInfo}}
+
+import superagent from "superagent";
+import querystring from "querystring";
+
+{{#emitJSDoc}}/**
+* @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient
+* @version {{projectVersion}}
+*/
+
+/**
+* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
+* application to use this class directly - the *Api and model classes provide the public API for the service. The
+* contents of this file should be regarded as internal but are documented for completeness.
+* @alias module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient
+* @class
+*/{{/emitJSDoc}}
+export default class ApiClient {
+ constructor() {
+ {{#emitJSDoc}}/**
+ * The base URL against which to resolve every API call's (relative) path.
+ * @type {String}
+ * @default {{{basePath}}}
+ */{{/emitJSDoc}}
+ this.basePath = '{{{basePath}}}'.replace(/\/+$/, '');
+
+ {{#emitJSDoc}}/**
+ * The authentication methods to be included for all API calls.
+ * @type {Array.param.
+ */{{/emitJSDoc}}
+ paramToString(param) {
+ if (param == undefined || param == null) {
+ return '';
+ }
+ if (param instanceof Date) {
+ return param.toJSON();
+ }
+
+ return param.toString();
+ }
+
+ {{#emitJSDoc}}/**
+ * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
+ * NOTE: query parameters are not handled here.
+ * @param {String} path The path to append to the base URL.
+ * @param {Object} pathParams The parameter values to append.
+ * @returns {String} The encoded path with parameter values substituted.
+ */{{/emitJSDoc}}
+ buildUrl(path, pathParams) {
+ if (!path.match(/^\//)) {
+ path = '/' + path;
+ }
+
+ var url = this.basePath + path;
+ url = url.replace(/\{([\w-]+)\}/g, (fullMatch, key) => {
+ var value;
+ if (pathParams.hasOwnProperty(key)) {
+ value = this.paramToString(pathParams[key]);
+ } else {
+ value = fullMatch;
+ }
+
+ return encodeURIComponent(value);
+ });
+
+ return url;
+ }
+
+ {{#emitJSDoc}}/**
+ * Checks whether the given content type represents JSON.
+ * JSON content type examples:
+ *
+ *
+ * @param {String} contentType The MIME content type to check.
+ * @returns {Boolean} true if contentType represents JSON, otherwise false.
+ */{{/emitJSDoc}}
+ isJsonMime(contentType) {
+ return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
+ }
+
+ {{#emitJSDoc}}/**
+ * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
+ * @param {Array.true if param represents a file.
+ */
+ {{/emitJSDoc}}
+ isFileParam(param) {
+ // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
+ if (typeof require === 'function') {
+ let fs;
+ try {
+ fs = require('fs');
+ } catch (err) {}
+ if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
+ return true;
+ }
+ }
+
+ // Buffer in Node.js
+ if (typeof Buffer === 'function' && param instanceof Buffer) {
+ return true;
+ }
+
+ // Blob in browser
+ if (typeof Blob === 'function' && param instanceof Blob) {
+ return true;
+ }
+
+ // File in browser (it seems File object is also instance of Blob, but keep this for safe)
+ if (typeof File === 'function' && param instanceof File) {
+ return true;
+ }
+
+ return false;
+ }
+
+ {{#emitJSDoc}}/**
+ * Normalizes parameter values:
+ *
+ *
+ * @param {Object.csv
+ * @const
+ */{{/emitJSDoc}}
+ CSV: ',',
+
+ {{#emitJSDoc}}/**
+ * Space-separated values. Value: ssv
+ * @const
+ */{{/emitJSDoc}}
+ SSV: ' ',
+
+ {{#emitJSDoc}}/**
+ * Tab-separated values. Value: tsv
+ * @const
+ */{{/emitJSDoc}}
+ TSV: '\t',
+
+ {{#emitJSDoc}}/**
+ * Pipe(|)-separated values. Value: pipes
+ * @const
+ */{{/emitJSDoc}}
+ PIPES: '|',
+
+ {{#emitJSDoc}}/**
+ * Native array. Value: multi
+ * @const
+ */{{/emitJSDoc}}
+ MULTI: 'multi'
+ };
+
+ {{#emitJSDoc}}/**
+ * Builds a string representation of an array-type actual parameter, according to the given collection format.
+ * @param {Array} param An array parameter.
+ * @param {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
+ * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
+ * param as is if collectionFormat is multi.
+ */{{/emitJSDoc}}
+ buildCollectionParam(param, collectionFormat) {
+ if (param == null) {
+ return null;
+ }
+ switch (collectionFormat) {
+ case 'csv':
+ return param.map(this.paramToString).join(',');
+ case 'ssv':
+ return param.map(this.paramToString).join(' ');
+ case 'tsv':
+ return param.map(this.paramToString).join('\t');
+ case 'pipes':
+ return param.map(this.paramToString).join('|');
+ case 'multi':
+ //return the array directly as SuperAgent will handle it as expected
+ return param.map(this.paramToString);
+ default:
+ throw new Error('Unknown collection format: ' + collectionFormat);
+ }
+ }
+
+ {{#emitJSDoc}}/**
+ * Applies authentication headers to the request.
+ * @param {Object} request The request object created by a superagent() call.
+ * @param {Array.data will be converted to this type.
+ * @returns A value of the specified type.
+ */
+ {{/emitJSDoc}}
+ deserialize(response, returnType) {
+ if (response == null || returnType == null || response.status == 204) {
+ return null;
+ }
+
+ // Rely on SuperAgent for parsing response body.
+ // See http://visionmedia.github.io/superagent/#parsing-response-bodies
+ var data = response.body;
+ if (data == null || (typeof data === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length)) {
+ // SuperAgent does not always produce a body; use the unparsed response as a fallback
+ data = response.text;
+ }
+
+ return ApiClient.convertToType(data, returnType);
+ }
+
+ {{#emitJSDoc}}{{^usePromises}}/**
+ * Callback function to receive the result of the operation.
+ * @callback module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient~callApiCallback
+ * @param {String} error Error message, if any.
+ * @param data The data returned by the service call.
+ * @param {String} response The complete HTTP response.
+ */{{/usePromises}}{{/emitJSDoc}}
+
+ {{#emitJSDoc}}/**
+ * Invokes the REST service using the supplied settings and parameters.
+ * @param {String} path The base URL to invoke.
+ * @param {String} httpMethod The HTTP method to use.
+ * @param {Object.data will be converted to this type.
+ * @returns An instance of the specified type or null or undefined if data is null or undefined.
+ */
+ {{/emitJSDoc}}
+ static convertToType(data, type) {
+ if (data === null || data === undefined)
+ return data
+
+ switch (type) {
+ case 'Boolean':
+ return Boolean(data);
+ case 'Integer':
+ return parseInt(data, 10);
+ case 'Number':
+ return parseFloat(data);
+ case 'String':
+ return String(data);
+ case 'Date':
+ return ApiClient.parseDate(String(data));
+ case 'Blob':
+ return data;
+ default:
+ if (type === Object) {
+ // generic object, return directly
+ return data;
+ } else if (typeof type === 'function') {
+ // for model type like: User
+ return type.constructFromObject(data);
+ } else if (Array.isArray(type)) {
+ // for array type like: ['String']
+ var itemType = type[0];
+
+ return data.map((item) => {
+ return ApiClient.convertToType(item, itemType);
+ });
+ } else if (typeof type === 'object') {
+ // for plain object type like: {'String': 'Integer'}
+ var keyType, valueType;
+ for (var k in type) {
+ if (type.hasOwnProperty(k)) {
+ keyType = k;
+ valueType = type[k];
+ break;
+ }
+ }
+
+ var result = {};
+ for (var k in data) {
+ if (data.hasOwnProperty(k)) {
+ var key = ApiClient.convertToType(k, keyType);
+ var value = ApiClient.convertToType(data[k], valueType);
+ result[key] = value;
+ }
+ }
+
+ return result;
+ } else {
+ // for unknown type, return the data directly
+ return data;
+ }
+ }
+ }
+
+ {{#emitJSDoc}}/**
+ * Constructs a new map or array model from REST data.
+ * @param data {Object|Array} The REST data.
+ * @param obj {Object|Array} The target object or array.
+ */{{/emitJSDoc}}
+ static constructFromObject(data, obj, itemType) {
+ if (Array.isArray(data)) {
+ for (var i = 0; i < data.length; i++) {
+ if (data.hasOwnProperty(i))
+ obj[i] = ApiClient.convertToType(data[i], itemType);
+ }
+ } else {
+ for (var k in data) {
+ if (data.hasOwnProperty(k))
+ obj[k] = ApiClient.convertToType(data[k], itemType);
+ }
+ }
+ };
+}
+
+{{#emitJSDoc}}/**
+* The default API client implementation.
+* @type {module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient}
+*/{{/emitJSDoc}}
+ApiClient.instance = new ApiClient();
diff --git a/generator/cybersource-javascript-template/es6/README.mustache b/generator/cybersource-javascript-template/es6/README.mustache
new file mode 100644
index 00000000..c13314a8
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/README.mustache
@@ -0,0 +1,158 @@
+# {{projectName}}
+
+{{moduleName}} - JavaScript client for {{projectName}}
+{{#appDescription}}
+{{{appDescription}}}
+{{/appDescription}}
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: {{appVersion}}
+- Package version: {{projectVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/),
+please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install {{{projectName}}} --save
+```
+
+#### git
+#
+If the library is hosted at a git repository, e.g.
+https://github.com/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}}
+then install it via:
+
+```shell
+ npm install {{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}{{projectName}}{{/gitRepoId}} --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
+the above steps with Node.js and installing browserify with `npm install -g browserify`,
+perform the following (assuming *main.js* is your entry file):
+
+```shell
+browserify main.js > bundle.js
+```
+
+Then include *bundle.js* in the HTML pages.
+
+### Webpack Configuration
+
+Using Webpack you may encounter the following error: "Module not found: Error:
+Cannot resolve module", most certainly you should disable AMD loader. Add/merge
+the following section to your webpack config:
+
+```javascript
+module: {
+ rules: [
+ {
+ parser: {
+ amd: false
+ }
+ }
+ ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+var {{{moduleName}}} = require('{{{projectName}}}');
+{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
+var defaultClient = {{{moduleName}}}.ApiClient.instance;
+{{#authMethods}}{{#isBasic}}
+// Configure HTTP basic authorization: {{{name}}}
+var {{{name}}} = defaultClient.authentications['{{{name}}}'];
+{{{name}}}.username = 'YOUR USERNAME'
+{{{name}}}.password = 'YOUR PASSWORD'{{/isBasic}}{{#isApiKey}}
+// Configure API key authorization: {{{name}}}
+var {{{name}}} = defaultClient.authentications['{{{name}}}'];
+{{{name}}}.apiKey = "YOUR API KEY"
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//{{{name}}}.apiKeyPrefix['{{{keyParamName}}}'] = "Token"{{/isApiKey}}{{#isOAuth}}
+// Configure OAuth2 access token for authorization: {{{name}}}
+var {{{name}}} = defaultClient.authentications['{{{name}}}'];
+{{{name}}}.accessToken = "YOUR ACCESS TOKEN"{{/isOAuth}}
+{{/authMethods}}
+{{/hasAuthMethods}}
+
+var api = new {{{moduleName}}}.{{{classname}}}(){{#hasParams}}
+{{#vendorExtensions.x-codegen-hasRequiredParams}}{{#allParams}}{{#required}}
+var {{{paramName}}} = {{{example}}}; // {{=< >=}}{<&dataType>}<={{ }}=> {{{description}}}
+{{/required}}{{/allParams}}{{/vendorExtensions.x-codegen-hasRequiredParams}}{{#hasOptionalParams}}
+var opts = { {{#allParams}}{{^required}}
+ '{{{paramName}}}': {{{example}}}{{#vendorExtensions.x-codegen-hasMoreOptional}},{{/vendorExtensions.x-codegen-hasMoreOptional}} // {{=< >=}}{<&dataType>}<={{ }}=> {{{description}}}{{/required}}{{/allParams}}
+};{{/hasOptionalParams}}{{/hasParams}}
+{{#usePromises}}
+api.{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{#vendorExtensions.x-codegen-hasMoreRequired}}, {{/vendorExtensions.x-codegen-hasMoreRequired}}{{/required}}{{/allParams}}{{#hasOptionalParams}}{{#vendorExtensions.x-codegen-hasRequiredParams}}, {{/vendorExtensions.x-codegen-hasRequiredParams}}opts{{/hasOptionalParams}}).then(function({{#returnType}}data{{/returnType}}) {
+ {{#returnType}}console.log('API called successfully. Returned data: ' + data);{{/returnType}}{{^returnType}}console.log('API called successfully.');{{/returnType}}
+}, function(error) {
+ console.error(error);
+});
+
+{{/usePromises}}{{^usePromises}}
+var callback = function(error, data, response) {
+ if (error) {
+ console.error(error);
+ } else {
+ {{#returnType}}console.log('API called successfully. Returned data: ' + data);{{/returnType}}{{^returnType}}console.log('API called successfully.');{{/returnType}}
+ }
+};
+api.{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{#vendorExtensions.x-codegen-hasMoreRequired}}, {{/vendorExtensions.x-codegen-hasMoreRequired}}{{/required}}{{/allParams}}{{#hasOptionalParams}}{{#vendorExtensions.x-codegen-hasRequiredParams}}, {{/vendorExtensions.x-codegen-hasRequiredParams}}opts{{/hasOptionalParams}}{{#hasParams}}, {{/hasParams}}callback);
+{{/usePromises}}{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *{{basePath}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}.{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+## Documentation for Models
+
+{{#models}}{{#model}} - [{{moduleName}}.{{classname}}]({{modelDocPath}}{{classname}}.md)
+{{/model}}{{/models}}
+
+## Documentation for Authorization
+
+{{^authMethods}} All endpoints do not require authorization.
+{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
+{{#authMethods}}### {{name}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}} - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}
diff --git a/generator/cybersource-javascript-template/es6/api.mustache b/generator/cybersource-javascript-template/es6/api.mustache
new file mode 100644
index 00000000..f913650b
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/api.mustache
@@ -0,0 +1,103 @@
+{{>licenseInfo}}
+
+{{=< >=}}
+import ApiClient from "../ApiClient";
+<#imports>import {{baseName}} property.
+* @enum {{=<% %>=}}{<%datatype%>}<%={{ }}=%>
+* @readonly
+*/{{/emitJSDoc}}
+export default {{datatypeWithEnum}} = {
+{{#allowableValues}}{{#enumVars}}
+ {{#emitJSDoc}}/**
+ * value: {{{value}}}
+ * @const
+ */{{/emitJSDoc}}
+ "{{name}}": {{{value}}}{{^-last}},
+ {{/-last}}
+{{/enumVars}}{{/allowableValues}}
+};
diff --git a/generator/cybersource-javascript-template/es6/git_push.sh.mustache b/generator/cybersource-javascript-template/es6/git_push.sh.mustache
new file mode 100644
index 00000000..086955d7
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/git_push.sh.mustache
@@ -0,0 +1,52 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+ git_user_id="{{{gitUserId}}}"
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+ git_repo_id="{{{gitRepoId}}}"
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+ release_note="{{{releaseNote}}}"
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+ if [ "$GIT_TOKEN" = "" ]; then
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the Git credential in your environment."
+ git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+ else
+ git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+ fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+
diff --git a/generator/cybersource-javascript-template/es6/gitignore.mustache b/generator/cybersource-javascript-template/es6/gitignore.mustache
new file mode 100644
index 00000000..e920c167
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/gitignore.mustache
@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
diff --git a/generator/cybersource-javascript-template/es6/index.mustache b/generator/cybersource-javascript-template/es6/index.mustache
new file mode 100644
index 00000000..36b8a203
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/index.mustache
@@ -0,0 +1,58 @@
+{{>licenseInfo}}
+
+import ApiClient from './ApiClient';
+{{#models}}import {{#model}}{{classFilename}}{{/model}} from './{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{importPath}}';
+{{/models}}{{#apiInfo}}{{#apis}}import {{importPath}} from './{{#apiPackage}}{{apiPackage}}/{{/apiPackage}}{{importPath}}';
+{{/apis}}{{/apiInfo}}
+
+{{#emitJSDoc}}/**{{#projectDescription}}
+* {{projectDescription}}.
{{/projectDescription}}
+* The index module provides access to constructors for all the classes which comprise the public API.
+*
+* var {{moduleName}} = require('{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index'); // See note below*.
+* var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
+* var yyyModel = new {{moduleName}}.Yyy(); // Construct a model instance.
+* yyyModel.someProperty = 'someValue';
+* ...
+* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+* ...
+*
+* *NOTE: For a top-level AMD script, use require(['{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index'], function(){...})
+* and put the application logic within the callback function.
+*
+* A non-AMD browser application (discouraged) might do something like this: +*
+* var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
+* var yyy = new {{moduleName}}.Yyy(); // Construct a model instance.
+* yyyModel.someProperty = 'someValue';
+* ...
+* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+* ...
+*
+*
+* @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index
+* @version {{projectVersion}}
+*/{{/emitJSDoc}}
+export {
+ {{=< >=}}
+ <#emitJSDoc>/**
+ * The ApiClient constructor.
+ * @property {module:<#invokerPackage>{{classname}} enum value from a Javascript object name.
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
+ * @return {{=< >=}}{module:<#invokerPackage>{{classname}} value.
+ */{{/emitJSDoc}}
+ static constructFromObject(object) {
+ return object;
+ }
+}
diff --git a/generator/cybersource-javascript-template/es6/partial_model_generic.mustache b/generator/cybersource-javascript-template/es6/partial_model_generic.mustache
new file mode 100644
index 00000000..bcfb59db
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/partial_model_generic.mustache
@@ -0,0 +1,119 @@
+
+{{#models}}{{#model}}
+
+{{#emitJSDoc}}/**
+* The {{classname}} model module.
+* @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}
+* @version {{projectVersion}}
+*/{{/emitJSDoc}}
+export default class {{classname}} {{#parent}}{{^parentModel}}{{#vendorExtensions.x-isArray}}extends Array {{/vendorExtensions.x-isArray}}{{/parentModel}}{{/parent}}{
+ {{#emitJSDoc}}/**
+ * Constructs a new {{classname}}.{{#description}}
+ * {{description}}{{/description}}
+ * @alias module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}
+ * @class{{#useInheritance}}{{#parent}}
+ * @extends {{#parentModel}}module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}{{/parentModel}}{{^parentModel}}{{#vendorExtensions.x-isArray}}Array{{/vendorExtensions.x-isArray}}{{#vendorExtensions.x-isMap}}Object{{/vendorExtensions.x-isMap}}{{/parentModel}}{{/parent}}{{#interfaces}}
+ * @implements module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{.}}{{/interfaces}}{{/useInheritance}}{{#vendorExtensions.x-all-required}}
+ * @param {{name}} {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{#description}}{{{description}}}{{/description}}{{/vendorExtensions.x-all-required}}
+ */{{/emitJSDoc}}
+
+ constructor({{#vendorExtensions.x-all-required}}{{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.x-all-required}}) {
+ {{#parent}}{{^parentModel}}{{#vendorExtensions.x-isArray}}
+ super();
+ {{/vendorExtensions.x-isArray}}{{/parentModel}}{{/parent}}
+
+ {{#useInheritance}}
+ {{#parentModel}}{{classname}}.call(this{{#vendorExtensions.x-all-required}}, {{name}}{{/vendorExtensions.x-all-required}});{{/parentModel}}
+ {{#interfaceModels}}{{classname}}.call(this{{#vendorExtensions.x-all-required}}, {{name}}{{/vendorExtensions.x-all-required}});{{/interfaceModels}}
+ {{/useInheritance}}
+
+ {{#vars}}{{#required}}this['{{baseName}}'] = {{name}};{{/required}}{{/vars}}
+
+ {{#parent}}{{^parentModel}}return this;{{/parentModel}}{{/parent}}
+ }
+
+ {{#emitJSDoc}}/**
+ * Constructs a {{classname}} from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {{=< >=}}{module:<#invokerPackage>{{classname}} instance.
+ */{{/emitJSDoc}}
+ static constructFromObject(data, obj) {
+ if (data){{! TODO: support polymorphism: discriminator property on data determines class to instantiate.}} {
+ obj = obj || new {{classname}}();
+
+ {{#parent}}{{^parentModel}}ApiClient.constructFromObject(data, obj, '{{vendorExtensions.x-itemType}}');{{/parentModel}}
+ {{/parent}}
+
+ {{#useInheritance}}{{#parentModel}}{{classname}}.constructFromObject(data, obj);{{/parentModel}}
+ {{#interfaces}}{{.}}.constructFromObject(data, obj);{{/interfaces}}
+ {{/useInheritance}}
+
+ {{#vars}}
+ if (data.hasOwnProperty('{{baseName}}')) {
+ obj['{{baseName}}']{{{defaultValueWithParam}}}
+ }
+ {{/vars}}
+ }
+ return obj;
+ }
+
+{{#vars}}
+ {{#emitJSDoc}}/**{{#description}}
+ * {{{description}}}{{/description}}
+ * @member {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{baseName}}{{#defaultValue}}
+ * @default {{{defaultValue}}}{{/defaultValue}}
+ */{{/emitJSDoc}}
+ {{baseName}} = {{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}undefined{{/defaultValue}};
+{{/vars}}
+
+{{#useInheritance}}{{#interfaceModels}}
+ // Implement {{classname}} interface:
+ {{#allVars}}{{#emitJSDoc}}/**{{#description}}
+ * {{{description}}}{{/description}}
+ * @member {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{baseName}}{{#defaultValue}}
+ * @default {{{defaultValue}}}{{/defaultValue}}
+ */{{/emitJSDoc}}
+ {{baseName}} = {{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}undefined{{/defaultValue}};
+ {{/allVars}}
+{{/interfaceModels}}{{/useInheritance}}
+
+
+{{#emitModelMethods}}{{#vars}}
+ {{#emitJSDoc}}/**{{#description}}
+ * Returns {{{description}}}{{/description}}{{#minimum}}
+ * minimum: {{minimum}}{{/minimum}}{{#maximum}}
+ * maximum: {{maximum}}{{/maximum}}
+ * @return {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=>
+ */{{/emitJSDoc}}
+ {{getter}}() {
+ return this.{{baseName}};
+ }
+
+ {{#emitJSDoc}}/**{{#description}}
+ * Sets {{{description}}}{{/description}}
+ * @param {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{name}}{{#description}} {{{description}}}{{/description}}
+ */{{/emitJSDoc}}
+ {{setter}}({{name}}) {
+ this['{{baseName}}'] = {{name}};
+ }
+{{/vars}}{{/emitModelMethods}}
+
+{{#vars}}
+{{#isEnum}}
+{{^isContainer}}
+{{>partial_model_inner_enum}}
+{{/isContainer}}
+{{/isEnum}}
+{{#items.isEnum}}
+{{#items}}
+{{^isContainer}}
+{{>partial_model_inner_enum}}
+{{/isContainer}}
+{{/items}}
+{{/items.isEnum}}
+{{/vars}}
+
+{{/model}}{{/models}}
+}
diff --git a/generator/cybersource-javascript-template/es6/partial_model_inner_enum.mustache b/generator/cybersource-javascript-template/es6/partial_model_inner_enum.mustache
new file mode 100644
index 00000000..521e497b
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/partial_model_inner_enum.mustache
@@ -0,0 +1,15 @@
+ {{#emitJSDoc}}/**
+ * Allowed values for the {{baseName}} property.
+ * @enum {{=<% %>=}}{<%datatype%>}<%={{ }}=%>
+ * @readonly
+ */{{/emitJSDoc}}
+ static {{datatypeWithEnum}} = {
+ {{#allowableValues}}{{#enumVars}}
+ {{#emitJSDoc}}/**
+ * value: {{{value}}}
+ * @const
+ */{{/emitJSDoc}}
+ "{{name}}": {{{value}}}{{^-last}},
+ {{/-last}}
+ {{/enumVars}}{{/allowableValues}}
+ };
diff --git a/generator/cybersource-javascript-template/es6/travis.yml b/generator/cybersource-javascript-template/es6/travis.yml
new file mode 100644
index 00000000..e49f4692
--- /dev/null
+++ b/generator/cybersource-javascript-template/es6/travis.yml
@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+ - "6"
+ - "6.1"
+ - "5"
+ - "5.11"
+
diff --git a/generator/cybersource-javascript-template/git_push.sh.mustache b/generator/cybersource-javascript-template/git_push.sh.mustache
new file mode 100644
index 00000000..086955d7
--- /dev/null
+++ b/generator/cybersource-javascript-template/git_push.sh.mustache
@@ -0,0 +1,52 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+ git_user_id="{{{gitUserId}}}"
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+ git_repo_id="{{{gitRepoId}}}"
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+ release_note="{{{releaseNote}}}"
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+ if [ "$GIT_TOKEN" = "" ]; then
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the Git credential in your environment."
+ git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+ else
+ git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+ fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+
diff --git a/generator/cybersource-javascript-template/gitignore.mustache b/generator/cybersource-javascript-template/gitignore.mustache
new file mode 100644
index 00000000..e920c167
--- /dev/null
+++ b/generator/cybersource-javascript-template/gitignore.mustache
@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
diff --git a/generator/cybersource-javascript-template/index.mustache b/generator/cybersource-javascript-template/index.mustache
new file mode 100644
index 00000000..d6ca3cff
--- /dev/null
+++ b/generator/cybersource-javascript-template/index.mustache
@@ -0,0 +1,63 @@
+{{>licenseInfo}}
+(function(factory) {
+ if (typeof define === 'function' && define.amd) {
+ // AMD. Register as an anonymous module.
+ define(['{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient'{{#models}}, '{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{importPath}}'{{/models}}{{#apiInfo}}{{#apis}}, '{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#apiPackage}}{{apiPackage}}/{{/apiPackage}}{{importPath}}'{{/apis}}{{/apiInfo}}], factory);
+ } else if (typeof module === 'object' && module.exports) {
+ // CommonJS-like environments that support module.exports, like Node.
+ module.exports = factory(require('./ApiClient'){{#models}}, require('./{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{importPath}}'){{/models}}{{#apiInfo}}{{#apis}}, require('./{{#apiPackage}}{{apiPackage}}/{{/apiPackage}}{{importPath}}'){{/apis}}{{/apiInfo}});
+ }
+}(function(ApiClient{{#models}}{{#model}}, {{classFilename}}{{/model}}{{/models}}{{#apiInfo}}{{#apis}}, {{importPath}}{{/apis}}{{/apiInfo}}) {
+ 'use strict';
+
+{{#emitJSDoc}} /**{{#projectDescription}}
+ * {{projectDescription}}.index module provides access to constructors for all the classes which comprise the public API.
+ * + * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: + *
+ * var {{moduleName}} = require('{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index'); // See note below*.
+ * var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
+ * var yyyModel = new {{moduleName}}.Yyy(); // Construct a model instance.
+ * yyyModel.someProperty = 'someValue';
+ * ...
+ * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+ * ...
+ *
+ * *NOTE: For a top-level AMD script, use require(['{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index'], function(){...})
+ * and put the application logic within the callback function.
+ *
+ * + * A non-AMD browser application (discouraged) might do something like this: + *
+ * var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
+ * var yyy = new {{moduleName}}.Yyy(); // Construct a model instance.
+ * yyyModel.someProperty = 'someValue';
+ * ...
+ * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
+ * ...
+ *
+ *
+ * @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}index
+ * @version {{projectVersion}}
+ */{{/emitJSDoc}}
+{{=< >=}} var exports = {<#emitJSDoc>
+ /**
+ * The ApiClient constructor.
+ * @property {module:<#invokerPackage>{{classname}} enum value from a Javascript object name.
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
+ * @return {{=< >=}}{module:<#invokerPackage>{{classname}} value.
+ */
+ exports.constructFromObject = function(object) {
+ return object;
+ }
+
+ return exports;
+}));
diff --git a/generator/cybersource-javascript-template/partial_model_generic.mustache b/generator/cybersource-javascript-template/partial_model_generic.mustache
new file mode 100644
index 00000000..e955fda3
--- /dev/null
+++ b/generator/cybersource-javascript-template/partial_model_generic.mustache
@@ -0,0 +1,115 @@
+
+{{#models}}{{#model}}
+{{#emitJSDoc}}
+ /**
+ * The {{classname}} model module.
+ * @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}
+ * @version {{projectVersion}}
+ */
+
+ /**
+ * Constructs a new {{classname}}.{{#description}}
+ * {{description}}{{/description}}
+ * @alias module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}
+ * @class{{#useInheritance}}{{#parent}}
+ * @extends {{#parentModel}}module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{classname}}{{/parentModel}}{{^parentModel}}{{#vendorExtensions.x-isArray}}Array{{/vendorExtensions.x-isArray}}{{#vendorExtensions.x-isMap}}Object{{/vendorExtensions.x-isMap}}{{/parentModel}}{{/parent}}{{#interfaces}}
+ * @implements module:{{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}{{#modelPackage}}{{modelPackage}}/{{/modelPackage}}{{.}}{{/interfaces}}{{/useInheritance}}{{#vendorExtensions.x-all-required}}
+ * @param {{name}} {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{#description}}{{{description}}}{{/description}}{{/vendorExtensions.x-all-required}}
+ */
+{{/emitJSDoc}}
+ var exports = function({{#vendorExtensions.x-all-required}}{{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.x-all-required}}) {
+ var _this = this;
+{{#parent}}{{^parentModel}}{{#vendorExtensions.x-isArray}} _this = new Array();
+ Object.setPrototypeOf(_this, exports);
+{{/vendorExtensions.x-isArray}}{{/parentModel}}{{/parent}}{{#useInheritance}}{{#parentModel}} {{classname}}.call(_this{{#vendorExtensions.x-all-required}}, {{name}}{{/vendorExtensions.x-all-required}});{{/parentModel}}
+{{#interfaceModels}} {{classname}}.call(_this{{#vendorExtensions.x-all-required}}, {{name}}{{/vendorExtensions.x-all-required}});
+{{/interfaceModels}}{{/useInheritance}}{{#vars}}{{#required}} _this['{{baseName}}'] = {{name}};{{/required}}
+{{/vars}}{{#parent}}{{^parentModel}} return _this;
+{{/parentModel}}{{/parent}} };
+
+{{#emitJSDoc}}
+ /**
+ * Constructs a {{classname}} from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data to obj if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {{=< >=}}{module:<#invokerPackage>{{classname}} instance.
+ */
+{{/emitJSDoc}}
+ exports.constructFromObject = function(data, obj) {
+ if (data){{! TODO: support polymorphism: discriminator property on data determines class to instantiate.}} {
+ obj = obj || new exports();
+{{#parent}}{{^parentModel}} ApiClient.constructFromObject(data, obj, '{{vendorExtensions.x-itemType}}');
+{{/parentModel}}{{/parent}}{{#useInheritance}}{{#parentModel}} {{classname}}.constructFromObject(data, obj);{{/parentModel}}
+{{#interfaces}} {{.}}.constructFromObject(data, obj);
+{{/interfaces}}{{/useInheritance}}{{#vars}} if (data.hasOwnProperty('{{baseName}}')) {
+ obj['{{baseName}}']{{{defaultValueWithParam}}}
+ }
+{{/vars}} }
+ return obj;
+ }
+{{#useInheritance}}{{#parentModel}}
+ exports.prototype = Object.create({{classname}}.prototype);
+ exports.prototype.constructor = exports;
+{{/parentModel}}{{/useInheritance}}
+{{#vars}}
+{{#emitJSDoc}}
+ /**{{#description}}
+ * {{{description}}}{{/description}}
+ * @member {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{baseName}}{{#defaultValue}}
+ * @default {{{defaultValue}}}{{/defaultValue}}
+ */
+{{/emitJSDoc}}
+ exports.prototype['{{baseName}}'] = {{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}undefined{{/defaultValue}};
+{{/vars}}{{#useInheritance}}{{#interfaceModels}}
+ // Implement {{classname}} interface:{{#allVars}}
+{{#emitJSDoc}}
+ /**{{#description}}
+ * {{{description}}}{{/description}}
+ * @member {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{baseName}}{{#defaultValue}}
+ * @default {{{defaultValue}}}{{/defaultValue}}
+ */
+{{/emitJSDoc}}
+exports.prototype['{{baseName}}'] = {{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}undefined{{/defaultValue}};
+{{/allVars}}{{/interfaceModels}}{{/useInheritance}}
+{{#emitModelMethods}}{{#vars}}
+{{#emitJSDoc}}
+ /**{{#description}}
+ * Returns {{{description}}}{{/description}}{{#minimum}}
+ * minimum: {{minimum}}{{/minimum}}{{#maximum}}
+ * maximum: {{maximum}}{{/maximum}}
+ * @return {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=>
+ */
+{{/emitJSDoc}}
+ exports.prototype.{{getter}} = function() {
+ return this['{{baseName}}'];
+ }
+
+{{#emitJSDoc}}
+ /**{{#description}}
+ * Sets {{{description}}}{{/description}}
+ * @param {{=< >=}}{<&vendorExtensions.x-jsdoc-type>}<={{ }}=> {{name}}{{#description}} {{{description}}}{{/description}}
+ */
+{{/emitJSDoc}}
+ exports.prototype.{{setter}} = function({{name}}) {
+ this['{{baseName}}'] = {{name}};
+ }
+
+{{/vars}}{{/emitModelMethods}}
+{{#vars}}
+{{#isEnum}}
+{{^isContainer}}
+{{>partial_model_inner_enum}}
+{{/isContainer}}
+{{/isEnum}}
+{{#items.isEnum}}
+{{#items}}
+{{^isContainer}}
+{{>partial_model_inner_enum}}
+{{/isContainer}}
+{{/items}}
+{{/items.isEnum}}
+{{/vars}}
+
+ return exports;
+{{/model}}{{/models}}}));
diff --git a/generator/cybersource-javascript-template/partial_model_inner_enum.mustache b/generator/cybersource-javascript-template/partial_model_inner_enum.mustache
new file mode 100644
index 00000000..a8b98131
--- /dev/null
+++ b/generator/cybersource-javascript-template/partial_model_inner_enum.mustache
@@ -0,0 +1,21 @@
+{{#emitJSDoc}}
+ /**
+ * Allowed values for the {{baseName}} property.
+ * @enum {{=<% %>=}}{<%datatype%>}<%={{ }}=%>
+ * @readonly
+ */
+{{/emitJSDoc}}
+ exports.{{datatypeWithEnum}} = {
+ {{#allowableValues}}
+ {{#enumVars}}
+{{#emitJSDoc}}
+ /**
+ * value: {{{value}}}
+ * @const
+ */
+{{/emitJSDoc}}
+ "{{name}}": {{{value}}}{{^-last}},
+ {{/-last}}
+ {{/enumVars}}
+ {{/allowableValues}}
+ };
diff --git a/generator/cybersource-javascript-template/travis.yml b/generator/cybersource-javascript-template/travis.yml
new file mode 100644
index 00000000..e49f4692
--- /dev/null
+++ b/generator/cybersource-javascript-template/travis.yml
@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+ - "6"
+ - "6.1"
+ - "5"
+ - "5.11"
+
diff --git a/generator/cybersource-node-config.json b/generator/cybersource-node-config.json
new file mode 100644
index 00000000..eb8b00d7
--- /dev/null
+++ b/generator/cybersource-node-config.json
@@ -0,0 +1,4 @@
+{
+ "moduleName" : "CyberSource",
+ "projectName" : "CyberSource"
+}
\ No newline at end of file
diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json
new file mode 100644
index 00000000..e470f0f6
--- /dev/null
+++ b/generator/cybersource-rest-spec.json
@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"description":"Simple PAN tokenization service","version":"0.0.1","title":"CyberSource Flex API"},"host":"apitest.cybersource.com","schemes":["https"],"basePath":"/","consumes":["application/json;charset=utf-8"],"produces":["application/json;charset=utf-8"],"tags":[{"name":"Flex API"}],"paths":{"/flex/v1/keys/":{"x-name":"Generate Key","x-description":"Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.","post":{"tags":["KeyGeneration"],"summary":"Generate Key","description":"Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.","operationId":"generatePublicKey","produces":["application/json"],"parameters":[{"in":"body","name":"generatePublicKeyRequest","schema":{"required":["encryptionType"],"type":"object","properties":{"encryptionType":{"type":"string","description":"How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified."},"targetOrigin":{"type":"string","description":"This should only be used if using the Microform implementation. This is the protocol, URL, and if used, port number of the page that will host the Microform. Unless using http://localhost, the protocol must be https://. For example, if serving Microform on example.com, the targetOrigin is https://example.com The value is used to restrict the frame ancestor of the Microform. If there is a mismatch between this value and the frame ancestor, the Microfrom will not load."},"unmaskedLeft":{"type":"integer","description":"Specifies the number of card number digits to be returned un-masked from the left. For example, setting this value to 6 will return: 411111XXXXXXXXXX Default value: 6 Maximum value: 6"},"unmaskedRight":{"type":"integer","description":"Specifies the number of card number digits to be returned un-masked from the right. For example, setting this value to 4 will return: 411111XXXXXX1111 Default value: 4 Maximum value: 4"},"enableBillingAddress":{"type":"boolean","description":"Specifies whether or not 'dummy' address data should be specified in the create token request. If you have 'Relaxed AVS' enabled for your MID, this value can be set to False.Default value: true"},"currency":{"type":"string","description":"Three character ISO currency code to be associated with the token. Required for legacy integrations. Default value: USD."},"enableAutoAuth":{"type":"boolean","description":"Specifies whether or not an account verification authorization ($0 Authorization) is carried out on token creation. Default is false, as it is assumed a full or zero amount authorization will be carried out in a separate call from your server."}}}}],"x-example":{"example0":{"summary":"Generate Key","value":{"encryptionType":"RsaOaep256"}}},"responses":{"200":{"description":"Retrieved key.","schema":{"title":"flexV1KeysPost200Response","properties":{"keyId":{"type":"string","description":"Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser."},"der":{"type":"object","description":"The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.","properties":{"format":{"type":"string","description":"Specifies the format of the public key; currently X.509."},"algorithm":{"type":"string","description":"Algorithm used to encrypt the public key."},"publicKey":{"type":"string","description":"Base64 encoded public key value."}}},"jwk":{"type":"object","description":"The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.","properties":{"kty":{"type":"string","description":"Algorithm used to encrypt the public key."},"use":{"type":"string","description":"Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc."},"kid":{"type":"string","description":"The key ID in JWK format."},"n":{"type":"string","description":"JWK RSA Modulus"},"e":{"type":"string","description":"JWK RSA Exponent"}}}}}},"default":{"description":"Error retrieving key.","schema":{"type":"object","properties":{"responseStatus":{"properties":{"status":{"type":"number","description":"HTTP Status code."},"reason":{"type":"string","description":"Error Reason Code."},"message":{"type":"string","description":"Error Message."},"correlationId":{"type":"string","description":"API correlation ID."},"details":{"type":"array","items":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}}}}},"_links":{"type":"object","properties":{"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}}}}},"x-samplePayload":{"encryptionType":"RsaOaep256"},"x-sampleResponse":{"keyId":"05BgbFie7vX5vzSMKOoqEAAdfpdR4kas","der":{"format":"X.509","algorithm":"RSA","publicKey":"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAgC1G6rVue4w/jjJrKPZusGN9G+Y7mWuLJ0O2/GHd94LvR51+ok7ahuQUVMZLdigixnspaGo/WVLvTTZ5J28Cc1uSx0o/BsxpNaAQD8/aBZL3nnAiBLACxI1JHAVo7SXbJQmz+mqVFYTppg9QmpB2ATTmXjUOQy+Fqkw3EByfCANHhHSNs4+HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M/2O3g8FLQD2F+NezkQJsl8MEYo4rl1nr7/oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEwIDAQAB"},"jwk":{"kty":"RSA","use":"enc","kid":"05BgbFie7vX5vzSMKOoqEAAdfpdR4kas","n":"fC1G6rVue4w_jjJrKPZusGN9G-Y7mWuLJ0O2_GHd94LvR51-ok7ahuQUVMZLdigixnspaGo_WVLvTTZ5J28Cc1uSx0o_BsxpNaAQD8_aBZL3nnAiBLACxI1JHAVo7SXAJQmz-mqVFYTppg9QmpB2ATTmXjUOQy-Fqkw3EByfCANHhHSNs4-HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M_2O3g8FLQD2F-NezkQJsl8MEYo4rl1nr7_oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEw","e":"AQAB"}}}},"/flex/v1/tokens/":{"x-name":"Flex Tokenize Card","x-description":"Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.","post":{"tags":["FlexToken"],"summary":"Flex Tokenize card","description":"Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.","operationId":"tokenize","produces":["application/json"],"parameters":[{"in":"body","name":"tokenizeRequest","schema":{"type":"object","properties":{"keyId":{"type":"string","description":"Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key."},"cardInfo":{"type":"object","properties":{"cardNumber":{"type":"string","description":"Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request."},"cardExpirationMonth":{"type":"string","description":"Two digit expiration month"},"cardExpirationYear":{"type":"string","description":"Four digit expiration year"},"cardType":{"type":"string","description":"Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types."}}}}}}],"x-example":{"example0":{"summary":"Flex Tokenize Card","value":{"keyId":"05BgbFie7vX5vzSMKOoqEAAdfpdR4kas","cardInfo":{"cardNumber":"4111111111111111","cardExpirationMonth":"12","cardExpirationYear":"2031","cardType":"001"}}}},"responses":{"200":{"description":"Created payment token.","schema":{"title":"flexV1TokensPost200Response","properties":{"keyId":{"type":"string","description":"The Key ID."},"token":{"type":"string","description":"The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API."},"maskedPan":{"type":"string","description":"The masked card number displaying the first 6 digits and the last 4 digits."},"cardType":{"type":"string","description":"The card type."},"timestamp":{"type":"integer","format":"int64","description":"The UTC date and time in milliseconds at which the signature was generated."},"signedFields":{"type":"string","description":"Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature."},"signature":{"type":"string","description":"Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource."},"discoverableServices":{"type":"object","additionalProperties":{"type":"object"}}}}},"default":{"description":"Error creating token.","schema":{"type":"object","properties":{"responseStatus":{"properties":{"status":{"type":"number","description":"HTTP Status code."},"reason":{"type":"string","description":"Error Reason Code."},"message":{"type":"string","description":"Error Message."},"correlationId":{"type":"string","description":"API correlation ID."},"details":{"type":"array","items":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}}}}},"_links":{"type":"object","properties":{"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}}}}},"x-samplePayload":{"keyId":"05BgbFie7vX5vzSMKOoqEAAdfpdR4kas","cardDetails":{"cardNumber":"ejbhIpMEgYnIODcB4//rrVxMHrqHcnLD6pDRF36jlEk72bETAfiOoxmpI9pGiidqMmkgAnvJfVgR3CLAV5EdG4Mu5IWK26QRnVtwvsVEUtpah7IylbxV9MLvXh2FjIJskKCWNLidb1G4PN5963hnV3IoZd2pF99JwV9lPhOHT5ymlNeg7sTzQQDN1I0/yJApds+t79hl9QVp4PusUDfSsPQTtR2frzlH4V3W+XjHDhmy5oNhiUaVxv27cyG1SWeCKkVC9tc8zLy4pvlgoplrLV8JRaS9hfWalJjv2xtk3DXmNT2urtFv2evcI3LM/S29KlJjPXZcBp0IYyB/taunCA==","cardType":"001"}},"x-sampleResponse":{"keyId":"05BgbFie7vX5vzSMKOoqEAAdfpdR4kas","token":"0100153497304242","maskedPan":"424242XXXXXX4242","cardType":"001","timestamp":1472733222651,"signedFields":"token,cardType,maskedPan,timestamp","signature":"TcM7METFOIidwbxWG2Xhawx/5gZ7hZB0Lyrhg3NRJ+Pma+Nq7BugvsqLCE2R24+h13xnM6vpJXR2cqfQPkxhb6joJT8jcciEf+lj6h/KjvXuR4pJ4fMll4WS1Z4+574ps0ysV/5zs7kT2IAZj7i+szlYwFJxGhOGC0218x1N0NxELTDyU/HI6n+Aa+mYBqkMXth42t+GNQ7goVXkJWRgQSjp2v0WTh2d2plDnxEWPURZXz7GLdQXRIYUWWx/L5JSf88F1zgjYDpBitNSYBMMILKfDd3KEg+6nIruCln5kDMbTRD8LwPpGYC9tyM9+UM8MBINPHhaqdFp2wHF7dccKA==","discoverableServices":[]}}},"/pts/v2/payments/":{"post":{"summary":"Process a Payment","description":"Authorize the payment for the transaction.\n","tags":["payments"],"operationId":"createPayment","parameters":[{"name":"createPaymentRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"transactionId":{"type":"string","description":"Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176\n"},"comments":{"type":"string","description":"Comments"}}},"processingInformation":{"type":"object","properties":{"capture":{"type":"boolean","description":"Flag that specifies whether to also include capture service in the submitted request or not.","enum":[true,false],"default":false},"processorId":{"type":"string","maxLength":3,"description":"Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n"},"businessApplicationId":{"type":"string","description":"Description of this field is not available."},"commerceIndicator":{"type":"string","maxLength":20,"description":"Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n"},"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"purchaseLevel":{"type":"string","maxLength":1,"description":"Set this field to 3 to indicate that the request includes Level III data."},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"issuer":{"type":"object","properties":{"discretionaryData":{"type":"string","maxLength":255,"description":"Data defined by the issuer. The value for this reply field will probably be the same as the value that you\nsubmitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify\nthe value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n"}}},"authorizationOptions":{"type":"object","properties":{"authType":{"type":"string","maxLength":15,"description":"Authorization type. Possible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture\n request for a verbal payment.\n\nFor processor-specific information, see the auth_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"verbalAuthCode":{"type":"string","maxLength":7,"description":"Authorization code.\n\n**Forced Capture**\n\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\n\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the auth_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"verbalAuthTransactionId":{"type":"string","maxLength":15,"description":"Transaction ID (TID)."},"authIndicator":{"type":"string","maxLength":1,"description":"Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nFor processor-specific information, see the auth_indicator field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"partialAuthIndicator":{"type":"boolean","description":"Flag that indicates whether the transaction is enabled for partial authorization or not. When your request\nincludes this field, this value overrides the information in your CyberSource account. For processor-specific\ninformation, see the auth_partial_auth_indicator field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n","enum":[true,false]},"balanceInquiry":{"type":"boolean","description":"Flag that indicates whether to return balance information.","enum":[true,false]},"ignoreAvsResult":{"type":"boolean","description":"Flag that indicates whether to allow the capture service to run even when the payment\nreceives an AVS decline.\n","enum":[true,false],"default":false},"declineAvsFlags":{"type":"array","description":"An array of AVS flags that cause the reply flag to be returned.\n\n`Important` To receive declines for the AVS code N, include the value N in the array.\n","items":{"type":"string","enum":["D","A","V","S","N","O"]}},"ignoreCvResult":{"type":"boolean","description":"Flag that indicates whether to allow the capture service to run even when\nthe payment receives a CVN decline.\n","enum":[true,false],"default":false},"initiator":{"type":"object","properties":{"type":{"type":"string","description":"This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction.\n","enum":["customer","merchant"]},"credentialStoredOnFile":{"type":"boolean","description":"Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up\nmerchant-initiated transactions or not.\n","enum":[true,false]},"storedCredentialUsed":{"type":"boolean","description":"Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up\nmerchant-initiated transactions or not.\n","enum":[true,false]},"merchantInitiatedTransaction":{"type":"object","properties":{"reason":{"type":"string","maxLength":1,"description":"Reason for the merchant-initiated transaction. Possible values:\n\n - **1**: Resubmission\n - **2**: Delayed charge\n - **3**: Reauthorization for split shipment\n - **4**: No show\n - **5**: Account top up\n\nThis field is not required for installment payments or recurring payments or when _reAuth.first_ is true. It is\nrequired for all other merchant-initiated transactions. This field is supported only for Visa transactions on CyberSource through\nVisaNet.\n"},"previousTransactionId":{"type":"string","maxLength":15,"description":"Transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant initiated payment in the series or the previous\nmerchant-initiated payment in the series. If the current payment request includes a token\ninstead of an account number, the following time limits apply for the value of this field:\n\nFor a **resubmission**, the transaction ID must be less than 14 days old.\n\nFor a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old.\n\nThe value for this field does not correspond to any data in the TC 33 capture file. This field is supported\nonly for Visa transactions on CyberSource through VisaNet.\n"}}}}}}},"captureOptions":{"type":"object","properties":{"captureSequenceNumber":{"type":"number","minimum":1,"maximum":99,"description":"Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"},"totalCaptureCount":{"type":"number","minimum":1,"maximum":99,"description":"Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"},"dateToCapture":{"type":"string","maxLength":4,"description":"Date on which you want the capture to occur. This field is supported only for **CyberSource through VisaNet**.\n`Format: MMDD`\n"}}},"recurringOptions":{"type":"object","properties":{"loanPayment":{"type":"boolean","description":"Flag that indicates whether this is a payment towards an existing contractual loan.\n","enum":[true,false],"default":false},"firstRecurringPayment":{"type":"boolean","description":"Flag that indicates whether this transaction is the first in a series of recurring payments. This field is\nsupported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n","enum":[true,false],"default":false}}}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"number":{"type":"string","maxLength":20,"description":"Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"useAs":{"type":"string","maxLength":2,"description":"Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n"},"sourceAccountType":{"type":"string","maxLength":2,"description":"Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process. This field is required in the following cases.\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for CTV.\n \n**Note**\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - CHECKING: Checking account\n - CREDIT: Credit card account\n - SAVING: Saving account\n - LINE_OF_CREDIT: Line of credit\n - PREPAID: Prepaid card account\n - UNIVERSAL: Universal account\n"},"securityCode":{"type":"string","maxLength":4,"description":"Card Verification Number."},"securityCodeIndicator":{"type":"string","maxLength":1,"description":"Flag that indicates whether a CVN code was sent. Possible values:\n\n - 0 (default): CVN service not requested. CyberSource uses this default value when you do not include\n _securityCode_ in the request.\n - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include\n _securityCode_ in the request.\n - 2: CVN on credit card is illegible.\n - 9: CVN was not imprinted on credit card.\n"},"accountEncoderId":{"type":"string","maxLength":3,"description":"Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n"},"issueNumber":{"type":"string","maxLength":5,"description":"Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n"},"startMonth":{"type":"string","maxLength":2,"description":"Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"startYear":{"type":"string","maxLength":4,"description":"Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"}}},"tokenizedCard":{"type":"object","properties":{"number":{"type":"string","maxLength":20,"description":"Customer\u2019s payment network token value.\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the payment network token expires. `Format: YYYY`.\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"cryptogram":{"type":"string","maxLength":40,"description":"This field is used internally."},"requestorId":{"type":"string","maxLength":11,"description":"Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"},"transactionType":{"type":"string","maxLength":1,"description":"Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n"},"assuranceLevel":{"type":"string","maxLength":2,"description":"Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"},"storageMethod":{"type":"string","maxLength":3,"description":"Type of technology used in the device to store token data. Possible values:\n\n - 001: Secure Element (SE)\n\nSmart card or memory with restricted access and encryption to prevent data tampering. For storing payment\ncredentials, a SE is tested against a set of requirements defined by the payment networks.\n\n`Note` This field is supported only for **FDC Compass**.\n\n- 002: Host Card Emulation (HCE)\n\nEmulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n`Note` This field is supported only for **FDC Compass**.\n"},"securityCode":{"type":"string","maxLength":4,"description":"CVN."}}},"fluidData":{"type":"object","properties":{"key":{"type":"string","description":"Description of this field is not available."},"descriptor":{"type":"string","maxLength":128,"description":"Format of the encrypted payment data."},"value":{"type":"string","maxLength":3072,"description":"The encrypted payment data value. If using Apple Pay or Samsung Pay, the values are:\n - Apple Pay: RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U\n - Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=\n"},"encoding":{"type":"string","maxLength":6,"description":"Encoding method used to encrypt the payment data.\n\nPossible value: Base64\n"}}},"customer":{"type":"object","properties":{"customerId":{"type":"string","maxLength":26,"description":"Unique identifier for the customer's card and billing information."}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"discountAmount":{"type":"string","maxLength":15,"description":"Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"dutyAmount":{"type":"string","maxLength":15,"description":"Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"nationalTaxIncluded":{"type":"string","maxLength":1,"description":"Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedLevel":{"type":"string","maxLength":1,"description":"Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxTypeCode":{"type":"string","maxLength":3,"description":"For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"freightAmount":{"type":"string","maxLength":13,"description":"Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"foreignAmount":{"type":"string","maxLength":15,"description":"Converted amount returned by the DCC service.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"foreignCurrency":{"type":"string","maxLength":5,"description":"Billing currency returned by the DCC service.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRate":{"type":"string","maxLength":13,"description":"Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRateTimeStamp":{"type":"string","maxLength":14,"description":"Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"surcharge":{"type":"object","properties":{"amount":{"type":"string","maxLength":15,"description":"The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer\nand acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\n- Applicable only for CTV for Payouts.\n- CTV (<= 08)\n\nFor processor-specific information, see the surcharge_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"description":{"type":"string","description":"Description of this field is not available."}}},"settlementAmount":{"type":"string","maxLength":12,"description":"This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n"},"settlementCurrency":{"type":"string","maxLength":3,"description":"This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n"},"amexAdditionalAmounts":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amount":{"type":"string","maxLength":12,"description":"Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"middleName":{"type":"string","maxLength":60,"description":"Customer\u2019s middle name.\n"},"nameSuffix":{"type":"string","maxLength":60,"description":"Customer\u2019s name suffix.\n"},"title":{"type":"string","maxLength":60,"description":"Title.\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"district":{"type":"string","maxLength":50,"description":"Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n"},"buildingNumber":{"type":"string","maxLength":256,"description":"Building number in the street address.\n\nThis field is supported only for:\n - Cielo transactions.\n - Redecard customer validation with CyberSource Latin American Processing.\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneType":{"type":"string","enum":["day","home","night","work"],"description":"Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n"}}},"shipTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"lastName":{"type":"string","maxLength":60,"description":"Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the shipping address."},"address2":{"type":"string","maxLength":60,"description":"Second line of the shipping address."},"locality":{"type":"string","maxLength":50,"description":"City of the shipping address."},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"district":{"type":"string","maxLength":50,"description":"Neighborhood, community, or region within a city or municipality."},"buildingNumber":{"type":"string","maxLength":15,"description":"Building number in the street address. For example, the building number is 187 in the following address:\n\nRua da Quitanda 187\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Phone number for the shipping address."},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"unitOfMeasure":{"type":"string","maxLength":12,"description":"Unit of measure, or unit of measure code, for the item.\n"},"totalAmount":{"type":"string","maxLength":13,"description":"Total amount for the item. Normally calculated as the unit price x quantity.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"taxRate":{"type":"string","maxLength":7,"description":"Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n"},"taxStatusIndicator":{"type":"string","maxLength":1,"description":"Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n"},"taxTypeCode":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"amountIncludesTax":{"type":"boolean","description":"Flag that indicates whether the tax amount is included in the Line Item Total.\n","enum":[true,false]},"typeOfSupply":{"type":"string","maxLength":2,"description":"Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n"},"commodityCode":{"type":"string","maxLength":15,"description":"Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n"},"discountAmount":{"type":"string","maxLength":13,"description":"Discount applied to the item."},"discountApplied":{"type":"boolean","description":"Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n","enum":[true,false]},"discountRate":{"type":"string","maxLength":6,"description":"Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n"},"invoiceNumber":{"type":"string","maxLength":23,"description":"Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n"},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}},"fulfillmentType":{"type":"string","description":"TODO"}}}},"invoiceDetails":{"type":"object","properties":{"invoiceNumber":{"type":"string","description":"Invoice Number."},"barcodeNumber":{"type":"string","description":"Barcode Number."},"expirationDate":{"type":"string","description":"Expiration Date."},"purchaseOrderNumber":{"type":"string","maxLength":25,"description":"Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseOrderDate":{"type":"string","maxLength":10,"description":"Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseContactName":{"type":"string","maxLength":36,"description":"The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxable":{"type":"boolean","description":"Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]},"vatInvoiceReferenceNumber":{"type":"string","maxLength":15,"description":"VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"commodityCode":{"type":"string","maxLength":4,"description":"International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"merchandiseCode":{"type":"number","description":"Identifier for the merchandise. Possible value:\n\n - 1000: Gift card\n\nThis field is supported only for **American Express Direct**.\n"},"transactionAdviceAddendum":{"type":"array","items":{"type":"object","properties":{"data":{"type":"string","maxLength":40,"description":"Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"}}}}}},"shippingDetails":{"type":"object","properties":{"giftWrap":{"type":"boolean","description":"Description of this field is not available."},"shippingMethod":{"type":"string","maxLength":10,"description":"Shipping method for the product. Possible values:\n\n - lowcost: Lowest-cost service\n - sameday: Courier or same-day service\n - oneday: Next-day or overnight service\n - twoday: Two-day service\n - threeday: Three-day service\n - pickup: Store pick-up\n - other: Other shipping method\n - none: No shipping method because product is a service or subscription\n"},"shipFromPostalCode":{"type":"string","maxLength":10,"description":"Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"dateOfBirth":{"type":"string","maxLength":8,"description":"Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n"},"vatRegistrationNumber":{"type":"string","maxLength":20,"description":"Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["ssn","driverlicense"]},"id":{"type":"string","maxLength":26,"description":"Personal Identifier for the customer based on various type. This field is supported only on the processors\nlisted in this description.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"issuedBy":{"type":"string","description":"Description of this field is not available."}}}},"hashedPassword":{"type":"string","maxLength":100,"description":"TODO\n"}}},"recipientInformation":{"type":"object","properties":{"accountId":{"type":"string","maxLength":10,"description":"Identifier for the recipient\u2019s account. Use the first six digits and last four digits of the recipient\u2019s account\nnumber. This field is a pass-through, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n"},"lastName":{"type":"string","maxLength":6,"description":"Recipient\u2019s last name. This field is a passthrough, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n"},"postalCode":{"type":"string","maxLength":6,"description":"Partial postal code for the recipient\u2019s address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n"}}},"deviceInformation":{"type":"object","properties":{"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"userAgent":{"type":"string","maxLength":40,"description":"Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"alternateName":{"type":"string","maxLength":13,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"},"address1":{"type":"string","maxLength":60,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"salesOrganizationId":{"type":"string","maxLength":11,"description":"Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\nFor processor-specific information, see the sales_organization_ID field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"cardAcceptorReferenceNumber":{"type":"string","maxLength":25,"description":"Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"transactionLocalDateTime":{"type":"string","maxLength":14,"description":"Local date and time at your physical location. Include both the date and time in this field or leave it blank.\nThis field is supported only for **CyberSource through VisaNet**.\n\nFor processor-specific information, see the transaction_local_date_time field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n`Format: YYYYMMDDhhmmss`, where:\n\n - YYYY = year\n - MM = month\n - DD = day\n - hh = hour\n - mm = minutes\n - ss = seconds\n"}}},"aggregatorInformation":{"type":"object","properties":{"aggregatorId":{"type":"string","maxLength":20,"description":"Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\nFor processor-specific information, see the aggregator_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"name":{"type":"string","maxLength":37,"description":"Your payment aggregator business name.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"subMerchant":{"type":"object","properties":{"cardAcceptorId":{"type":"string","maxLength":15,"description":"Unique identifier assigned by the payment card company to the sub-merchant."},"name":{"type":"string","maxLength":37,"description":"Sub-merchant\u2019s business name."},"address1":{"type":"string","maxLength":38,"description":"First line of the sub-merchant\u2019s street address."},"locality":{"type":"string","maxLength":21,"description":"Sub-merchant\u2019s city."},"administrativeArea":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"region":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s region. Example `NE` indicates that the sub-merchant is in the northeast region."},"postalCode":{"type":"string","maxLength":15,"description":"Partial postal code for the sub-merchant\u2019s address."},"country":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes."},"email":{"type":"string","maxLength":40,"description":"Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n"},"phoneNumber":{"type":"string","maxLength":20,"description":"Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n"}}}}},"consumerAuthenticationInformation":{"type":"object","properties":{"cavv":{"type":"string","maxLength":40,"description":"Cardholder authentication verification value (CAVV)."},"cavvAlgorithm":{"type":"string","maxLength":1,"description":"Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication\ndata for Mastercard SecureCode.\n"},"eciRaw":{"type":"string","maxLength":2,"description":"Raw electronic commerce indicator (ECI)."},"paresStatus":{"type":"string","maxLength":1,"description":"Payer authentication response status."},"veresEnrolled":{"type":"string","maxLength":1,"description":"Verification response enrollment status."},"xid":{"type":"string","maxLength":40,"description":"Transaction identifier."},"ucafAuthenticationData":{"type":"string","maxLength":32,"description":"Universal cardholder authentication field (UCAF) data."},"ucafCollectionIndicator":{"type":"string","maxLength":1,"description":"Universal cardholder authentication field (UCAF) collection indicator."}}},"pointOfSaleInformation":{"type":"object","properties":{"terminalId":{"type":"string","maxLength":8,"description":"Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n"},"terminalSerialNumber":{"type":"string","description":"Description of this field is not available."},"laneNumber":{"type":"string","maxLength":8,"description":"Identifier for an alternate terminal at your retail location. You define the value for this field.\n\nThis field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to\nidentify the main terminal at your retail location. If your retail location has multiple terminals, use this\n_alternateTerminalID_ field to identify the terminal used for the transaction.\n\nThis field is a pass-through, which means that CyberSource does not check the value or modify the value in any\nway before sending it to the processor.\n"},"cardPresent":{"type":"boolean","description":"Indicates whether the card is present at the time of the transaction. Possible values:\n\n - **true**: Card is present.\n - **false**: Card is not present.\n"},"catLevel":{"type":"integer","minimum":1,"maximum":9,"description":"Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n * Applicable only for CTV for Payouts.\n"},"entryMode":{"type":"string","maxLength":11,"description":"Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n"},"terminalCapability":{"type":"integer","minimum":1,"maximum":5,"description":"POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n"},"pinEntryCapability":{"type":"integer","minimum":1,"maximum":1,"description":"A one-digit code that identifies the capability of terminal to capture PINs. \nThis code does not necessarily mean that a PIN was entered or is included in this message. \nFor Payouts: This field is applicable for CtV.\n"},"operatingEnvironment":{"type":"string","maxLength":1,"description":"Operating environment. Possible values:\n\n - 0: No terminal used or unknown environment.\n - 1: On merchant premises, attended.\n - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home\n computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for\n MasterCard transactions on **CyberSource through VisaNet**.\n - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in\n taxis.\n - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer,\n mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource\n through VisaNet**.\n - 5: On premises of cardholder, unattended.\n - 9: Unknown delivery mode.\n - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the\n internet.\n - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.\n\nThis field is supported only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**CyberSource through VisaNet**\n\nFor MasterCard transactions, the only valid values are 2 and 4.\n"},"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"},"cardholderVerificationMethod":{"type":"number","description":"Method that was used to verify the cardholder's identity. Possible values:\n\n - **0**: No verification\n - **1**: Signature\n\nThis field is supported only on **American Express Direct**.\n"},"cardSequenceNumber":{"type":"string","maxLength":3,"description":"Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n"},"fallback":{"type":"boolean","maxLength":5,"description":"Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n","enum":[true,false],"default":false},"fallbackCondition":{"type":"number","description":"Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n"}}},"amexCapnData":{"type":"string","maxLength":12,"description":"Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"},"trackData":{"type":"string","description":"Card\u2019s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n"}}},"merchantDefinedInformation":{"type":"array","description":"Description of this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"Description of this field is not available."},"value":{"type":"string","maxLength":255,"description":"Description of this field is not available."}}}}},"example":{"clientReferenceInformation":{"code":"TC50171_3"},"processingInformation":{"commerceIndicator":"internet"},"aggregatorInformation":{"subMerchant":{"cardAcceptorId":"1234567890","country":"US","phoneNumber":"650-432-0000","address1":"900 Metro Center","postalCode":"94404-2775","locality":"Foster City","name":"Visa Inc","administrativeArea":"CA","region":"PEN","email":"test@cybs.com"},"name":"V-Internatio","aggregatorId":"123456789"},"orderInformation":{"billTo":{"country":"US","lastName":"Doe","address2":"Address 2","address1":"201 S. Division St.","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","firstName":"John","phoneNumber":"999999999","district":"MI","buildingNumber":"123","company":"Visa","email":"test@cybs.com"},"amountDetails":{"totalAmount":"102.21","currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"5555555555554444","securityCode":"123","expirationMonth":"12","type":"002"}}}}}],"responses":{"201":{"description":"Successful response.","schema":{"type":"object","title":"ptsV2PaymentsPost201Response","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"reversal":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"capture":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["AUTHORIZED","PARTIAL_AUTHORIZED","AUTHORIZED_PENDING_REVIEW","DECLINED"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"errorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason of the status.\n","enum":["AVS_FAILED","CONTACT_PROCESSOR","CV_FAILED","EXPIRED_CARD","PROCESSOR_DECLINED","INSUFFICIENT_FUND","STOLEN_LOST_CARD","ISSUER_UNAVAILABLE","UNAUTHORIZED_CARD","CVN_NOT_MATCH","EXCEEDS_CREDIT_LIMIT","INVALID_CVN","PAYMENT_REFUSED","INVALID_ACCOUNT","GENERAL_DECLINE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"processorInformation":{"type":"object","properties":{"approvalCode":{"type":"string","description":"Authorization code. Returned only when the processor returns this value.\n"},"transactionId":{"type":"string","maxLength":50,"description":"Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n"},"networkTransactionId":{"type":"string","description":"Description of this field is not available."},"providerTransactionId":{"type":"string","description":"Description of this field is not available."},"responseCode":{"type":"string","maxLength":10,"description":"For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"},"responseCodeSource":{"type":"string","maxLength":1,"description":"Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n"},"responseDetails":{"type":"string","maxLength":255,"description":"This field might contain information about a decline. This field is supported only for **CyberSource through\nVisaNet**.\n"},"responseCategoryCode":{"type":"string","maxLength":32,"description":"Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"},"forwardedAcquirerCode":{"type":"string","maxLength":32,"description":"Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"},"avs":{"type":"object","properties":{"code":{"type":"string","maxLength":1,"description":"AVS result code.\n"},"codeRaw":{"type":"string","maxLength":10,"description":"AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n"}}},"cardVerification":{"type":"object","properties":{"resultCode":{"type":"string","maxLength":1,"description":"CVN result code.\n"},"resultCodeRaw":{"type":"string","maxLength":10,"description":"CVN result code sent directly from the processor. Returned only when the processor returns this value.\n\n`Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only.\n"}}},"merchantAdvice":{"type":"object","properties":{"code":{"type":"string","maxLength":2,"description":"Reason the recurring payment transaction was declined. For some processors, this field is used only for\nMastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this\nfield is not implemented.\n\nPossible values:\n\n - **00**: Response not provided.\n - **01**: New account information is available. Obtain the new information.\n - **02**: Try again later.\n - **03**: Do not try again. Obtain another type of payment from the customer.\n - **04**: Problem with a token or a partial shipment indicator.\n - **21**: Recurring payment cancellation service.\n - **99**: An unknown value was returned from the processor.\n"},"codeRaw":{"type":"string","maxLength":2,"description":"Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\nFor processor-specific information, see the auth_merchant_advice_code_raw field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"electronicVerificationResults":{"type":"object","properties":{"code":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s name.\n"},"codeRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s last name"},"email":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s email address.\n"},"emailRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s email address."},"phoneNumber":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s phone number.\n"},"phoneNumberRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s phone number."},"postalCode":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s postal code.\n"},"postalCodeRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s postal code."},"street":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s street address.\n"},"streetRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s street address."},"name":{"type":"string","maxLength":30,"description":"TODO\n"},"nameRaw":{"type":"string","maxLength":30,"description":"TODO"}}},"customer":{"type":"object","properties":{"personalIdResult":{"type":"string","maxLength":1,"description":"Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this\nvalue indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - **Y**: Match\n - **N**: No match\n - **K**: Not supported\n - **U**: Unknown\n - **Z**: No response returned\n"}}},"consumerAuthenticationResponse":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Mapped response code for Verified by Visa and American Express SafeKey:\n"},"codeRaw":{"type":"string","maxLength":3,"description":"Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey:\n"}}},"issuer":{"type":"object","properties":{"country":{"type":"string","maxLength":3,"description":"Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character ISO Standard Country Codes.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n"},"discretionaryData":{"type":"string","maxLength":255,"description":"Data defined by the issuer. The value for this reply field will probably be the same as the value that you\nsubmitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify\nthe value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n"}}},"systemTraceAuditNumber":{"type":"string","maxLength":6,"description":"This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n"},"paymentAccountReferenceNumber":{"type":"string","maxLength":32,"description":"Visa-generated reference number that identifies a card-present transaction for which youprovided one of the\nfollowing:\n\n - Visa primary account number (PAN)\n - Visa-generated token for a PAN\n\nThis reference number serves as a link to the cardholder account and to all transactions for that account.\n"},"transactionIntegrityCode":{"type":"string","maxLength":2,"description":"Transaction integrity classification provided by Mastercard. This value specifies Mastercard\u2019s evaluation of\nthe transaction\u2019s safety and security. This field is returned only for **CyberSource through VisaNet**.\n\nFor card-present transactions, possible values:\n\n - **A1**: EMV or token in a secure, trusted environment\n - **B1**: EMV or chip equivalent\n - **C1**: Magnetic stripe\n - **E1**: Key entered\n - **U0**: Unclassified\n\nFor card-not-present transactions, possible values:\n\n - **A2**: Digital transactions\n - **B2**: Authenticated checkout\n - **C2**: Transaction validation\n - **D2**: Enhanced data\n - **E2**: Generic messaging\n - **U0**: Unclassified\n\nFor information about these values, contact Mastercard or your acquirer.\n"},"amexVerbalAuthReferenceNumber":{"type":"string","maxLength":6,"description":"Referral response number for a verbal authorization with FDMS Nashville when using an American Express card.\nGive this number to American Express when you call them for the verbal authorization.\n"},"salesSlipNumber":{"type":"number","maximum":99999,"description":"Transaction identifier that CyberSource generates. You have the option of printing the sales slip number on\nthe receipt.\n\nThis field is supported only for **JCN Gateway**.\n"},"masterCardServiceCode":{"type":"string","maxLength":2,"description":"Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n"},"masterCardServiceReplyCode":{"type":"string","maxLength":1,"description":"Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n"},"masterCardAuthenticationType":{"type":"string","maxLength":1,"description":"Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **1**: Transaction qualifies for Mastercard authentication type 1.\n - **2**: Transaction qualifies for Mastercard authentication type 2.\n"},"name":{"type":"string","maxLength":30,"description":"Name of the Processor.\n"}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"suffix":{"type":"string","maxLength":4,"description":"Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n"}}},"tokenizedCard":{"type":"object","properties":{"prefix":{"type":"string","maxLength":6,"description":"First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n"},"suffix":{"type":"string","maxLength":4,"description":"Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"assuranceLevel":{"type":"string","maxLength":2,"description":"Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the payment network token expires. `Format: YYYY`.\n"},"requestorId":{"type":"string","maxLength":11,"description":"Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n"}}},"accountFeatures":{"type":"object","properties":{"accountType":{"type":"string","maxLength":2,"description":"Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - **00**: Not applicable or not specified\n - **10**: Savings account\n - **20**: Checking account\n - **30**: Credit card account\n - **40**: Universal account\n"},"accountStatus":{"type":"string","maxLength":1,"description":"Possible values:\n\n - **N**: Nonregulated\n - **R**: Regulated\n\n`Note` This field is returned only for CyberSource through VisaNet.\n"},"balanceAmount":{"type":"string","maxLength":12,"description":"Remaining balance on the account.\n"},"balanceAmountType":{"type":"string","maxLength":2,"description":"Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - **01**: Current ledger (posted) balance.\n - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - **01**: Credit amount remaining for customer (open to buy).\n - **02**: Credit limit.\n"},"currency":{"type":"string","maxLength":5,"description":"Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n"},"balanceSign":{"type":"string","maxLength":1,"description":"Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values:\n","enum":["+","-"]},"affluenceIndicator":{"type":"string","maxLength":13,"description":"**Chase Paymentech Solutions**\n\nIndicates whether a customer has high credit limits. This information enables you to market high cost items to\nthese customers and to understand the kinds of cards that high income customers are using.\n\nThis field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n\n**Litle**\n\nFlag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories.\nPossible values:\n\n - **AFFLUENT**: High income customer with high spending pattern (>100k USD annual income and >40k USD annual\n card usage).\n - **MASS AFFLUENT**: High income customer (>100k USD annual income).\n\n**Processor specific maximum length**:\n\n - Chase Paymentech Solutions: 1\n - Litle: 13\n"},"category":{"type":"string","maxLength":7,"description":"**CyberSource through VisaNet**\n\nVisa product ID.\n\n**GPN**\n\nVisa or Mastercard product ID.\n\n**Litle**\n\nType of card used in the transaction. The only possible value is:\n\n - PREPAID: Prepaid Card\n\n**RBS WorldPay Atlanta**\n\nType of card used in the transaction. Possible values:\n\n - **B**: Business Card\n - **O**: Noncommercial Card\n - **R**: Corporate Card\n - **S**: Purchase Card\n - **Blank**: Purchase card not supported\n\n**Maximum length for processors**:\n\n - CyberSource through VisaNet: 3\n - GPN: 3\n - Litle: 7\n - RBS WorldPay Atlanta: 1\n"},"commercial":{"type":"string","maxLength":1,"description":"Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"group":{"type":"string","maxLength":1,"description":"Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values:\n\n - **B**: Business card\n - **R**: Corporate card\n - **S**: Purchasing card\n - **0**: Noncommercial card\n"},"healthCare":{"type":"string","maxLength":1,"description":"Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"payroll":{"type":"string","maxLength":1,"description":"Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"level3Eligible":{"type":"string","maxLength":1,"description":"Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"pinlessDebit":{"type":"string","maxLength":1,"description":"Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"signatureDebit":{"type":"string","maxLength":1,"description":"Indicates whether the card is a signature debit card. This information enables you to alter the way an order is\nprocessed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"prepaid":{"type":"string","maxLength":1,"description":"Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n"},"regulated":{"type":"string","maxLength":1,"description":"Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes (assets greater than 10B USD)\n - **N**: No (assets less than 10B USD)\n - **X**: Not applicable / Unknown\n"}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":15,"description":"Amount you requested for the payment or capture.\n\nThis value is returned for partial authorizations.\n"},"authorizedAmount":{"type":"string","maxLength":15,"description":"Amount that was authorized.\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"invoiceDetails":{"type":"object","properties":{"level3TransmissionStatus":{"type":"boolean","description":"Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"}}},"amexCapnData":{"type":"string","maxLength":12,"description":"Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"}}}},"example":{"_links":{"self":{"href":"/pts/v2/payments/4963015972176007901546","method":"GET"},"authReversal":{"href":"/pts/v2/payments/4963015972176007901546/reversals","method":"POST"},"capture":{"href":"/pts/v2/payments/4963015972176007901546/captures","method":"POST"},"refund":{"href":"/pts/v2/payments/4963015972176007901546/refunds","method":"POST"},"void":{"href":"/pts/v2/payments/4963015972176007901546/voids","method":"POST"}},"id":"4963015972176007901546","submitTimeUtc":"2017-06-01T071957Z","status":"200","reconciliationId":"39570726X3E1LBQR","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"TC50171_3"},"orderInformation":{"amountDetails":{"authorizedAmount":"102.21","currency":"USD"}},"processorInformation":{"approvalCode":"888888","cardVerification":{"resultCode":""},"avs":{"code":"X","codeRaw":"I1"},"responseCode":"100"}}}},"400":{"description":"Invalid request.","schema":{"type":"object","title":"ptsV2PaymentsPost400Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_CARD","CARD_TYPE_NOT_ACCEPTED","INVALID_MERCHANT_CONFIGURATION","PROCESSOR_UNAVAILABLE","INVALID_AMOUNT","INVALID_CARD_TYPE","DEBIT_CARD_USEAGE_EXCEEDD_LIMIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"type":"object","title":"ptsV2PaymentsPost502Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Simple Authorization(Internet)","value":{"clientReferenceInformation":{"code":"TC50171_3"},"processingInformation":{"commerceIndicator":"internet"},"orderInformation":{"billTo":{"firstName":"John","lastName":"Doe","address2":"Address 2","address1":"201 S. Division St.","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","country":"US","phoneNumber":"999999999","district":"MI","buildingNumber":"123","company":"Visa","email":"test@cybs.com"},"amountDetails":{"totalAmount":"102.21","currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12","type":"002"}}}},"example1":{"summary":"Simple Authorization(Retail)","value":{"clientReferenceInformation":{"code":"1234567890"},"pointOfSaleInformation":{"cardPresent":"true","catLevel":"6","emv":{"fallbackCondition":"swiped","fallback":"N"},"terminalCapability":"4"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","address1":"901 Metro Center Blvd","postalCode":"40500","locality":"Foster City","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":10,"currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12"}}}},"example2":{"summary":"CyberSource Payment Tokenization","value":{"clientReferenceInformation":{"code":"TC_MPOS_Paymentech_3"},"processingInformation":{"commerceIndicator":"internet"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","phoneNumber":"6504327113","address1":"901 Metro Center Blvd","postalCode":"94404","locality":"Foster City","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":"2719","currency":"USD"}},"paymentInformation":{"tokenizedCard":{"expirationYear":"2031","number":"4111111111111111","expirationMonth":"12","transactionType":"1"},"fluidData":{"value":"WjmY7vC+ll6uM/YEAk/LIg6B91chaJZXUOMWDnpbIjvGX0tsqYNIM4FV5Z5RpcH8NAkmHCJrMs/FIZ26pXmltDSCFEgVKTvllNmEZmC7hoqAL0mO8GAPR8pAzJVuVoN3Qdyhm099BYLI3IE+hyHqHMlMf7kNdofkSVvpi9d8eEYAWtiU62FQbzIP+dePBh4120zzCoKkUyQf5Iw8uI1axz79ctf0qSDtReopUGmTiQZwlhVNFUb6FjPTAktQfMfbpF5RJM15W9e0n0tHE+sMcJur0Isi95KYtRnsWKnNWcvMWB1p3FPRVKsV/8mmsByfnfwPyH/dS56m/+G9MNCFoAASeKi2H9cbmNetDPw0g9kOE9HXw8lcet3Uz8Q3f1TzYCniTgwuRaJ0s6o/PlpnJvVjOm/tYHfcaOrcv3RNeT9I7YCxxBgkdvJVQ03Fhk2DZPNDgzGf1jbQ+mnv+Uq70kdbrcziuxfdNMwWy8mIEAz3i3eJJEFJZtDT1EXy9glnVEKkQIFzh2HccGs+CJriXXOLG9cl/0b4tT4P7W6wb9lazhcS1imxf3G3uNGFPvejuMqM0ll9KOOOffurAJ31n5Buwkq4+YS+M9PCE0maugGQ0RfqpIjbyoAYuClndwEKPPDKVNmg+L6CGPvrUcBYh7MhFj0NqTTK4JrNYJj099Bx0u5+tz3aEnMSmNQZYFEADocxWZB+oQ/u1BkOhR6yYBDUHyFCAPl8uh8x6Y5Acpb687FtT8+Vt+GoyQJL9HzLFe3D6KxQ+I7sT71YJrf8J5rZP4rUDnFedBQEdUJh/NeZs8GE20CVwBN+E6BgTNL9dSBJFhbwJkZt5cenQtaiO/y52OltBV/8wZVuW6BxbIM1+LSEkDufCZYw5x7Ih/cwdsj0I3Q6fVcjXyehj3xbgTJ7+XTYM1vuiy6zKBpq82uHvKw4V1pYmY4n93GutFWkGskWrwwgRzcRFLgf8yGAwCFI1bif8UVUd8SAhGqNpSLiPLJC1Axn7nt+TXdNWyQwHi4YZ+eQslBkgKy2Baee/zPAz3nGEIYcxKfvbhfx2KxIlTDfcej9zoArrShtFHNu5C4PQKFvl5wl5GkuKogx/IC3J6fPZbLcdQkPE6dZz7cHhp0aAcNb8RXmadixU4hEh3WSTy9iu0Ey/ti9RQ51dJ1cJk5TcOXjJUbAVdfcxsOFs5LBOFVbZwV2du+Tfxy313s4WyHszfrD/Y6+7Zsn2zM29N8rMq0fh+y+O/dHJDVLqtYwGLEb+ZFAV+TJnZBsuTLFm2D6H/yMA009+g56x03sxhW3usjDyHblUqMiVO3yl/626lrhwbvZNRE8MI5GqcfXuIo7fJgHyfmgYWNXbfxfNzB372+lLQbrpOWBlvgaP9ZeS512nNn0EY205gzwpoSQHugwNVXj7gE9rcBpF0dBThotIk2ZxPPMabSYTZdjRmGnzzV5t4HxwAQtXJgMbiDbQRkqIdlI8i0rXuaQnDYdxhqFr6ek5nCV9ypi71rSUE/IObRux5mX7BkO2OgGZ/jHWIHDzghQTmyxmSYnaKGj3ZoeEZpMvrrLPSJWdpouCA8cDhnyfYzJydTjySeGOf95SGYQbCIJKUnI9HQJLB9HTgSOroYjpxpfSe0/5i9IvmbBH1qgZGzlrt0SaSkhqDhStmfYo6aJmrLvWsa2oaWf/kSXSTqloRuaNIYBqotw6fanop1ZhiDpPcBEaG0FT45RajiC3OqkSiUIJhvDKjRHsNT01Piv4tnjQ9UUrdPg6guohulJpGIVXvWguvwjwESehlhpuoLl+LPikUku7ox3/PLW3+b8d+7Hm0A1eyYv/OCLA/AXfwwNIMmzRb9oPCvHGEEslYH+nrjZv+Q1AcoE/fFcWqjFX5QBJFJ6blnG3fvZlR+tK7Q6pMumGIhmf1GesO2T0AiCAO+0dNPkZuw3lnlNYh3u8uq2EVCMa3FM2PKhDkjMo8qnBk447+oIX8JJexJ43uHLpax24MBYJmiO7Dl/JkTrGzXfD1Ze/fayTNca1e1L3S6wTkkR7Jrw8axFfNydFoHNolz+hrwBGZZ/IARsPXsvdjeuBVjvHmN7CvfbvByIEj1wNHUCYFZmypRHUP/1jI94eM/wAGGjZYG+J/8H9iJCQjRi1/TNrhVNpDe0aB1oj/47ZeuovfNQnuiTcKTCAxcyOpkuAdvJ9dTTRI6i4Y8nOlRI+wqBc25FhXT8L+60uMeG+NqJfwc9D7CnjocJpsXFik05DW1v28wlPEGaUcOyf808uBXcXxmeGM9Gf9mq+yMN9ql5HCrFuy6F4OAA3MD5SbDCzPd/LMv3vEf5xCPLByPiqV1snHTEoEtR8WRndYW1uTkcDDKRa7s+rxVZbzdh010YP1A3LzgVNuUk+Zz8dfIZhWcBDvTivgW6TWlg0PA/FU946CfybfbHjn1BEkJNc3yFhVqMIF4oezTeIwo9Zxch+IYocoDSavpTmh2KafUCP1+bX1d2lCPdQnA2D8S9oVy1zfibXtjkGoz78Giu79KuU+fGSNr012fKa3+bl6GJF1XZlq6u"}}}},"example3":{"summary":"Digital Payment - GooglePay","value":{"clientReferenceInformation":{"code":"mpos_paymentech"},"processingInformation":{"paymentSolution":"012"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","phoneNumber":"6504327113","address2":"Desk M3-5573","address1":"901 Metro Center Blvd","postalCode":"94404","locality":"Foster City","company":"Visa","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":"2012","currency":"USD"}},"paymentInformation":{"tokenizedCard":{"expirationYear":"2020","number":"4111111111111111","expirationMonth":"12","transactionType":"1","cryptogram":"EHuWW9PiBkWvqE5juRwDzAUFBAk="}}}},"example4":{"summary":"Digital Payments - ApplePay","value":{"clientReferenceInformation":{"code":"TC_MPOS_Paymentech_2"},"processingInformation":{"paymentSolution":"001"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","phoneNumber":"6504327113","address2":"Desk M3-5573","address1":"901 Metro Center Blvd","postalCode":"94404","locality":"Foster City","company":"Visa","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":"100","currency":"USD"}},"paymentInformation":{"tokenizedCard":{"expirationYear":"2031","number":"4111111111111111","expirationMonth":"12","transactionType":"1","cryptogram":"AceY+igABPs3jdwNaDg3MAACAAA="}}}},"example5":{"summary":"Point Of Sale - EMV","value":{"clientReferenceInformation":{"code":"123456"},"pointOfSaleInformation":{"cardPresent":"Y","catLevel":"2","emv":{"fallbackCondition":"swiped","fallback":"Y"},"terminalCapability":"4"},"orderInformation":{"billTo":{"country":"US","lastName":"Doe","address1":"201 S. Division St.","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","firstName":"John","phoneNumber":"999999999","email":"test@cybs.com"},"amountDetails":{"totalAmount":"100.00","currency":"usd"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"372425119311008","securityCode":"123","expirationMonth":"12"},"fluidData":{"value":"%B373235387881007^SMITH/JOHN ^31121019761100 00868000000?;373235387881007=31121019761186800000?"}}}},"example6":{"summary":"Zero Dollar Authorization","value":{"clientReferenceInformation":{"code":"1234567890"},"deviceInformation":{"ipAddress":"66.185.179.2"},"processingInformation":{"capture":"false"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","address2":"Desk M3-5573","address1":"901 Metro Center Blvd","postalCode":"88880","locality":"Foster City","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":10,"currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12"}}}},"example7":{"summary":"Level II Data","value":{"clientReferenceInformation":{"code":"TC50171_12"},"processingInformation":{"commerceIndicator":"internet"},"aggregatorInformation":{"subMerchant":{"cardAcceptorId":"1234567890","country":"US","phoneNumber":"650-432-0000","address1":"900 Metro Center","postalCode":"94404-2775","locality":"Foster City","name":"Visa Inc","administrativeArea":"CA","region":"PEN","email":"test@cybs.com"},"name":"V-International","aggregatorId":"123456789"},"orderInformation":{"billTo":{"country":"US","lastName":"Doe","address2":"Address 2","address1":"201 S. Division St.","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","firstName":"John","phoneNumber":"999999999","district":"MI","buildingNumber":"123","company":"Visa","email":"test@cybs.com"},"invoiceDetails":{"purchaseOrderNumber":"LevelII Auth Po"},"amountDetails":{"totalAmount":"112.00","currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12","type":"001"}}}},"example8":{"summary":"Level III Data","value":{"clientReferenceInformation":{"code":"TC50171_14"},"processingInformation":{"commerceIndicator":"internet","purchaseLevel":"3"},"aggregatorInformation":{"subMerchant":{"cardAcceptorId":"1234567890","country":"US","phoneNumber":"650-432-0000","address1":"900 Metro Center","postalCode":"94404-2775","locality":"Foster City","name":"Visa Inc","administrativeArea":"CA","region":"PEN","email":"test@cybs.com"},"name":"V-Internatio","aggregatorId":"123456789"},"orderInformation":{"billTo":{"country":"US","lastName":"Doe","address2":"Address 2","address1":"201 S. Division St.","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","firstName":"John","phoneNumber":"999999999","district":"MI","buildingNumber":"123","company":"Visa","email":"test@cybs.com"},"invoiceDetails":{"purchaseOrderNumber":"LevelIII Auth Po"},"amountDetails":{"totalAmount":"114.00","currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12","type":"001"}}}},"example9":{"summary":"Partial Authorization","value":{"clientReferenceInformation":{"code":"1234567890"},"pointOfSaleInformation":{"cardPresent":"true","catLevel":"6","emv":{"fallbackCondition":"swiped","fallback":"N"},"terminalCapability":"4"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Doe","address1":"901 Metro Center Blvd","postalCode":"40500","locality":"Foster City","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":"7012.00","currency":"USD"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","securityCode":"123","expirationMonth":"12"}}}}}}},"/pts/v2/payments/{id}/reversals":{"post":{"summary":"Process an Authorization Reversal","description":"Include the payment ID in the POST request to reverse the payment amount.","tags":["reversal"],"operationId":"authReversal","parameters":[{"name":"id","in":"path","description":"The payment ID returned from a previous payment request.","required":true,"type":"string"},{"name":"authReversalRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"comments":{"type":"string","description":"Comments"}}},"reversalInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"reason":{"type":"string","maxLength":3,"description":"Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n"}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"issuer":{"type":"object","properties":{"discretionaryData":{"type":"string","maxLength":255,"description":"Data defined by the issuer. The value for this reply field will probably be the same as the value that you\nsubmitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify\nthe value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n"}}}}},"orderInformation":{"type":"object","properties":{"lineItems":{"type":"array","items":{"type":"object","properties":{"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"}}}}}},"example":{"clientReferenceInformation":{"code":"TC50171_3"},"reversalInformation":{"reason":"testing","amountDetails":{"totalAmount":"102.21"}}}}}],"responses":{"201":{"description":"Successful response.","schema":{"type":"object","title":"ptsV2PaymentsReversalsPost201Response","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["REVERSED"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"reversalAmountDetails":{"type":"object","properties":{"reversedAmount":{"type":"string","maxLength":15,"description":"Total reversed amount."},"originalTransactionAmount":{"type":"string","maxLength":15,"description":"Amount of the original transaction."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"processorInformation":{"type":"object","properties":{"transactionId":{"type":"string","maxLength":18,"description":"Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"},"responseCode":{"type":"string","maxLength":10,"description":"For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"},"responseCategoryCode":{"type":"string","maxLength":32,"description":"Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n"},"forwardedAcquirerCode":{"type":"string","maxLength":32,"description":"Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"},"masterCardServiceCode":{"type":"string","maxLength":2,"description":"Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n"},"masterCardServiceReplyCode":{"type":"string","maxLength":1,"description":"Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n"}}},"authorizationInformation":{"type":"object","properties":{"approvalCode":{"type":"string","maxLength":6,"description":"The authorization code returned by the processor."},"reasonCode":{"type":"string","maxLength":50,"description":"Reply flag for the original transaction."}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"}}}}}},"example":{"_links":{"self":{"href":"/pts/v2/reversals/4963015523026180001545","method":"GET"}},"id":"4963015523026180001545","submitTimeUtc":"2017-06-01T071912Z","status":"200","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"TC50171_3"},"orderInformation":{"amountDetails":{"currency":"USD"}},"processorInformation":{"responseCode":"100"},"reversalAmountDetails":{"reversedAmount":"102.21","currency":"USD"}}}},"400":{"description":"Invalid request.","schema":{"type":"object","title":"ptsV2PaymentsReversalsPost400Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","AUTH_ALREADY_REVERSED","MISSING_AUTH","TRANSACTION_ALREADY_REVERSED_OR_SETTLED"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"type":"object","title":"ptsV2PaymentsReversalsPost502Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Process an Authorization Reversal","value":{"clientReferenceInformation":{"code":"TC50171_3"},"reversalInformation":{"reason":"testing","amountDetails":{"totalAmount":"102.21"}}}}}}},"/pts/v2/payments/{id}/captures":{"post":{"summary":"Capture a Payment","description":"Include the payment ID in the POST request to capture the payment amount.","tags":["capture"],"operationId":"capturePayment","parameters":[{"name":"capturePaymentRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"transactionId":{"type":"string","description":"Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176\n"},"comments":{"type":"string","description":"Comments"}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"purchaseLevel":{"type":"string","maxLength":1,"description":"Set this field to 3 to indicate that the request includes Level III data."},"issuer":{"type":"object","properties":{"discretionaryData":{"type":"string","maxLength":255,"description":"Data defined by the issuer. The value for this reply field will probably be the same as the value that you\nsubmitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify\nthe value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n"}}},"authorizationOptions":{"type":"object","properties":{"authType":{"type":"string","maxLength":15,"description":"Authorization type. Possible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture\n request for a verbal payment.\n\nFor processor-specific information, see the auth_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"verbalAuthCode":{"type":"string","maxLength":7,"description":"Authorization code.\n\n**Forced Capture**\n\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\n\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the auth_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"verbalAuthTransactionId":{"type":"string","maxLength":15,"description":"Transaction ID (TID)."}}},"captureOptions":{"type":"object","properties":{"captureSequenceNumber":{"type":"number","minimum":1,"maximum":99,"description":"Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"},"totalCaptureCount":{"type":"number","minimum":1,"maximum":99,"description":"Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n"}}}}},"paymentInformation":{"type":"object","properties":{"customer":{"type":"object","properties":{"customerId":{"type":"string","maxLength":26,"description":"Unique identifier for the customer's card and billing information."}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"discountAmount":{"type":"string","maxLength":15,"description":"Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"dutyAmount":{"type":"string","maxLength":15,"description":"Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"nationalTaxIncluded":{"type":"string","maxLength":1,"description":"Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedLevel":{"type":"string","maxLength":1,"description":"Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxTypeCode":{"type":"string","maxLength":3,"description":"For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"freightAmount":{"type":"string","maxLength":13,"description":"Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"foreignAmount":{"type":"string","maxLength":15,"description":"Converted amount returned by the DCC service.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"foreignCurrency":{"type":"string","maxLength":5,"description":"Billing currency returned by the DCC service.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRate":{"type":"string","maxLength":13,"description":"Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRateTimeStamp":{"type":"string","maxLength":14,"description":"Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amexAdditionalAmounts":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amount":{"type":"string","maxLength":12,"description":"Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"unitOfMeasure":{"type":"string","maxLength":12,"description":"Unit of measure, or unit of measure code, for the item.\n"},"totalAmount":{"type":"string","maxLength":13,"description":"Total amount for the item. Normally calculated as the unit price x quantity.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"taxRate":{"type":"string","maxLength":7,"description":"Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n"},"taxStatusIndicator":{"type":"string","maxLength":1,"description":"Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n"},"taxTypeCode":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"amountIncludesTax":{"type":"boolean","description":"Flag that indicates whether the tax amount is included in the Line Item Total.\n","enum":[true,false]},"typeOfSupply":{"type":"string","maxLength":2,"description":"Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n"},"commodityCode":{"type":"string","maxLength":15,"description":"Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n"},"discountAmount":{"type":"string","maxLength":13,"description":"Discount applied to the item."},"discountApplied":{"type":"boolean","description":"Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n","enum":[true,false]},"discountRate":{"type":"string","maxLength":6,"description":"Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n"},"invoiceNumber":{"type":"string","maxLength":23,"description":"Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n"},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}},"fulfillmentType":{"type":"string","description":"TODO"}}}},"invoiceDetails":{"type":"object","properties":{"purchaseOrderNumber":{"type":"string","maxLength":25,"description":"Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseOrderDate":{"type":"string","maxLength":10,"description":"Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseContactName":{"type":"string","maxLength":36,"description":"The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxable":{"type":"boolean","description":"Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]},"vatInvoiceReferenceNumber":{"type":"string","maxLength":15,"description":"VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"commodityCode":{"type":"string","maxLength":4,"description":"International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"transactionAdviceAddendum":{"type":"array","items":{"type":"object","properties":{"data":{"type":"string","maxLength":40,"description":"Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"}}}}}},"shippingDetails":{"type":"object","properties":{"shipFromPostalCode":{"type":"string","maxLength":10,"description":"Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":20,"description":"Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"deviceInformation":{"type":"object","properties":{"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"userAgent":{"type":"string","maxLength":40,"description":"Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"alternateName":{"type":"string","maxLength":13,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"},"address1":{"type":"string","maxLength":60,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"cardAcceptorReferenceNumber":{"type":"string","maxLength":25,"description":"Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"aggregatorInformation":{"type":"object","properties":{"aggregatorId":{"type":"string","maxLength":20,"description":"Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\nFor processor-specific information, see the aggregator_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"name":{"type":"string","maxLength":37,"description":"Your payment aggregator business name.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"subMerchant":{"type":"object","properties":{"name":{"type":"string","maxLength":37,"description":"Sub-merchant\u2019s business name."},"address1":{"type":"string","maxLength":38,"description":"First line of the sub-merchant\u2019s street address."},"locality":{"type":"string","maxLength":21,"description":"Sub-merchant\u2019s city."},"administrativeArea":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"postalCode":{"type":"string","maxLength":15,"description":"Partial postal code for the sub-merchant\u2019s address."},"country":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes."},"email":{"type":"string","maxLength":40,"description":"Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n"},"phoneNumber":{"type":"string","maxLength":20,"description":"Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"},"fallback":{"type":"boolean","maxLength":5,"description":"Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n","enum":[true,false],"default":false}}},"amexCapnData":{"type":"string","maxLength":12,"description":"Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n"}}},"merchantDefinedInformation":{"type":"array","description":"Description of this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"Description of this field is not available."},"value":{"type":"string","maxLength":255,"description":"Description of this field is not available."}}}}},"example":{"clientReferenceInformation":{"code":"TC50171_3"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}},{"name":"id","in":"path","description":"The payment ID returned from a previous payment request. This ID links the capture to the payment.\n","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"type":"object","title":"ptsV2PaymentsCapturesPost201Response","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"void":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"refund":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["PENDING"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"processorInformation":{"type":"object","properties":{"transactionId":{"type":"string","maxLength":18,"description":"Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":15,"description":"Amount you requested for the capture.\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"invoiceDetails":{"type":"object","properties":{"level3TransmissionStatus":{"type":"boolean","description":"Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]}}}}}},"example":{"_links":{"self":{"href":"/pts/v2/captures/4963014519526177701545","method":"GET"},"refund":{"href":"/pts/v2/captures/4963014519526177701545/refunds","method":"POST"},"void":{"href":"/pts/v2/captures/4963014519526177701545/voids","method":"POST"}},"id":"4963014519526177701545","submitTimeUtc":"2017-06-01T071731Z","status":"200","reconciliationId":"39570715X3E1LBQA","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"TC50171_3"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}},"400":{"description":"Invalid request.","schema":{"type":"object","title":"ptsV2PaymentsCapturesPost400Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","EXCEEDS_AUTH_AMOUNT","AUTH_ALREADY_REVERSED","TRANSACTION_ALREADY_SETTLED","MISSING_AUTH","TRANSACTION_ALREADY_REVERSED_OR_SETTLED"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"type":"object","title":"ptsV2PaymentsCapturesPost502Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Capture a Payment","value":{"clientReferenceInformation":{"code":"TC50171_3"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}}}},"/pts/v2/payments/{id}/refunds":{"post":{"summary":"Refund a Payment","description":"Include the payment ID in the POST request to refund the payment amount.\n","tags":["refund"],"operationId":"refundPayment","parameters":[{"name":"refundPaymentRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"transactionId":{"type":"string","description":"Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176\n"},"comments":{"type":"string","description":"Comments"}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"purchaseLevel":{"type":"string","maxLength":1,"description":"Set this field to 3 to indicate that the request includes Level III data."},"recurringOptions":{"type":"object","properties":{"loanPayment":{"type":"boolean","description":"Flag that indicates whether this is a payment towards an existing contractual loan.\n","enum":[true,false],"default":false}}}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"number":{"type":"string","maxLength":20,"description":"Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"accountEncoderId":{"type":"string","maxLength":3,"description":"Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n"},"issueNumber":{"type":"string","maxLength":5,"description":"Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n"},"startMonth":{"type":"string","maxLength":2,"description":"Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"startYear":{"type":"string","maxLength":4,"description":"Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"discountAmount":{"type":"string","maxLength":15,"description":"Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"dutyAmount":{"type":"string","maxLength":15,"description":"Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"nationalTaxIncluded":{"type":"string","maxLength":1,"description":"Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedLevel":{"type":"string","maxLength":1,"description":"Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxTypeCode":{"type":"string","maxLength":3,"description":"For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"freightAmount":{"type":"string","maxLength":13,"description":"Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"foreignAmount":{"type":"string","maxLength":15,"description":"Converted amount returned by the DCC service.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"foreignCurrency":{"type":"string","maxLength":5,"description":"Billing currency returned by the DCC service.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRate":{"type":"string","maxLength":13,"description":"Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRateTimeStamp":{"type":"string","maxLength":14,"description":"Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amexAdditionalAmounts":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amount":{"type":"string","maxLength":12,"description":"Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"unitOfMeasure":{"type":"string","maxLength":12,"description":"Unit of measure, or unit of measure code, for the item.\n"},"totalAmount":{"type":"string","maxLength":13,"description":"Total amount for the item. Normally calculated as the unit price x quantity.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"taxRate":{"type":"string","maxLength":7,"description":"Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n"},"taxStatusIndicator":{"type":"string","maxLength":1,"description":"Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n"},"taxTypeCode":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"amountIncludesTax":{"type":"boolean","description":"Flag that indicates whether the tax amount is included in the Line Item Total.\n","enum":[true,false]},"typeOfSupply":{"type":"string","maxLength":2,"description":"Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n"},"commodityCode":{"type":"string","maxLength":15,"description":"Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n"},"discountAmount":{"type":"string","maxLength":13,"description":"Discount applied to the item."},"discountApplied":{"type":"boolean","description":"Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n","enum":[true,false]},"discountRate":{"type":"string","maxLength":6,"description":"Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n"},"invoiceNumber":{"type":"string","maxLength":23,"description":"Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n"},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}}},"invoiceDetails":{"type":"object","properties":{"purchaseOrderNumber":{"type":"string","maxLength":25,"description":"Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseOrderDate":{"type":"string","maxLength":10,"description":"Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseContactName":{"type":"string","maxLength":36,"description":"The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxable":{"type":"boolean","description":"Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]},"vatInvoiceReferenceNumber":{"type":"string","maxLength":15,"description":"VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"commodityCode":{"type":"string","maxLength":4,"description":"International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"transactionAdviceAddendum":{"type":"array","items":{"type":"object","properties":{"data":{"type":"string","maxLength":40,"description":"Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"}}}}}},"shippingDetails":{"type":"object","properties":{"shipFromPostalCode":{"type":"string","maxLength":10,"description":"Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":20,"description":"Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"deviceInformation":{"type":"object","properties":{"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"userAgent":{"type":"string","maxLength":40,"description":"Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"alternateName":{"type":"string","maxLength":13,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"},"address1":{"type":"string","maxLength":60,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"cardAcceptorReferenceNumber":{"type":"string","maxLength":25,"description":"Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"aggregatorInformation":{"type":"object","properties":{"aggregatorId":{"type":"string","maxLength":20,"description":"Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\nFor processor-specific information, see the aggregator_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"name":{"type":"string","maxLength":37,"description":"Your payment aggregator business name.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"subMerchant":{"type":"object","properties":{"name":{"type":"string","maxLength":37,"description":"Sub-merchant\u2019s business name."},"address1":{"type":"string","maxLength":38,"description":"First line of the sub-merchant\u2019s street address."},"locality":{"type":"string","maxLength":21,"description":"Sub-merchant\u2019s city."},"administrativeArea":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"postalCode":{"type":"string","maxLength":15,"description":"Partial postal code for the sub-merchant\u2019s address."},"country":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes."},"email":{"type":"string","maxLength":40,"description":"Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n"},"phoneNumber":{"type":"string","maxLength":20,"description":"Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"},"fallback":{"type":"boolean","maxLength":5,"description":"Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n","enum":[true,false],"default":false}}}}},"merchantDefinedInformation":{"type":"array","description":"Description of this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"Description of this field is not available."},"value":{"type":"string","maxLength":255,"description":"Description of this field is not available."}}}}},"example":{"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}},{"name":"id","in":"path","description":"The payment ID. This ID is returned from a previous payment request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"type":"object","title":"ptsV2PaymentsRefundPost201Response","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"void":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["PENDING"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"refundAmountDetails":{"type":"object","properties":{"refundAmount":{"type":"string","maxLength":15,"description":"Total amount of the refund."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"processorInformation":{"type":"object","properties":{"transactionId":{"type":"string","maxLength":18,"description":"Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"},"forwardedAcquirerCode":{"type":"string","maxLength":32,"description":"Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"}}},"orderInformation":{"type":"object","properties":{"invoiceDetails":{"type":"object","properties":{"level3TransmissionStatus":{"type":"boolean","description":"Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]}}}}}},"example":{"_links":{"self":{"href":"/pts/v2/refunds/4963014779006178301545","method":"GET"},"void":{"href":"/pts/v2/refunds/4963014779006178301545/voids","method":"POST"}},"id":"4963014779006178301545","submitTimeUtc":"2017-06-01T071757Z","status":"200","reconciliationId":"39571012D3DFEKS0","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"currency":"USD"}},"refundAmountDetails":{"currency":"USD","refundAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"type":"object","title":"ptsV2PaymentsRefundPost400Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_CARD","INVALID_MERCHANT_CONFIGURATION","CAPTURE_ALREADY_VOIDED","ACCOUNT_NOT_ALLOWED_CREDIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"type":"object","title":"ptsV2PaymentsRefundPost502Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Refund a Payment","value":{"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}}}},"/pts/v2/captures/{id}/refunds":{"post":{"summary":"Refund a Capture","description":"Include the capture ID in the POST request to refund the captured amount.\n","tags":["refund"],"operationId":"refundCapture","parameters":[{"name":"refundCaptureRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"transactionId":{"type":"string","description":"Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176\n"},"comments":{"type":"string","description":"Comments"}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"purchaseLevel":{"type":"string","maxLength":1,"description":"Set this field to 3 to indicate that the request includes Level III data."},"recurringOptions":{"type":"object","properties":{"loanPayment":{"type":"boolean","description":"Flag that indicates whether this is a payment towards an existing contractual loan.\n","enum":[true,false],"default":false}}}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"number":{"type":"string","maxLength":20,"description":"Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"accountEncoderId":{"type":"string","maxLength":3,"description":"Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n"},"issueNumber":{"type":"string","maxLength":5,"description":"Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n"},"startMonth":{"type":"string","maxLength":2,"description":"Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"startYear":{"type":"string","maxLength":4,"description":"Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"discountAmount":{"type":"string","maxLength":15,"description":"Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"dutyAmount":{"type":"string","maxLength":15,"description":"Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"nationalTaxIncluded":{"type":"string","maxLength":1,"description":"Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedLevel":{"type":"string","maxLength":1,"description":"Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxTypeCode":{"type":"string","maxLength":3,"description":"For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"freightAmount":{"type":"string","maxLength":13,"description":"Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"foreignAmount":{"type":"string","maxLength":15,"description":"Converted amount returned by the DCC service.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"foreignCurrency":{"type":"string","maxLength":5,"description":"Billing currency returned by the DCC service.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRate":{"type":"string","maxLength":13,"description":"Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRateTimeStamp":{"type":"string","maxLength":14,"description":"Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amexAdditionalAmounts":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amount":{"type":"string","maxLength":12,"description":"Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"unitOfMeasure":{"type":"string","maxLength":12,"description":"Unit of measure, or unit of measure code, for the item.\n"},"totalAmount":{"type":"string","maxLength":13,"description":"Total amount for the item. Normally calculated as the unit price x quantity.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"taxRate":{"type":"string","maxLength":7,"description":"Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n"},"taxStatusIndicator":{"type":"string","maxLength":1,"description":"Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n"},"taxTypeCode":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"amountIncludesTax":{"type":"boolean","description":"Flag that indicates whether the tax amount is included in the Line Item Total.\n","enum":[true,false]},"typeOfSupply":{"type":"string","maxLength":2,"description":"Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n"},"commodityCode":{"type":"string","maxLength":15,"description":"Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n"},"discountAmount":{"type":"string","maxLength":13,"description":"Discount applied to the item."},"discountApplied":{"type":"boolean","description":"Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n","enum":[true,false]},"discountRate":{"type":"string","maxLength":6,"description":"Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n"},"invoiceNumber":{"type":"string","maxLength":23,"description":"Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n"},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}}},"invoiceDetails":{"type":"object","properties":{"purchaseOrderNumber":{"type":"string","maxLength":25,"description":"Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseOrderDate":{"type":"string","maxLength":10,"description":"Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseContactName":{"type":"string","maxLength":36,"description":"The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxable":{"type":"boolean","description":"Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]},"vatInvoiceReferenceNumber":{"type":"string","maxLength":15,"description":"VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"commodityCode":{"type":"string","maxLength":4,"description":"International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"transactionAdviceAddendum":{"type":"array","items":{"type":"object","properties":{"data":{"type":"string","maxLength":40,"description":"Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"}}}}}},"shippingDetails":{"type":"object","properties":{"shipFromPostalCode":{"type":"string","maxLength":10,"description":"Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":20,"description":"Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"deviceInformation":{"type":"object","properties":{"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"userAgent":{"type":"string","maxLength":40,"description":"Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"alternateName":{"type":"string","maxLength":13,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"},"address1":{"type":"string","maxLength":60,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"cardAcceptorReferenceNumber":{"type":"string","maxLength":25,"description":"Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"aggregatorInformation":{"type":"object","properties":{"aggregatorId":{"type":"string","maxLength":20,"description":"Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\nFor processor-specific information, see the aggregator_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"name":{"type":"string","maxLength":37,"description":"Your payment aggregator business name.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"subMerchant":{"type":"object","properties":{"name":{"type":"string","maxLength":37,"description":"Sub-merchant\u2019s business name."},"address1":{"type":"string","maxLength":38,"description":"First line of the sub-merchant\u2019s street address."},"locality":{"type":"string","maxLength":21,"description":"Sub-merchant\u2019s city."},"administrativeArea":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"postalCode":{"type":"string","maxLength":15,"description":"Partial postal code for the sub-merchant\u2019s address."},"country":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes."},"email":{"type":"string","maxLength":40,"description":"Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n"},"phoneNumber":{"type":"string","maxLength":20,"description":"Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"},"fallback":{"type":"boolean","maxLength":5,"description":"Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n","enum":[true,false],"default":false}}}}},"merchantDefinedInformation":{"type":"array","description":"Description of this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"Description of this field is not available."},"value":{"type":"string","maxLength":255,"description":"Description of this field is not available."}}}}},"example":{"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}},{"name":"id","in":"path","description":"The capture ID. This ID is returned from a previous capture request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"type":"object","title":"ptsV2CapturesRefundsPost201Response","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"void":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["PENDING"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"refundAmountDetails":{"type":"object","properties":{"refundAmount":{"type":"string","maxLength":15,"description":"Total amount of the refund."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"processorInformation":{"type":"object","properties":{"transactionId":{"type":"string","maxLength":18,"description":"Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"},"forwardedAcquirerCode":{"type":"string","maxLength":32,"description":"Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"}}},"orderInformation":{"type":"object","properties":{"invoiceDetails":{"type":"object","properties":{"level3TransmissionStatus":{"type":"boolean","description":"Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]}}}}}},"example":{"_links":{"self":{"href":"/pts/v2/refunds/4963014779006178301545","method":"GET"},"void":{"href":"/pts/v2/refunds/4963014779006178301545/voids","method":"POST"}},"id":"4963014779006178301545","submitTimeUtc":"2017-06-01T071757Z","status":"200","reconciliationId":"39571012D3DFEKS0","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"currency":"USD"}},"refundAmountDetails":{"currency":"USD","refundAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2CapturesRefundsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_CARD","INVALID_MERCHANT_CONFIGURATION","CAPTURE_ALREADY_VOIDED","ACCOUNT_NOT_ALLOWED_CREDIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2CapturesRefundsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Refund a Capture","value":{"clientReferenceInformation":{"code":"Testing-Payments-Refund"},"orderInformation":{"amountDetails":{"totalAmount":"102.21","currency":"USD"}}}}}}},"/pts/v2/credits/":{"post":{"summary":"Process a Credit","description":"POST to the credit resource to credit funds to a specified credit card.","tags":["credit"],"operationId":"createCredit","parameters":[{"name":"createCreditRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"transactionId":{"type":"string","description":"Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176\n"},"comments":{"type":"string","description":"Comments"}}},"processingInformation":{"type":"object","properties":{"commerceIndicator":{"type":"string","maxLength":20,"description":"Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n"},"processorId":{"type":"string","maxLength":3,"description":"Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n"},"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"linkId":{"type":"string","maxLength":26,"description":"Value that links the current payment request to the original request. Set this value\nto the ID that was returned in the reply message from the original payment request.\n\nThis value is used for:\n\n - Partial authorizations.\n - Split shipments.\n"},"reportGroup":{"type":"string","maxLength":25,"description":"Attribute that lets you define custom grouping for your processor reports. This field is supported only for\n**Litle**.\n"},"visaCheckoutId":{"type":"string","maxLength":48,"description":"Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n"},"purchaseLevel":{"type":"string","maxLength":1,"description":"Set this field to 3 to indicate that the request includes Level III data."},"recurringOptions":{"type":"object","properties":{"loanPayment":{"type":"boolean","description":"Flag that indicates whether this is a payment towards an existing contractual loan.\n","enum":[true,false],"default":false}}}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"number":{"type":"string","maxLength":20,"description":"Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"accountEncoderId":{"type":"string","maxLength":3,"description":"Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n"},"issueNumber":{"type":"string","maxLength":5,"description":"Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n"},"startMonth":{"type":"string","maxLength":2,"description":"Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"startYear":{"type":"string","maxLength":4,"description":"Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"discountAmount":{"type":"string","maxLength":15,"description":"Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"dutyAmount":{"type":"string","maxLength":15,"description":"Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"nationalTaxIncluded":{"type":"string","maxLength":1,"description":"Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxAppliedLevel":{"type":"string","maxLength":1,"description":"Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxTypeCode":{"type":"string","maxLength":3,"description":"For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"freightAmount":{"type":"string","maxLength":13,"description":"Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"foreignAmount":{"type":"string","maxLength":15,"description":"Converted amount returned by the DCC service.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"foreignCurrency":{"type":"string","maxLength":5,"description":"Billing currency returned by the DCC service.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRate":{"type":"string","maxLength":13,"description":"Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"exchangeRateTimeStamp":{"type":"string","maxLength":14,"description":"Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amexAdditionalAmounts":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","maxLength":3,"description":"Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"amount":{"type":"string","maxLength":12,"description":"Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"unitOfMeasure":{"type":"string","maxLength":12,"description":"Unit of measure, or unit of measure code, for the item.\n"},"totalAmount":{"type":"string","maxLength":13,"description":"Total amount for the item. Normally calculated as the unit price x quantity.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"taxRate":{"type":"string","maxLength":7,"description":"Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n"},"taxAppliedAfterDiscount":{"type":"string","maxLength":1,"description":"Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n"},"taxStatusIndicator":{"type":"string","maxLength":1,"description":"Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n"},"taxTypeCode":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"amountIncludesTax":{"type":"boolean","description":"Flag that indicates whether the tax amount is included in the Line Item Total.\n","enum":[true,false]},"typeOfSupply":{"type":"string","maxLength":2,"description":"Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n"},"commodityCode":{"type":"string","maxLength":15,"description":"Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n"},"discountAmount":{"type":"string","maxLength":13,"description":"Discount applied to the item."},"discountApplied":{"type":"boolean","description":"Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n","enum":[true,false]},"discountRate":{"type":"string","maxLength":6,"description":"Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n"},"invoiceNumber":{"type":"string","maxLength":23,"description":"Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n"},"taxDetails":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n","enum":["alternate","local","national","vat"]},"amount":{"type":"string","maxLength":13,"description":"Please see below table for related decription based on above _type_ field.\n\n| type | amount description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n"},"rate":{"type":"string","maxLength":6,"description":"Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n"},"code":{"type":"string","maxLength":4,"description":"Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax\n - 0011: goods and services tax\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - Blank: Tax not supported on line item.\n"},"taxId":{"type":"string","maxLength":15,"description":"Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n"},"applied":{"type":"boolean","description":"The tax is applied. Valid value is `true` or `false`."}}}}}}},"invoiceDetails":{"type":"object","properties":{"purchaseOrderNumber":{"type":"string","maxLength":25,"description":"Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseOrderDate":{"type":"string","maxLength":10,"description":"Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"purchaseContactName":{"type":"string","maxLength":36,"description":"The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"taxable":{"type":"boolean","description":"Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]},"vatInvoiceReferenceNumber":{"type":"string","maxLength":15,"description":"VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"commodityCode":{"type":"string","maxLength":4,"description":"International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"transactionAdviceAddendum":{"type":"array","items":{"type":"object","properties":{"data":{"type":"string","maxLength":40,"description":"Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n"}}}}}},"shippingDetails":{"type":"object","properties":{"shipFromPostalCode":{"type":"string","maxLength":10,"description":"Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n"}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":20,"description":"Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"deviceInformation":{"type":"object","properties":{"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"userAgent":{"type":"string","maxLength":40,"description":"Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"alternateName":{"type":"string","maxLength":13,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"},"address1":{"type":"string","maxLength":60,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"cardAcceptorReferenceNumber":{"type":"string","maxLength":25,"description":"Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"}}},"aggregatorInformation":{"type":"object","properties":{"aggregatorId":{"type":"string","maxLength":20,"description":"Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\nFor processor-specific information, see the aggregator_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"name":{"type":"string","maxLength":37,"description":"Your payment aggregator business name.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"subMerchant":{"type":"object","properties":{"name":{"type":"string","maxLength":37,"description":"Sub-merchant\u2019s business name."},"address1":{"type":"string","maxLength":38,"description":"First line of the sub-merchant\u2019s street address."},"locality":{"type":"string","maxLength":21,"description":"Sub-merchant\u2019s city."},"administrativeArea":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"postalCode":{"type":"string","maxLength":15,"description":"Partial postal code for the sub-merchant\u2019s address."},"country":{"type":"string","maxLength":3,"description":"Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes."},"email":{"type":"string","maxLength":40,"description":"Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n"},"phoneNumber":{"type":"string","maxLength":20,"description":"Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"emv":{"type":"object","properties":{"tags":{"type":"string","maxLength":1998,"description":"EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\n`Important` The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n`Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n"},"fallback":{"type":"boolean","maxLength":5,"description":"Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n","enum":[true,false],"default":false},"fallbackCondition":{"type":"number","description":"Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n"}}}}},"merchantDefinedInformation":{"type":"array","description":"Description of this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"Description of this field is not available."},"value":{"type":"string","maxLength":255,"description":"Description of this field is not available."}}}}},"example":{"clientReferenceInformation":{"code":"12345678"},"orderInformation":{"billTo":{"country":"US","firstName":"Test","lastName":"test","phoneNumber":"9999999999","address1":"test","postalCode":"48104-2201","locality":"Ann Arbor","administrativeArea":"MI","email":"test@cybs.com"},"amountDetails":{"totalAmount":"200","currency":"usd"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","expirationMonth":"03","type":"001"}}}}}],"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2CreditsPost201Response","type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}},"void":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["PENDING"]},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"creditAmountDetails":{"type":"object","properties":{"creditAmount":{"type":"string","maxLength":15,"description":"Total amount of the credit."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}},"processorInformation":{"type":"object","properties":{"transactionId":{"type":"string","maxLength":18,"description":"Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n"},"forwardedAcquirerCode":{"type":"string","maxLength":32,"description":"Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n"}}},"orderInformation":{"type":"object","properties":{"invoiceDetails":{"type":"object","properties":{"level3TransmissionStatus":{"type":"boolean","description":"Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n","enum":[true,false]}}}}}},"example":{"_links":{"self":{"href":"/pts/v2/credits/4963014324246004901546","method":"GET"},"void":{"href":"/pts/v2/credits/4963014324246004901546/voids","method":"POST"}},"id":"4963014324246004901546","submitTimeUtc":"2017-06-01T071712Z","status":"200","reconciliationId":"39570714X3E1LBQ8","statusInformation":{"reason":"SUCCESS","message":"Successful transaction."},"clientReferenceInformation":{"code":"12345678"},"creditAmountDetails":{"currency":"usd","creditAmount":"200.00"},"orderInformation":{"amountDetails":{"currency":"usd"}}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2CreditsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_CARD","INVALID_MERCHANT_CONFIGURATION","CAPTURE_ALREADY_VOIDED","ACCOUNT_NOT_ALLOWED_CREDIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2CreditsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Credit","value":{"clientReferenceInformation":{"code":"12345678"},"orderInformation":{"billTo":{"country":"US","firstName":"John","lastName":"Deo","phoneNumber":"9321499232","address1":"900 Metro Center Blvd","postalCode":"48104-2201","locality":"Foster City","administrativeArea":"CA","email":"test@cybs.com"},"amountDetails":{"totalAmount":"200","currency":"usd"}},"paymentInformation":{"card":{"expirationYear":"2031","number":"4111111111111111","expirationMonth":"03","type":"001"}}}}}}},"/pts/v2/payments/{id}/voids":{"post":{"summary":"Void a Payment","description":"Include the payment ID in the POST request to cancel the payment.","tags":["void"],"operationId":"voidPayment","parameters":[{"name":"voidPaymentRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"comments":{"type":"string","description":"Comments"}}}},"example":{"clientReferenceInformation":{"code":"test_void"}}}},{"name":"id","in":"path","description":"The payment ID returned from a previous payment request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2PaymentsVoidsPost201Response","type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["VOIDED"]},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"voidAmountDetails":{"type":"object","properties":{"voidAmount":{"type":"string","description":"Total amount of the void."},"originalTransactionAmount":{"type":"string","description":"Amount of the original transaction."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}},"example":{"_links":{"self":{"href":"/pts/v2/voids/4963015122056179201545","method":"GET"}},"id":"4963015122056179201545","submitTimeUtc":"2017-06-01T071832Z","status":"VOIDED","clientReferenceInformation":{"code":"test_void"},"orderInformation":{"amountDetails":{"currency":"USD"}},"voidAmountDetails":{"currency":"usd","voidAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2PaymentsVoidsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","NOT_VOIDABLE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2PaymentsVoidsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Void a Payment","value":{"clientReferenceInformation":{"code":"test_void"}}}}}},"/pts/v2/captures/{id}/voids":{"post":{"summary":"Void a Capture","description":"Include the capture ID in the POST request to cancel the capture.","tags":["void"],"operationId":"voidCapture","parameters":[{"name":"voidCaptureRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"comments":{"type":"string","description":"Comments"}}}},"example":{"clientReferenceInformation":{"code":"test_void"}}}},{"name":"id","in":"path","description":"The capture ID returned from a previous capture request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2CapturesVoidsPost201Response","type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["VOIDED"]},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"voidAmountDetails":{"type":"object","properties":{"voidAmount":{"type":"string","description":"Total amount of the void."},"originalTransactionAmount":{"type":"string","description":"Amount of the original transaction."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}},"example":{"_links":{"self":{"href":"/pts/v2/voids/4963015122056179201545","method":"GET"}},"id":"4963015122056179201545","submitTimeUtc":"2017-06-01T071832Z","status":"VOIDED","clientReferenceInformation":{"code":"test_void"},"orderInformation":{"amountDetails":{"currency":"USD"}},"voidAmountDetails":{"currency":"usd","voidAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2CapturesVoidsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","NOT_VOIDABLE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2CapturesVoidsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Void a Capture","value":{"clientReferenceInformation":{"code":"test_void"}}}}}},"/pts/v2/refunds/{id}/voids":{"post":{"summary":"Void a Refund","description":"Include the refund ID in the POST request to cancel the refund.","tags":["void"],"operationId":"voidRefund","parameters":[{"name":"voidRefundRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"comments":{"type":"string","description":"Comments"}}}},"example":{"clientReferenceInformation":{"code":"test_void"}}}},{"name":"id","in":"path","description":"The refund ID returned from a previous refund request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2RefundsVoidsPost201Response","type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["VOIDED"]},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"voidAmountDetails":{"type":"object","properties":{"voidAmount":{"type":"string","description":"Total amount of the void."},"originalTransactionAmount":{"type":"string","description":"Amount of the original transaction."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}},"example":{"_links":{"self":{"href":"/pts/v2/voids/4963015122056179201545","method":"GET"}},"id":"4963015122056179201545","submitTimeUtc":"2017-06-01T071832Z","status":"VOIDED","clientReferenceInformation":{"code":"test_void"},"orderInformation":{"amountDetails":{"currency":"USD"}},"voidAmountDetails":{"currency":"usd","voidAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2RefundsVoidsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","NOT_VOIDABLE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2RefundsVoidsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Void a Refund","value":{"clientReferenceInformation":{"code":"test_void"}}}}}},"/pts/v2/credits/{id}/voids":{"post":{"summary":"Void a Credit","description":"Include the credit ID in the POST request to cancel the credit.","tags":["Void"],"operationId":"voidCredit","parameters":[{"name":"voidCreditRequest","in":"body","required":true,"schema":{"type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"comments":{"type":"string","description":"Comments"}}}},"example":{"clientReferenceInformation":{"code":"test_void"}}}},{"name":"id","in":"path","description":"The credit ID returned from a previous credit request.","required":true,"type":"string"}],"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2CreditsVoidsPost201Response","type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["VOIDED"]},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"voidAmountDetails":{"type":"object","properties":{"voidAmount":{"type":"string","description":"Total amount of the void."},"originalTransactionAmount":{"type":"string","description":"Amount of the original transaction."},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}},"example":{"_links":{"self":{"href":"/pts/v2/voids/4963015122056179201545","method":"GET"}},"id":"4963015122056179201545","submitTimeUtc":"2017-06-01T071832Z","status":"VOIDED","clientReferenceInformation":{"code":"test_void"},"orderInformation":{"amountDetails":{"currency":"USD"}},"voidAmountDetails":{"currency":"usd","voidAmount":"102.21"}}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2CreditsVoidsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","NOT_VOIDABLE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2CreditsVoidsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}},"x-example":{"example0":{"summary":"Void a Credit","value":{"clientReferenceInformation":{"code":"test_void"}}}}}},"/pts/v1/transaction-batches":{"get":{"summary":"Get a list of batch files processed through the Offline Transaction Submission Services","description":"Provide the search range","tags":["TransactionBatches"],"produces":["application/hal+json"],"parameters":[{"name":"startTime","in":"query","description":"Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n","required":true,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n","required":true,"type":"string","format":"date-time"}],"x-example":{"example0":{"summary":"Get Transaction Batch files","value":{"clientReferenceInformation":{"code":"test_void"}}}},"responses":{"200":{"description":"OK","schema":{"title":"ptsV1TransactionBatchesGet200Response","type":"object","properties":{"transactionBatches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier assigned to the batch file.","example":"psy8s1d","pattern":"^[a-zA-Z0-9_+-]*$","minLength":1,"maxLength":8},"uploadDate":{"type":"string","description":"Date when the batch template was update.","example":"2018-01-01"},"completionDate":{"type":"string","description":"The date when the batch template processing completed.","example":"2018-01-01"},"transactionCount":{"type":"integer","description":"Number of transactions in the transaction.","example":7534},"acceptedTransactionCount":{"type":"integer","description":"Number of transactions accepted.","example":50013},"rejectedTransactionCount":{"type":"string","description":"Number of transactions rejected.","example":2508},"status":{"type":"string","description":"The status of you batch template processing.","example":"Completed"}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"/pts/v1/transaction-batches"},"method":{"type":"string","example":"GET"}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"400":{"description":"Bad Request","schema":{"title":"ptsV1TransactionBatchesGet400Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"401":{"description":"Not Authorized","schema":{"title":"ptsV1TransactionBatchesGet401Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"403":{"description":"No Authenticated","schema":{"title":"ptsV1TransactionBatchesGet403Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"404":{"description":"No Reports Found","schema":{"title":"ptsV1TransactionBatchesGet404Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"500":{"description":"Bad Gateway","schema":{"title":"ptsV1TransactionBatchesGet500Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason of status"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above."}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}}}}},"/pts/v1/transaction-batches/{id}":{"get":{"summary":"Get an individual batch file Details processed through the Offline Transaction Submission Services","description":"Provide the search range","tags":["TransactionBatch"],"produces":["application/hal+json"],"parameters":[{"name":"id","in":"path","description":"The batch id assigned for the template.","required":true,"type":"string"}],"x-example":{"example0":{"summary":"Get Transaction Batch file by ID","value":{"clientReferenceInformation":{"code":"test_void"}}}},"responses":{"200":{"description":"OK","schema":{"title":"ptsV1TransactionBatchesIdGet200Response","allOf":[{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier assigned to the batch file.","example":"psy8s1d","pattern":"^[a-zA-Z0-9_+-]*$","minLength":1,"maxLength":8},"uploadDate":{"type":"string","description":"Date when the batch template was update.","example":"2018-01-01"},"completionDate":{"type":"string","description":"The date when the batch template processing completed.","example":"2018-01-01"},"transactionCount":{"type":"integer","description":"Number of transactions in the transaction.","example":7534},"acceptedTransactionCount":{"type":"integer","description":"Number of transactions accepted.","example":50013},"rejectedTransactionCount":{"type":"string","description":"Number of transactions rejected.","example":2508},"status":{"type":"string","description":"The status of you batch template processing.","example":"Completed"}}},{"type":"object","properties":{"_links":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"href":{"type":"string","description":"Self link for this request","example":"v1/payments/5289798134206292501013"},"method":{"type":"string"}}}}}}}}]}},"400":{"description":"Bad Request","schema":{"title":"ptsV1TransactionBatchesIdGet400Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"401":{"description":"Not Authorized","schema":{"title":"ptsV1TransactionBatchesIdGet401Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"403":{"description":"No Authenticated","schema":{"title":"ptsV1TransactionBatchesIdGet403Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"404":{"description":"No Reports Found","schema":{"title":"ptsV1TransactionBatchesIdGet404Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid.\n"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above.\n"}}}}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}},"502":{"description":"Bad Gateway","schema":{"title":"ptsV1TransactionBatchesIdGet502Response","type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason of status"},"message":{"type":"string","description":"The detailed message related to the status and reason listed above."}}},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"}}}}}}},"/pts/v2/payouts/":{"post":{"summary":"Process a Payout","description":"Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using\nan Original Credit Transaction (OCT).\n","operationId":"octCreatePayment","parameters":[{"name":"octCreatePaymentRequest","in":"body","required":true,"schema":{"title":"ptsV2PayoutsPostResponse","type":"object","properties":{"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"surcharge":{"type":"object","properties":{"amount":{"type":"string","maxLength":15,"description":"The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer\nand acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\n- Applicable only for CTV for Payouts.\n- CTV (<= 08)\n\nFor processor-specific information, see the surcharge_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneType":{"type":"string","enum":["day","home","night","work"],"description":"Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n"}}}}},"merchantInformation":{"type":"object","properties":{"categoryCode":{"type":"integer","maximum":9999,"description":"Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"submitLocalDateTime":{"type":"string","maxLength":6,"description":"Time that the transaction was submitted in local time. The time is in hhmmss format.\n"},"vatRegistrationNumber":{"type":"string","maxLength":21,"description":"Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":3,"description":"Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"contact":{"type":"string","maxLength":14,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n"}}}}},"recipientInformation":{"type":"object","properties":{"firstName":{"type":"string","maxLength":35,"description":"First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"},"middleInitial":{"type":"string","maxLength":1,"description":"Middle Initial of recipient. Required only for FDCCompass.\n"},"lastName":{"type":"string","maxLength":35,"description":"Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n"},"address1":{"type":"string","maxLength":50,"description":"Recipient address information. Required only for FDCCompass."},"locality":{"type":"string","maxLength":25,"description":"Recipient city. Required only for FDCCompass."},"administrativeArea":{"type":"string","maxLength":3,"description":"Recipient State. Required only for FDCCompass."},"country":{"type":"string","maxLength":2,"description":"Recipient country code. Required only for FDCCompass."},"postalCode":{"type":"string","maxLength":10,"description":"Recipient postal code. Required only for FDCCompass."},"phoneNumber":{"type":"string","maxLength":20,"description":"Recipient phone number. Required only for FDCCompass."},"dateOfBirth":{"type":"string","minLength":8,"maxLength":8,"description":"Recipient date of birth in YYYYMMDD format. Required only for FDCCompass."}}},"senderInformation":{"type":"object","properties":{"referenceNumber":{"type":"string","maxLength":19,"description":"Reference number generated by you that uniquely identifies the sender."},"account":{"type":"object","properties":{"fundsSource":{"type":"string","minLength":2,"maxLength":2,"description":"Source of funds. Possible values:\n\n Paymentech, CTV, FDC Compass:\n - 01: Credit card\n - 02: Debit card\n - 03: Prepaid card\n\n Paymentech, CTV -\n - 04: Cash\n - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings\n accounts, and proprietary debit or ATM cards.\n - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines\n of credit.\n\n FDCCompass -\n - 04: Deposit Account\n\n**Funds Disbursement**\n\nThis value is most likely 05 to identify that the originator used a deposit account to fund the\ndisbursement.\n\n**Credit Card Bill Payment**\n\nThis value must be 02, 03, 04, or 05.\n"},"number":{"type":"string","maxLength":34,"description":"The account number of the entity funding the transaction. It is the sender\u2019s account number. It can\nbe a debit/credit card account number or bank account number.\n\n**Funds disbursements**\n\nThis field is optional.\n\n**All other transactions**\n\nThis field is required when the sender funds the transaction with a financial instrument, for example\ndebit card.\nLength:\n* FDCCompass (<= 19)\n* Paymentech (<= 16)\n"}}},"firstName":{"type":"string","maxLength":35,"description":"First name of sender (Optional).\n* CTV (14)\n* Paymentech (30)\n"},"middleInitial":{"type":"string","maxLength":1,"description":"Recipient middle initial (Optional).\n"},"lastName":{"type":"string","maxLength":35,"description":"Recipient last name (Optional).\n* CTV (14)\n* Paymentech (30)\n"},"name":{"type":"string","maxLength":24,"description":"Name of sender.\n\n**Funds Disbursement**\n\nThis value is the name of the originator sending the funds disbursement.\n* CTV, Paymentech (30)\n"},"address1":{"type":"string","maxLength":50,"description":"Street address of sender.\n\n**Funds Disbursement**\n\nThis value is the address of the originator sending the funds disbursement.\n"},"locality":{"type":"string","maxLength":25,"description":"City of sender.\n\n**Funds Disbursement**\n\nThis value is the city of the originator sending the funds disbursement.\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n"},"countryCode":{"type":"string","maxLength":2,"description":"Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Sender\u2019s postal code. Required only for FDCCompass."},"phoneNumber":{"type":"string","maxLength":20,"description":"Sender\u2019s phone number. Required only for FDCCompass."},"dateOfBirth":{"type":"string","minLength":8,"maxLength":8,"description":"Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass."},"vatRegistrationNumber":{"type":"string","maxLength":13,"description":"Customer's government-assigned tax identification number.\n"}}},"processingInformation":{"type":"object","properties":{"businessApplicationId":{"type":"string","maxLength":2,"description":"Payouts transaction type.\n\nApplicable Processors: FDC Compass, Paymentech, CtV\n\nPossible values:\n\n**Credit Card Bill Payment**\n\n - **CP**: credit card bill payment\n\n**Funds Disbursement**\n\n - **FD**: funds disbursement\n - **GD**: government disbursement\n - **MD**: merchant disbursement\n\n**Money Transfer**\n\n - **AA**: account to account. Sender and receiver are same person.\n - **PP**: person to person. Sender and receiver are different.\n\n**Prepaid Load**\n\n - **TU**: top up\n"},"networkRoutingOrder":{"type":"string","maxLength":30,"description":"This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer\u2019s routing priorities. \n\nSee https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values\n"},"commerceIndicator":{"type":"string","maxLength":13,"description":"Type of transaction. Possible value for Fast Payments transactions:\n\n - internet\n"},"reconciliationId":{"type":"string","maxLength":60,"description":"Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n"},"payoutsOptions":{"type":"object","properties":{"acquirerMerchantId":{"type":"string","maxLength":15,"description":"This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. \nDepending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal.\nAcquiring Institution Identification Code uniquely identifies the merchant.\nThe value from the original is required in any subsequent messages, including reversals, chargebacks, and representments.\n* Applicable only for CTV for Payouts.\n"},"acquirerBin":{"type":"string","maxLength":11,"description":"This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. \nThis number is usually Visa-assigned.\n* Applicable only for CTV for Payouts.\n"},"retrievalReferenceNumber":{"type":"string","maxLength":12,"description":"This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n* Applicable only for CTV for Payouts.\n"},"accountFundingReferenceId":{"type":"string","maxLength":15,"description":"Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n* Applicable only for CTV for Payouts.\n"}}}}},"paymentInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"number":{"type":"string","maxLength":20,"description":"Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"sourceAccountType":{"type":"string","maxLength":2,"description":"Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process. This field is required in the following cases.\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for CTV.\n \n**Note**\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - CHECKING: Checking account\n - CREDIT: Credit card account\n - SAVING: Saving account\n - LINE_OF_CREDIT: Line of credit\n - PREPAID: Prepaid card account\n - UNIVERSAL: Universal account\n"}}}}}},"example":{"clientReferenceInformation":{"code":"33557799"},"senderInformation":{"referenceNumber":"1234567890","address1":"900 Metro Center Blvd.900","countryCode":"US","locality":"Foster City","name":"Thomas Jefferson","administrativeArea":"CA","account":{"number":"1234567890123456789012345678901234","fundsSource":"01"}},"processingInformation":{"commerceIndicator":"internet","businessApplicationId":"FD","networkRoutingOrder":"ECG"},"payoutsOptions":{"retrievalReferenceNumber":"123456789012","acquirerBin":"567890124"},"reconciliationId":"1087488702VIAQNSPQ","orderInformation":{"amountDetails":{"totalAmount":"100.00","currency":"USD"}},"merchantInformation":{"merchantCategoryCode":"123","merchantDescriptor":{"country":"US","postalCode":"94440","locality":"FC","name":"Thomas","administrativeArea":"CA"}},"paymentInformation":{"card":{"expirationYear":"2025","number":"4111111111111111","expirationMonth":"12","type":"001","sourceAccountType":"CH"}},"recipientInformation":{"firstName":"John","lastName":"Doe","address1":"Paseo Padre Boulevard","locality":"Foster City","administrativeArea":"CA","postalCode":"94400","phoneNumber":"6504320556","dateOfBirth":"19801009","country":"US"}}}}],"tags":["Process a Payout"],"x-example":{"example0":{"summary":"Process a Payout","value":{"clientReferenceInformation":{"code":"33557799"},"senderInformation":{"referenceNumber":"1234567890","address1":"900 Metro Center Blvd.900","countryCode":"US","locality":"Foster City","name":"Company Name","administrativeArea":"CA","account":{"fundsSource":"05"}},"processingInformation":{"commerceIndicator":"internet","businessApplicationId":"FD"},"orderInformation":{"amountDetails":{"totalAmount":"100.00","currency":"USD"}},"merchantInformation":{"merchantDescriptor":{"country":"US","postalCode":"94440","locality":"FC","name":"Sending Company Name","administrativeArea":"CA"}},"paymentInformation":{"card":{"expirationYear":"2025","number":"4111111111111111","expirationMonth":"12","type":"001"}},"recipientInformation":{"firstName":"John","lastName":"Doe","address1":"Paseo Padre Boulevard","locality":"Foster City","administrativeArea":"CA","postalCode":"94400","phoneNumber":"6504320556","country":"US"}}}},"responses":{"201":{"description":"Successful response.","schema":{"title":"ptsV2PayoutsPost201Response","allOf":[{"type":"object","properties":{"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}},"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["ACCEPTED","DECLINED"]},"reconciliationId":{"type":"string","maxLength":25,"description":"Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is\nThis value is used for reconciliation purposes.\n"},"statusInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason of the status.\n","enum":["SUCCESS","CONTACT_PROCESSOR"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above. Possible value is:\n\n - Transaction was successful.\n - You must call the issuing bank to proceed with the transaction.\n"}}}}},{"type":"object","properties":{"errorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason of the status.\n","enum":["EXPIRED_CARD","PROCESSOR_DECLINED","STOLEN_LOST_CARD","UNAUTHORIZED_CARD","CVN_NOT_MATCH","INVALID_CVN","BLACKLISTED_CUSTOMER","INVALID_ACCOUNT","GENERAL_DECLINE","RISK_CONTROL_DECLINE","PROCESSOR_RISK_CONTROL_DECLINE"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"},"locality":{"type":"string","maxLength":13,"description":"Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}}}},"orderInformation":{"type":"object","properties":{"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"settlementAmount":{"type":"string","maxLength":12,"description":"This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n"},"settlementCurrency":{"type":"string","maxLength":3,"description":"This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n"}}}}},"processorInformation":{"type":"object","properties":{"approvalCode":{"type":"string","maxLength":6,"description":"Issuer-generated approval code for the transaction."},"responseCode":{"type":"string","maxLength":10,"description":"Transaction status from the processor."},"transactionId":{"type":"string","maxLength":15,"description":"Network transaction identifier (TID). This value can be used to identify a specific transaction when\nyou are discussing the transaction with your processor.\n"},"systemTraceAuditNumber":{"type":"string","maxLength":6,"description":"This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n"},"responseCodeSource":{"type":"string","maxLength":1,"description":"Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n"}}},"recipientInformation":{"type":"object","properties":{"card":{"type":"object","properties":{"balance":{"type":"string","maxLength":12,"description":"This field shows the available balance in the prepaid account. \nAcquirers always receive the available balance in the transaction currency.\n"},"currency":{"type":"string","maxLength":3,"description":"This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer.\n"}}}}}}}],"example":{"_links":{"self":{"href":"/pts/v2/payouts/5287556536256000401540","method":"GET"}},"clientReferenceInformation":{"code":"1528755653559"},"id":"5287556536256000401540","orderInformation":{"amountDetails":{"totalAmount":"100.00","currency":"USD"}},"processorInformation":{"systemTraceAuditNumber":"897596","approvalCode":"831000","transactionId":"016153570198200","responseCode":"00","responseCodeSource":"5"},"reconciliationId":"1087488702VIAQNSPQ","status":"ACCEPTED","submitTimeUtc":"2018-06-11T222054Z"}}},"400":{"description":"Invalid request.","schema":{"title":"ptsV2PayoutsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction."},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_MERCHANT_CONFIGURATION","INVALID_AMOUNT","DEBIT_CARD_USEAGE_EXCEEDD_LIMIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above. Possible value is:\n\n - Your aggregator or acquirer is not accepting transactions from you at this time.\n - Your aggregator or acquirer is not accepting this transaction.\n - CyberSource declined the request because the credit card has expired. You might also receive this value if\n the expiration date you provided does not match the date the issuing bank has on file.\n - The bank declined the transaction.\n - The merchant reference number for this authorization request matches the merchant reference number of\n another authorization request that you sent within the past 15 minutes. Resend the request with a unique\n merchant reference number.\n - The credit card number did not pass CyberSource basic checks.\n - Data provided is not consistent with the request. For example, you requested a product with negative cost.\n - The request is missing a required field.\n"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"ptsV2PayoutsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}}}},"/reporting/v3/notification-of-changes":{"get":{"tags":["NotificationOfChanges"],"summary":"Get Notification Of Changes","description":"Notification of Change Report","operationId":"getNotificationOfChangeReport","produces":["application/hal+json"],"parameters":[{"name":"startTime","in":"query","description":"Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"}],"x-example":{"example0":{"summary":"Get Notification Of Changes","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3NotificationofChangesGet200Response","type":"object","properties":{"notificationOfChanges":{"type":"array","description":"List of Notification Of Change Info values","items":{"type":"object","properties":{"merchantReferenceNumber":{"type":"string","example":"TC30877-10","description":"Merchant Reference Number"},"transactionReferenceNumber":{"type":"string","example":"55563","description":"Transaction Reference Number"},"time":{"type":"string","example":"2017-10-01T10:10:10+05:00","format":"date-time","description":"Notification Of Change Date(ISO 8601 Extended)"},"code":{"type":"string","example":"TC30877-10","description":"Merchant Reference Number"},"accountType":{"type":"string","example":"Checking Account","description":"Account Type"},"routingNumber":{"type":"string","example":"123456789","description":"Routing Number"},"accountNumber":{"type":"string","example":"############1234","description":"Account Number"},"consumerName":{"type":"string","example":"Consumer Name","description":"Consumer Name"}},"description":"Notification Of Change"}}}}},"400":{"description":"Invalid request","schema":{"title":"reportingV3NotificationofChangesGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"VALIDATION_ERROR","correlationId":null,"detail":null,"fields":[{"path":"startDate","message":"Start date should not precede 18 months from current time in GMT","localizationKey":null}],"localizationKey":"cybsapi.validation.errors","message":"Field validation errors"}}},"401":{"description":"Unauthorized. Token provided is no more valid."},"404":{"description":"Report not found","schema":{"title":"reportingV3NotificationofChangesGet404Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"RESOURCE_NOTFOUND","correlationId":null,"detail":"The requested resource is not found. Please try again later.","localizationKey":"cybsapi.resource.notfound","message":"No results found for the given dates"}}},"500":{"description":"Internal Server Error","schema":{"title":"reportingV3NotificationofChangesGet500Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"SERVER_ERROR","correlationId":null,"detail":"Internal Server Error. Please contact the customer support.","localizationKey":"cybsapi.server.error","message":"Error encountered while processing request"}}}}}},"/reporting/v3/purchase-refund-details":{"get":{"tags":["PurchaseAndRefundDetails"],"summary":"Get Purchase and Refund details","description":"Purchase And Refund Details Description","operationId":"getPurchaseAndRefundDetails","produces":["application/hal+json"],"parameters":[{"name":"startTime","in":"query","description":"Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"},{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32},{"name":"paymentSubtype","in":"query","description":"Payment Subtypes.\n - **ALL**: All Payment Subtypes\n - **VI** : Visa\n - **MC** : Master Card\n - **AX** : American Express\n - **DI** : Discover\n - **DP** : Pinless Debit\n","required":false,"type":"string","default":"ALL","enum":["ALL","VI","MC","AX","DI","DP"]},{"name":"viewBy","in":"query","description":"View results by Request Date or Submission Date.\n - **requestDate** : Request Date\n - **submissionDate**: Submission Date\n","required":false,"type":"string","default":"requestDate","enum":["requestDate","submissionDate"]},{"name":"groupName","in":"query","description":"Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds","required":false,"type":"string"},{"name":"offset","in":"query","description":"Offset of the Purchase and Refund Results.","required":false,"type":"integer","format":"int32"},{"name":"limit","in":"query","description":"Results count per page. Range(1-2000)","required":false,"type":"integer","minimum":1,"maximum":2000,"default":2000,"format":"int32"}],"x-example":{"example0":{"summary":"Get Purchase and Refund details","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3PurchaseRefundDetailsGet200Response","allOf":[{"type":"object","properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"pageResults":{"type":"integer"}}},{"type":"object","description":"PurchaseAndRefundDetails","properties":{"requestDetails":{"type":"array","description":"List of Request Info values","items":{"type":"object","properties":{"requestId":{"type":"string","example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"cybersourceMerchantId":{"type":"string","example":"Cybersource Merchant Id","description":"Cybersource Merchant Id"},"processorMerchantId":{"type":"string","example":"Processor Merchant Id","description":"Cybersource Processor Merchant Id"},"groupName":{"type":"string","example":"996411990498708810001","description":"Group Name"},"transactionReferenceNumber":{"type":"string","example":"RZ3J9WCS9J33","description":"Transaction Reference Number"},"merchantReferenceNumber":{"type":"string","example":"47882339","description":"Merchant Reference Number"}},"description":"Request Info Section"}},"settlements":{"type":"array","description":"List of Settlement Info values","items":{"type":"object","properties":{"requestId":{"type":"string","example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"transactionType":{"type":"string","example":"Purchases","description":"Transaction Type"},"submissionTime":{"type":"string","example":"2017-10-01T10:10:10+05:00","description":"Submission Date","format":"date-time"},"amount":{"type":"string","example":"23.00","description":"Amount"},"currencyCode":{"type":"string","example":"USD","description":"Valid ISO 4217 ALPHA-3 currency code"},"paymentMethod":{"type":"string","example":"VISA","description":"payment method"},"walletType":{"type":"string","example":"V.me","description":"Solution Type (Wallet)"},"paymentType":{"type":"string","example":"credit card","description":"Payment Type"},"accountSuffix":{"type":"string","example":"0004","description":"Account Suffix"},"cybersourceBatchTime":{"type":"string","example":"2017-10-01T10:10:10+05:00","description":"Cybersource Batch Time","format":"date-time"},"cybersourceBatchId":{"type":"string","example":"123123123123123","description":"Cybersource Batch Id"},"cardType":{"type":"string","example":"null","description":"Card Type"},"debitNetwork":{"type":"string","example":"","description":"Debit Network"}}}},"authorizations":{"type":"array","description":"List of Authorization Info values","items":{"type":"object","properties":{"requestId":{"type":"string","example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"transactionReferenceNumber":{"type":"string","example":"RZ3J9WCS9J27","description":"Authorization Transaction Reference Number"},"time":{"type":"string","example":"2017-10-01T10:10:10+05:00","description":"Authorization Date","format":"date-time"},"authorizationRequestId":{"type":"string","example":"12345678901234567890123459","description":"Authorization Request Id"},"amount":{"type":"string","example":"2.50","description":"Authorization Amount"},"currencyCode":{"type":"string","example":"USD","description":"Valid ISO 4217 ALPHA-3 currency code"},"code":{"type":"string","example":"160780","description":"Authorization Code"},"rcode":{"type":"string","example":"1","description":"Authorization RCode"}},"description":"Authorization Info Values"}},"feeAndFundingDetails":{"type":"array","description":"List of Fee Funding Info values","items":{"type":"object","properties":{"requestId":{"type":"string","maxLength":26,"example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"interchangePerItemFee":{"type":"string","example":"2.7","description":"interchange Per Item Fee"},"discountPercentage":{"type":"string","example":"2.39","description":"Discount Percentage"},"discountAmount":{"type":"string","example":"0.429","description":"Discount Amount"},"discountPerItemFee":{"type":"string","example":"0.002","description":"Discount Per Item Fee"},"totalFee":{"type":"string","example":"0.429","description":"Total Fee"},"feeCurrency":{"type":"string","example":"1","description":"Fee Currency"},"duesAssessments":{"type":"string","example":"0","description":"Dues Assessments"},"fundingAmount":{"type":"string","example":"2.50","description":"Funding Amount"},"fundingCurrency":{"type":"string","example":"USD","description":"Funding Currency (ISO 4217)"}},"description":"Fee Funding Section"}},"others":{"type":"array","description":"List of Other Info values","items":{"type":"object","properties":{"requestId":{"type":"string","maxLength":26,"example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"merchantData1":{"type":"string","example":"Merchant Defined Data","description":"Merchant Defined Data"},"merchantData2":{"type":"string","example":"Merchant Defined Data","description":"Merchant Defined Data"},"merchantData3":{"type":"string","example":"Merchant Defined Data","description":"Merchant Defined Data"},"merchantData4":{"type":"string","example":"Merchant Defined Data","description":"Merchant Defined Data"},"firstName":{"type":"string","example":"First Name","description":"First Name"},"lastName":{"type":"string","example":"Last Name","description":"Last Name"}},"description":"Other Merchant Details Values."}},"settlementStatuses":{"type":"array","description":"List of Settlement Status Info values","items":{"type":"object","properties":{"requestId":{"type":"string","maxLength":26,"example":"12345678901234567890123456","description":"An unique identification number assigned by CyberSource to identify the submitted request."},"status":{"type":"string","example":"Settlement Status","description":"Settlement Status"},"settlementTime":{"type":"string","example":"2017-10-01T10:10:10+05:00","format":"date-time","description":"Settlement Date"},"reasonCode":{"example":"reasonCode","type":"string","description":"ReasonCode"},"errorText":{"example":"errorText","type":"string","description":"errorText"}},"description":"Settlement Status Section Values."}}}}]}},"400":{"description":"Invalid request","schema":{"title":"reportingV3PurchaseRefundDetailsGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"VALIDATION_ERROR","correlationId":null,"detail":null,"fields":[{"path":"startDate","message":"Start date should not precede 18 months from current time in GMT","localizationKey":null}],"localizationKey":"cybsapi.validation.errors","message":"Field validation errors"}}},"401":{"description":"Ok","schema":{"title":"reportingV3PurchaseRefundDetailsGet401Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"VALIDATION_ERROR","correlationId":null,"detail":null,"fields":[{"path":"organizationId","message":"Organization doesn't has access to Purchase & Refund Details Search","localizationKey":null}],"localizationKey":"cybsapi.validation.errors","message":"Field validation errors"}}},"404":{"description":"Report not found","schema":{"title":"reportingV3PurchaseRefundDetailsGet404Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"RESOURCE_NOTFOUND","correlationId":null,"detail":"The requested resource is not found. Please try again later.","localizationKey":"cybsapi.resource.notfound","message":"Purchase and Refund Details not found for requested input values"}}},"500":{"description":"Internal Server Error","schema":{"title":"reportingV3PurchaseRefundDetailsGet500Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"SERVER_ERROR","correlationId":null,"detail":"Internal Server Error. Please contact the customer support.","localizationKey":"cybsapi.server.error","message":"Error encountered while processing request"}}}}}},"/reporting/v3/report-definitions":{"get":{"tags":["ReportDefinitions"],"summary":"Get reporting resource information","description":"","operationId":"getResourceV2Info","produces":["application/hal+json"],"parameters":[{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32}],"x-example":{"example0":{"summary":"Get reporting resource information","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3ReportDefinitionsGet200Response","type":"object","properties":{"reportDefinitions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"reportDefinitionId":{"type":"integer","format":"int32"},"reportDefintionName":{"type":"string"},"supportedFormats":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["application/xml","text/csv"]}},"description":{"type":"string"}}}}}}},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportDefinitionsGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"Report not found"}}}},"/reporting/v3/report-definitions/{reportDefinitionName}":{"get":{"tags":["ReportDefinitions"],"summary":"Get a single report definition information","description":"The report definition name must be used as path parameter exclusive of each other","operationId":"getResourceInfoByReportDefinition","produces":["application/hal+json"],"parameters":[{"name":"reportDefinitionName","in":"path","description":"Name of the Report definition to retrieve","required":true,"type":"string"},{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32}],"x-example":{"example0":{"summary":"Get a single report definition information","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3ReportDefinitionsNameGet200Response","type":"object","properties":{"type":{"type":"string"},"reportDefinitionId":{"type":"integer","format":"int32"},"reportDefintionName":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"filterType":{"type":"string"},"default":{"type":"boolean"},"required":{"type":"boolean"},"supportedType":{"type":"string"}}}},"supportedFormats":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["application/xml","text/csv"]}},"description":{"type":"string"}}}},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportDefinitionsNameGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"Report not found"}}}},"/reporting/v3/report-subscriptions":{"get":{"tags":["ReportSubscriptions"],"summary":"Retrieve all subscriptions by organization","description":"","operationId":"getAllSubscriptions","produces":["application/hal+json"],"x-example":{"example0":{"summary":"Retrieve all subscriptions by organization","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3ReportSubscriptionsGet200Response","type":"object","properties":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string","description":"Organization Id"},"reportDefinitionId":{"type":"string","description":"Report Definition Id"},"reportDefinitionName":{"type":"string","description":"Report Definition"},"reportMimeType":{"type":"string","example":"application/xml","description":"Report Format","enum":["application/xml","text/csv"]},"reportFrequency":{"type":"string","example":"DAILY","description":"Report Frequency","enum":["DAILY","WEEKLY","MONTHLY"]},"reportName":{"type":"string","description":"Report Name","example":"My Transaction Request Detail Report"},"timezone":{"type":"string","description":"Time Zone","example":"America/Chicago"},"startTime":{"type":"string","description":"Start Time","format":"date-time","example":"2017-10-01T10:10:10+05:00"},"startDay":{"type":"integer","format":"int32","description":"Start Day","example":1},"reportFields":{"type":"array","example":["Request.RequestID","Request.TransactionDate","Request.MerchantID"],"description":"List of all fields String values","items":{"type":"string"}},"reportFilters":{"type":"array","items":{"type":"string"},"example":["ics_auth","ics_bill"],"description":"List of filters to apply","additionalProperties":{"type":"array","items":{"type":"string"}}},"reportPreferences":{"type":"object","properties":{"signedAmounts":{"type":"boolean","description":"Indicator to determine whether negative sign infron of amount for all refunded transaction"},"fieldNameConvention":{"type":"string","description":"Specify the field naming convention to be followed in reports (applicable to only csv report formats","enum":["SOAPI","SCMP"]}},"description":"Report Preferences"},"selectedMerchantGroupName":{"type":"string","example":"testGroup","description":"Selected name of the group."}},"description":"Subscription Details"}}}}},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportSubscriptionsGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"Subscriptions not found"}}}},"/reporting/v3/report-subscriptions/{reportName}":{"get":{"tags":["ReportSubscriptions"],"summary":"Retrieve subscription for a report name by organization","description":"","operationId":"getSubscription","produces":["application/hal+json"],"parameters":[{"name":"reportName","in":"path","description":"Name of the Report to Retrieve","required":true,"type":"string","maxLength":80,"minLength":1,"pattern":"[a-zA-Z0-9-_+]+"}],"x-example":{"example0":{"summary":"Retrieve subscription for a report name by organization","value":[]}},"responses":{"200":{"description":"Ok","schema":{"title":"reportingV3ReportsSbscriptionsNameGet200Response","type":"object","properties":{"organizationId":{"type":"string","description":"Organization Id"},"reportDefinitionId":{"type":"string","description":"Report Definition Id"},"reportDefinitionName":{"type":"string","description":"Report Definition"},"reportMimeType":{"type":"string","example":"application/xml","description":"Report Format","enum":["application/xml","text/csv"]},"reportFrequency":{"type":"string","example":"DAILY","description":"Report Frequency","enum":["DAILY","WEEKLY","MONTHLY"]},"reportName":{"type":"string","description":"Report Name","example":"My Transaction Request Detail Report"},"timezone":{"type":"string","description":"Time Zone","example":"America/Chicago"},"startTime":{"type":"string","description":"Start Time","format":"date-time","example":"2017-10-01T10:10:10+05:00"},"startDay":{"type":"integer","format":"int32","description":"Start Day","example":1},"reportFields":{"type":"array","example":["Request.RequestID","Request.TransactionDate","Request.MerchantID"],"description":"List of all fields String values","items":{"type":"string"}},"reportFilters":{"type":"array","items":{"type":"string"},"example":["ics_auth","ics_bill"],"description":"List of filters to apply","additionalProperties":{"type":"array","items":{"type":"string"}}},"reportPreferences":{"type":"object","properties":{"signedAmounts":{"type":"boolean","description":"Indicator to determine whether negative sign infron of amount for all refunded transaction"},"fieldNameConvention":{"type":"string","description":"Specify the field naming convention to be followed in reports (applicable to only csv report formats","enum":["SOAPI","SCMP"]}},"description":"Report Preferences"},"selectedMerchantGroupName":{"type":"string","example":"testGroup","description":"Selected name of the group."}},"description":"Subscription Details"}},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportSubscriptionsNameGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"Subscription not found"}}},"put":{"tags":["ReportSubscriptions"],"summary":"Create Report Subscription for a report name by organization","description":"","operationId":"createSubscription","consumes":["application/json"],"produces":["application/hal+json"],"parameters":[{"name":"reportName","in":"path","description":"Name of the Report to Create","required":true,"type":"string"},{"in":"body","name":"requestBody","description":"Report subscription request payload","required":true,"schema":{"type":"object","required":["reportDefinitionName","reportFields","reportName"],"properties":{"organizationId":{"type":"string","pattern":"[a-zA-Z0-9-_]+"},"reportDefinitionName":{"type":"string","minLength":1,"maxLength":80,"pattern":"[a-zA-Z0-9-]+"},"reportFields":{"type":"array","items":{"type":"string"}},"reportMimeType":{"type":"string","example":"application/xml","enum":["application/xml","text/csv"]},"reportFrequency":{"type":"string"},"reportName":{"type":"string","minLength":1,"maxLength":128,"pattern":"[a-zA-Z0-9-_ ]+"},"timezone":{"type":"string","example":"America/Chicago"},"startTime":{"type":"string","format":"date-time","example":"2017-10-01T10:10:10+05:00"},"startDay":{"type":"integer","minimum":1,"maximum":7},"reportFilters":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"reportPreferences":{"type":"object","properties":{"signedAmounts":{"type":"boolean","description":"Indicator to determine whether negative sign infron of amount for all refunded transaction"},"fieldNameConvention":{"type":"string","description":"Specify the field naming convention to be followed in reports (applicable to only csv report formats","enum":["SOAPI","SCMP"]}},"description":"Report Preferences"},"selectedMerchantGroupName":{"type":"string","pattern":"[0-9]*"}}}}],"x-example":{"example0":{"summary":"","value":{"reportDefinitionName":"TransactionRequestClass","reportFields":["Request.RequestID","Request.TransactionDate","Request.MerchantID"],"reportMimeType":"application/xml","reportFrequency":"DAILY","timezone":"America/Chicago","startTime":"0900","startDay":1,"reportFilters":[],"reportPreferences":{"signedAmounts":false,"supportEmailAddresses":null,"additionalEmailAddresses":null},"selectedMerchantGroupName":null,"selectedOrganizationId":null,"organizationId":"uday_wf"}}},"responses":{"200":{"description":"Ok"},"304":{"description":"NOT MODIFIED"},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportSubscriptionsNamePut400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}}}},"delete":{"tags":["ReportSubscriptions"],"summary":"Delete subscription of a report name by organization","description":"","operationId":"deleteSubscription","produces":["application/hal+json"],"parameters":[{"name":"reportName","in":"path","description":"Name of the Report to Delete","required":true,"type":"string","maxLength":80,"minLength":1,"pattern":"[a-zA-Z0-9-_+]+"}],"x-example":{"example0":{"summary":"Delete subscription of a report name by organization","value":[]}},"responses":{"200":{"description":"Ok"},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportSubscriptionsNameDelete400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"Subscription not found","schema":{"title":"reportingV3ReportSubscriptionsnameDelete404Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}}}}},"/reporting/v3/reports":{"get":{"tags":["Reports"],"summary":"Retrieve available reports","description":"Retrieve list of available reports","operationId":"searchReports","produces":["application/hal+json"],"parameters":[{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32},{"name":"startTime","in":"query","description":"Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n","required":true,"type":"string","format":"date-time"},{"name":"timeQueryType","in":"query","description":"Specify time you woud like to search","required":true,"type":"string","enum":["reportTimeFrame","executedTime"]},{"name":"reportMimeType","in":"query","description":"Valid Report Format","required":false,"type":"string","enum":["application/xml","text/csv"]},{"name":"reportFrequency","in":"query","description":"Valid Report Frequency","required":false,"type":"string","enum":["DAILY","WEEKLY","MONTHLY","ADHOC"]},{"name":"reportName","in":"query","description":"Valid Report Name","required":false,"type":"string"},{"name":"reportDefinitionId","in":"query","description":"Valid Report Definition Id","required":false,"type":"integer","format":"int32"},{"name":"reportStatus","in":"query","description":"Valid Report Status","required":false,"type":"string","enum":["COMPLETED","PENDING","QUEUED","RUNNING","ERROR","NO_DATA"]}],"x-example":{"example0":{"summary":"Retrieve available reports","value":[]}},"responses":{"200":{"description":"OK","schema":{"title":"reportingV3ReportsGet200Response","type":"object","properties":{"reports":{"type":"array","items":{"type":"object","properties":{"reportDefinitionId":{"type":"string","description":"Unique Report Identifier of each report type","example":"210"},"reportName":{"type":"string","description":"Name of the report specified by merchant while creating the report","example":"My Transaction Request Detail Report"},"reportMimeType":{"type":"string","example":"application/xml","description":"Format of the report to get generated","enum":["application/xml","text/csv"]},"reportFrequency":{"type":"string","example":"DAILY","description":"Frequency of the report to get generated","enum":["DAILY","WEEKLY","MONTHLY","ADHOC"]},"status":{"type":"string","description":"Status of the report","enum":["COMPLETED","PENDING","QUEUED","RUNNING","ERROR","NO_DATA"]},"reportStartTime":{"type":"string","format":"date-time","example":"2017-10-01T10:10:10+05:00","description":"Specifies the report start time in ISO 8601 format"},"reportEndTime":{"type":"string","format":"date-time","example":"2017-10-02T10:10:10+05:00","description":"Specifies the report end time in ISO 8601 format"},"timezone":{"type":"string","example":"America/Chicago","description":"Time Zone"},"reportId":{"type":"string","example":"6d9cb5b6-0e97-2d03-e053-7cb8d30af52e","description":"Unique identifier generated for every reports"},"organizationId":{"type":"string","example":"Test_MerchantId","description":"CyberSource Merchant Id"},"queuedTime":{"type":"string","format":"date-time","example":"2017-10-03T10:10:10+05:00","description":"Specifies the time of the report in queued in ISO 8601 format"},"reportGeneratingTime":{"type":"string","format":"date-time","example":"2017-10-03T10:10:10+05:00","description":"Specifies the time of the report started to generate in ISO 8601 format"},"reportCompletedTime":{"type":"string","format":"date-time","example":"2017-10-03T10:10:10+05:00","description":"Specifies the time of the report completed the generation in ISO 8601 format"},"selectedMerchantGroupName":{"type":"string","example":"myGroup","description":"Selected name of the group"}},"description":"Report Search Result Bean"}}}}},"400":{"description":"Invalid Request","schema":{"title":"reportingV3ReportsGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"No Reports Found"}}},"post":{"tags":["Reports"],"summary":"Create Adhoc Report","description":"Create one time report","operationId":"createReport","consumes":["application/json"],"produces":["application/hal+json"],"parameters":[{"in":"body","name":"requestBody","description":"Report subscription request payload","required":true,"schema":{"type":"object","properties":{"organizationId":{"type":"string","description":"Valid CyberSource Organization Id","pattern":"[a-zA-Z0-9-_]+","example":"Test_Merchatnt_id"},"reportDefinitionName":{"type":"string","minLength":1,"maxLength":80,"pattern":"[a-zA-Z0-9-]+","example":"TransactionRequestClass"},"reportFields":{"type":"array","items":{"type":"string"},"description":"List of fields which needs to get included in a report","example":["Request.RequestID","Request.TransactionDate","Request.MerchantID"]},"reportMimeType":{"type":"string","description":" Format of the report","example":"application/xml","enum":["application/xml","text/csv"]},"reportName":{"type":"string","minLength":1,"maxLength":128,"pattern":"[a-zA-Z0-9-_ ]+","description":"Name of the report","example":"My Transaction Request report"},"timezone":{"type":"string","description":"Timezone of the report","example":"America/Chicago"},"reportStartTime":{"type":"string","format":"date-time","description":"Start time of the report","example":"2017-10-01T10:10:10+05:00"},"reportEndTime":{"type":"string","format":"date-time","description":"End time of the report","example":"2017-10-02T10:10:10+05:00"},"reportFilters":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"reportPreferences":{"type":"object","properties":{"signedAmounts":{"type":"boolean","description":"Indicator to determine whether negative sign infron of amount for all refunded transaction"},"fieldNameConvention":{"type":"string","description":"Specify the field naming convention to be followed in reports (applicable to only csv report formats","enum":["SOAPI","SCMP"]}},"description":"Report Preferences"},"selectedMerchantGroupName":{"type":"string","pattern":"[0-9]*","description":"Specifies the group name","example":"myGroup"}}}}],"x-example":{"example0":{"summary":"Create Adhoc Report","value":{"reportDefinitionName":"ChargebackAndRetrievalDetailClass","timezone":"GMT","reportMimeType":"text/csv","reportName":"TRR_133","reportStartTime":"2017-11-22T12:00:00+05:00","reportEndTime":"2017-11-23T12:00:00+05:00","reportFilters":{"Application.Name":[]},"reportPreferences":{"signedAmounts":"true","fieldNameConvention":"SOAPI"},"reportFields":["PaymentData.AuthorizationType","PaymentData.AuthorizationCode","PaymentData.AVSResult","PaymentData.CurrencyCode","PaymentData.AVSResultMapped","PaymentData.CVResult","PaymentData.ProcessorResponseCode","PaymentData.NumberOfInstallments","PaymentData.ACHVerificationResult","PaymentData.ACHVerificationResultMapped","PaymentData.BalanceAmount","PaymentData.BalanceCurrencyCode","PaymentData.RequestedAmount","PaymentData.RequestedAmountCurrencyCode","PaymentData.EVEmail","PaymentData.EVEmailRaw","PaymentData.EVName","PaymentData.EVNameRaw","PaymentData.EVPhoneNumber","PaymentData.EVPhoneNumberRaw","PaymentData.EVStreet","PaymentData.EVStreetRaw","PaymentData.EVPostalCode","PaymentData.EVPostalCodeRaw","PaymentData.BinNumber","LineItems.FulfillmentType","LineItems.Quantity","LineItems.UnitPrice","LineItems.TaxAmount","LineItems.MerchantProductSku","LineItems.ProductName","LineItems.ProductCode","LineItems.InvoiceNumber","BillTo.NameSuffix","BillTo.FirstName","BillTo.LastName","BillTo.MiddleName","BillTo.Address1","BillTo.Address2","BillTo.City","BillTo.State","BillTo.Zip","BillTo.Country","BillTo.CompanyName","BillTo.Email","BillTo.Title","BillTo.Phone","PaymentMethod.CardType","PaymentMethod.ExpirationMonth","PaymentMethod.ExpirationYear","PaymentMethod.StartMonth","PaymentMethod.StartYear","PaymentMethod.IssueNumber","PaymentMethod.AccountSuffix","PaymentMethod.AccountType","PaymentMethod.BoletoNumber","PaymentData.CardCategory","PaymentData.CardCategoryCode","PaymentMethod.WalletType","PaymentMethod.CheckNumber","PaymentMethod.MandateId","PaymentMethod.MandateType","PaymentMethod.SignatureDate","Travel.CompleteRoute","Travel.JourneyType","Travel.DepartureDateTime","Travel.PassengerFirstName","Travel.PassengerLastName","Travel.PassengerId","Travel.PassengerStatus","Travel.PassengerType","Travel.PassengerPhone","Travel.PassengerEmail","Application.Rcode","Application.Rflag","Application.Rmsg","ShipTo.Address1","ShipTo.Address2","ShipTo.City","ShipTo.State","ShipTo.Zip","ShipTo.Country","ShipTo.Phone","ShipTo.CompanyName","Application.ReasonCode","Risk.Factors","Risk.HostSeverity","Risk.Score","Risk.ConsumerPasswordProvided","Risk.LostPassword","Risk.RepeatCustomer","Risk.CookiesAccepted","Risk.ConsumerLoyalty","Risk.ConsumerPromotions","Risk.GiftWrap","Risk.ReturnsAccepted","Risk.ProductRisk","Risk.AppliedThreshold","Risk.AppliedTimeHedge","Risk.AppliedVelocityHedge","Risk.AppliedHostHedge","Risk.AppliedCategoryGift","Risk.AppliedCategoryTime","Risk.AppliedAVS","Risk.CodeValue","Risk.AppliedCV","Risk.BinAccountType","Risk.BinScheme","Risk.BinIssuer","Risk.BinCountry","Risk.IPCity","Risk.IPCountry","Risk.IPRoutingMethod","Risk.IPState","Risk.DeviceFingerPrint","Risk.CookiesEnabled","Risk.FlashEnabled","Risk.ImagesEnabled","Risk.JavascriptEnabled","Risk.ProxyIPAddress","Risk.ProxyIPAddressActivities","Risk.ProxyIPAddressAttributes","Risk.ProxyServerType","Risk.TrueIPAddress","Risk.TrueIPaddressActivities","Risk.TrueIPAddressAttributes","Risk.TrueIPAddressCountry","Risk.TrueIPAddressCity","Risk.CodeType","Risk.TimeLocal","BillTo.IPAddress","BillTo.HostName","BillTo.UserName","BillTo.CustomerID","PaymentData.Amount","PaymentData.PaymentRequestID","PaymentData.PaymentProcessor","PaymentData.TotalTaxAmount","PaymentData.EventType","PaymentData.GrandTotal","PaymentData.ECI","PaymentData.AAV_CAVV","PaymentData.XID","Profile.ProfileMode","Profile.ProfileDecision","Profile.RuleName","Profile.RuleDecision","Shipping.Method","Shipping.Carrier","Request.RequestID","Request.SubscriptionID","Request.Comments","PaymentData.TransactionRefNumber","PaymentData.eCommerceIndicator","Request.Source","Request.User","Request.TransactionDate","LineItems.Number","Request.MerchantReferenceNumber","Application.Name","Profile.Name","MerchantDefinedData.Field1","MerchantDefinedData.Field2","MerchantDefinedData.Field3","MerchantDefinedData.Field4","MerchantDefinedData.Field5","MerchantDefinedData.Field6","MerchantDefinedData.Field7","MerchantDefinedData.Field8","MerchantDefinedData.Field9","MerchantDefinedData.Field10","MerchantDefinedData.Field11","MerchantDefinedData.Field12","MerchantDefinedData.Field13","MerchantDefinedData.Field14","MerchantDefinedData.Field15","MerchantDefinedData.Field16","MerchantDefinedData.Field17","MerchantDefinedData.Field18","MerchantDefinedData.Field19","MerchantDefinedData.Field20","ShipTo.FirstName","ShipTo.LastName","Request.MerchantID","Travel.Number","PaymentData.ReconciliationID","PaymentData.TargetAmount","PaymentData.TargetCurrency","PaymentData.ExchangeRate","PaymentData.ExchangeRateDate","PaymentData.DCCIndicator","PaymentMethod.BankCode","PaymentMethod.BankAccountName","PaymentData.AuthIndicator","PaymentData.AuthReversalResult","PaymentData.AuthReversalAmount","PaymentData.CardPresent","PaymentData.POSEntryMode","PaymentData.EMVRequestFallBack","Request.PartnerOriginalTransactionID","Request.TerminalSerialNumber","PaymentData.POSCatLevel","Request.PartnerSDKVersion","PaymentData.CardVerificationMethod","PaymentData.POSEnvironment","PaymentData.TerminalIDAlternate","PaymentData.RoutingNetworkType","PaymentData.StoreAndForwardIndicator","PaymentData.PinType","PaymentData.IssuerResponseCode","PaymentData.AcquirerMerchantNumber","PaymentData.AcquirerMerchantID","PaymentData.PaymentProductCode","PaymentData.NetworkCode","PaymentData.MandateReferenceNumber","PaymentData.ProcessorTransactionID","PaymentData.ProcessorMID","PaymentData.SubMerchantCity","PaymentData.SubMerchantCountry","PaymentData.SubMerchantEmail","PaymentData.SubMerchantID","PaymentData.SubMerchantName","PaymentData.SubMerchantPhone","PaymentData.SubMerchantPostalCode","PaymentData.SubMerchantState","PaymentData.SubMerchantStreet","ChargebackAndRetrieval.ARN","ChargebackAndRetrieval.MerchantCategoryCode","ChargebackAndRetrieval.TransactionType","ChargebackAndRetrieval.CaseNumber","ChargebackAndRetrieval.ChargebackAmount","ChargebackAndRetrieval.ChargebackCurrency","ChargebackAndRetrieval.CaseIdentifier","ChargebackAndRetrieval.CaseType","ChargebackAndRetrieval.CaseTime","ChargebackAndRetrieval.ChargebackTime","ChargebackAndRetrieval.AdjustmentAmount","ChargebackAndRetrieval.AdjustmentCurrency","ChargebackAndRetrieval.FeeAmount","ChargebackAndRetrieval.FeeCurrency","ChargebackAndRetrieval.FinancialImpact","ChargebackAndRetrieval.FinancialImpactType","ChargebackAndRetrieval.PartialIndicator","ChargebackAndRetrieval.DocumentIndicator","ChargebackAndRetrieval.RespondByDate","ChargebackAndRetrieval.ChargebackReasonCode","ChargebackAndRetrieval.ChargebackReasonCodeDescription","ChargebackAndRetrieval.ResolvedToIndicator","ChargebackAndRetrieval.ResolutionTime","ChargebackAndRetrieval.ChargebackMessage","ChargebackAndRetrieval.ChargebackOriginalAmount","ChargebackAndRetrieval.ChargebackOriginalCurrency","BillTo.PersonalID","BillTo.CompanyTaxID","PaymentData.ProcessorResponseID","PaymentData.ProcessorTID","PaymentData.NetworkTransactionID","PaymentMethod.BoletoBarCodeNumber","Sender.SenderReferenceNumber","Recipient.RecipientBillingAmount","Recipient.RecipientBillingCurrency","Recipient.FirstName","Recipient.MiddleInitial","Recipient.ReferenceNumber","Recipient.LastName","Recipient.Address","Recipient.City","Recipient.State","Recipient.Country","Recipient.PostalCode","Recipient.PhoneNumber","Recipient.DOB","Sender.Address","Sender.City","Sender.State","Sender.PostalCode","Sender.Country","Sender.SourceOfFunds","Sender.FirstName","Sender.MiddleInitial","Sender.LastName","Sender.PhoneNumber","Sender.DOB","BatchFiles.BatchFileID","Device.DeviceID","Check.AccountEncoderID","Check.SecCode","Check.BankTransitNumber","BankInfo.Address","BankInfo.BranchCode","BankInfo.City","BankInfo.Country","BankInfo.Name","BankInfo.SwiftCode","FundTransfer.BankCheckDigit","FundTransfer.IbanIndicator","Token.TokenCode","Token.NetworkTokenTransType"]}}},"responses":{"201":{"description":"Created"},"304":{"description":"Not Modified"},"400":{"description":"Invalid request","schema":{"title":"reportingV3ReportsPost400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}}}}},"/reporting/v3/reports/{reportId}":{"get":{"tags":["Reports"],"summary":"Get Report based on reportId","description":"ReportId is mandatory input","operationId":"getReportByReportId","produces":["application/hal+json","application/xml"],"parameters":[{"name":"reportId","in":"path","description":"Valid Report Id","required":true,"type":"string"},{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32}],"x-example":{"example0":{"summary":"Get Report based on reportId","value":[]}},"responses":{"200":{"description":"OK","schema":{"title":"reportingV3ReportsIdGet200Response","type":"object","properties":{"organizationId":{"type":"string","description":"CyberSource merchant id","example":"myMerchantId"},"reportId":{"type":"string","description":"Report ID Value","example":"6da01922-bb8e-a1fb-e053-7cb8d30ade29"},"reportDefinitionId":{"type":"string","description":"Report definition Id","example":"210"},"reportName":{"type":"string","description":"Report Name","example":"My Transaction Request report"},"reportMimeType":{"type":"string","example":"application/xml","description":"Report Format","enum":["application/xml","text/csv"]},"reportFrequency":{"type":"string","example":"DAILY","description":"Report Frequency Value","enum":["DAILY","WEEKLY","MONTHLY"]},"reportFields":{"type":"array","description":"List of Integer Values","items":{"type":"string"},"example":["Request.RequestID","Request.TransactionDate","Request.MerchantID"]},"reportStatus":{"type":"string","description":"Report Status Value","enum":["COMPLETED","PENDING","QUEUED","RUNNING","ERROR","NO_DATA","RERUN"]},"reportStartTime":{"type":"string","format":"date-time","example":"2017-10-01T10:10:10+05:00","description":"Report Start Time Value"},"reportEndTime":{"type":"string","format":"date-time","example":"2017-10-02T10:10:10+05:00","description":"Report End Time Value"},"timezone":{"type":"string","description":"Time Zone Value","example":"America/Chicago"},"reportFilters":{"type":"object","description":"Report Filters","additionalProperties":{"type":"array","items":{"type":"string"}}},"reportPreferences":{"description":"Report Preferences","type":"object","properties":{"signedAmounts":{"type":"boolean","description":"Indicator to determine whether negative sign infron of amount for all refunded transaction"},"fieldNameConvention":{"type":"string","description":"Specify the field naming convention to be followed in reports (applicable to only csv report formats","enum":["SOAPI","SCMP"]}}},"selectedMerchantGroupName":{"type":"string","description":"Selected Merchant Group name","example":"myGroup"}},"description":"Report Log"}},"400":{"description":"Invalid Request","schema":{"title":"reportingV3ReportsIdPost400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"No Reports Found"}}}},"/reporting/v3/report-downloads":{"get":{"tags":["ReportDownloads"],"summary":"Download a report","description":"Download a report for the given report name on the specified date","operationId":"downloadReport","produces":["application/xml","test/csv"],"parameters":[{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32},{"name":"reportDate","in":"query","description":"Valid date on which to download the report in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n","required":true,"type":"string","format":"date"},{"name":"reportName","in":"query","description":"Name of the report to download","type":"string","required":true}],"x-example":{"example0":{"summary":"Download a report","value":[]}},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Request","schema":{"title":"reportingv3ReportDownloadsGet400Response","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"No Reports Found"}}}},"/v1/file-details":{"get":{"tags":["SecureFileShare"],"summary":"Get list of files","description":"Get list of files and it's information of them available inside the report directory","operationId":"getFileDetails","produces":["application/hal+json"],"parameters":[{"name":"startDate","in":"query","description":"Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n","required":true,"type":"string","format":"date"},{"name":"endDate","in":"query","description":"Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n","required":true,"type":"string","format":"date"},{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32}],"responses":{"200":{"description":"Ok","schema":{"type":"object","title":"V1FileDetailsGet200Response","properties":{"fileDetails":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","description":"Unique identifier of a file","example":"AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"},"name":{"type":"string","description":"Name of the file","example":"MyTransactionDetailreport.xml"},"createdTime":{"type":"string","format":"date-time","description":"Date and time for the file in PST","example":"2017-10-01T00:00:00+05:00"},"lastModifiedTime":{"type":"string","format":"date-time","description":"Date and time for the file in PST","example":"2017-10-01T00:00:00+05:00"},"date":{"type":"string","format":"date","description":"Date and time for the file in PST","example":"2017-10-05"},"mimeType":{"type":"string","description":"File extension","enum":["application/xml","text/csv","application/pdf","application/octet-stream"],"example":"application/xml"},"size":{"type":"integer","description":"Size of the file in bytes","example":2245397}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02"},"method":{"type":"string","example":"GET"}}},"files":{"type":"array","items":{"type":"object","properties":{"fileId":{"type":"string","description":"Unique identifier for each file","example":"AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"},"href":{"type":"string","example":"/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B"},"method":{"type":"string","example":"GET"}}}}}}}}},"400":{"description":"Invalid request","schema":{"type":"object","title":"V1FileDetailsGet400Response","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"VALIDATION_ERROR","correlationId":null,"detail":null,"fields":[{"path":"startTime","message":"Start date should not precede 18 months from current time in GMT","localizationKey":null}],"localizationKey":"cybsapi.validation.errors","message":"Field validation errors"}}},"401":{"description":"Ok","schema":{"type":"object","title":"V1FileDetailsGet401Response","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"VALIDATION_ERROR","correlationId":null,"detail":null,"fields":[{"path":"organizationId","message":"Organization doesn't has access to File details","localizationKey":null}],"localizationKey":"cybsapi.validation.errors","message":"Field validation errors"}}},"404":{"description":"Files Info not found","schema":{"type":"object","title":"V1FileDetailsGet404Response","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"RESOURCE_NOTFOUND","correlationId":null,"detail":"The requested resource is not found. Please try again later.","localizationKey":"cybsapi.resource.notfound","message":"Files Info not found for requested input values"}}},"500":{"description":"Internal Server Error","schema":{"type":"object","title":"V1FileDetailsGet500Response","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"},"examples":{"application/json":{"code":"SERVER_ERROR","correlationId":null,"detail":"Internal Server Error. Please contact the customer support.","localizationKey":"cybsapi.server.error","message":"Error encountered while processing request"}}}}}},"/v1/files/{fileId}":{"get":{"tags":["SecureFileShare"],"summary":"Download a file with file identifier","description":"Download a file for the given file identifier","operationId":"getFile","produces":["application/xml","text/csv","application/pdf"],"parameters":[{"name":"fileId","in":"path","description":"Unique identifier for each file","required":true,"type":"string"},{"name":"organizationId","in":"query","description":"Valid Cybersource Organization Id","pattern":"[a-zA-Z0-9-_]+","required":false,"type":"string","minLength":1,"maxLength":32}],"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Request","schema":{"type":"object","title":"V1FilesGet400Response","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"localizationKey":{"type":"string","description":"Localization Key Name"},"correlationId":{"type":"string","description":"Correlation Id"},"detail":{"type":"string","description":"Error Detail"},"fields":{"type":"array","description":"Error fields List","items":{"type":"object","properties":{"path":{"type":"string","description":"Path of the failed property"},"message":{"type":"string","description":"Error description about validation failed field"},"localizationKey":{"type":"string","description":"Localized Key Name"}},"description":"Provide validation failed input field details"}}},"description":"Error Bean"}},"404":{"description":"No Reports Found"}}}},"/tms/v1/instrumentidentifiers":{"post":{"summary":"Create an Instrument Identifier","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"Body","in":"body","description":"Please specify either a Card or Bank Account.","required":true,"schema":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}],"tags":["InstrumentIdentifiers"],"x-example":{"example0":{"summary":"Create an Instrument Identifier","value":{"card":{"number":"1234567890987654"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}}}}},"responses":{"200":{"description":"An existing Instrument Identifier holding the same supplied data has been returned.","headers":{"Location":{"description":"Link to the Instrument Identifier.","type":"string"},"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1InstrumentidentifiersPost200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}},"paymentInstruments":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"},"id":"1234567890123456789","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"444444XXXXXX4444"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}},"metadata":{"creator":"user"}}}},"201":{"description":"A new Instrument Identifier has been created.","headers":{"Location":{"description":"Link to the Instrument identifier.","type":"string"},"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1InstrumentidentifiersPost201Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"},"paymentInstruments":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"}},"id":"1234567890123456789","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"444444XXXXXX4444"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}},"metadata":{"creator":"user"}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPost400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPost403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPost424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPost500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}}},"/tms/v1/instrumentidentifiers/{tokenId}":{"get":{"summary":"Retrieve an Instrument Identifier","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of an Instrument Identifier.","required":true,"type":"string","minimum":16,"maximum":32}],"tags":["InstrumentIdentifier"],"responses":{"200":{"description":"An existing Instrument Identifier associated with the supplied tokenId has been returned.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1InstrumentidentifiersGet200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}},"x-examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"},"paymentInstruments":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"}},"id":"1234567890123456789","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"444444XXXXXX4444"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}},"metadata":{"creator":"user"}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersGet500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}},"patch":{"summary":"Update a Instrument Identifier","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of an Instrument Identifier.","required":true,"type":"string","minimum":16,"maximum":32},{"name":"Body","in":"body","description":"Please specify the previous transaction Id to update.","required":true,"schema":{"type":"object","properties":{"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}}}}}],"tags":["InstrumentIdentifier"],"x-example":{"example0":{"summary":"Create an Instrument Identifier","value":{"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}}}}},"responses":{"200":{"description":"The updated Instrument Identifier has been returned.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1InstrumentidentifiersPatch200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500"}},"id":"58FEBAEFD2EEFCE1E0539399D30A7500","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"424242XXXXXX4242"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":123456789012345}}}},"metadata":{"creator":"user"}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]},"Invalid Parameters":{"errors":[{"type":"invalidParameters","message":"Invalid parameter values","details":[{"name":"id"}]}]},"Unknown Field":{"errors":[{"type":"unknownField","message":"Unknown body values","details":[{"name":"id"}]}]},"Unsupported Fields":{"errors":[{"type":"unsupportedFields","message":"Unsupported body values for this action","details":[{"name":"bankAccount"},{"name":"card"}]}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPatch500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}},"delete":{"summary":"Delete an Instrument Identifier","tags":["InstrumentIdentifier"],"parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of an Instrument Identifier.","required":true,"type":"string","minimum":16,"maximum":32}],"responses":{"204":{"description":"An existing Instrument Identifier associated with the supplied tokenId has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"409":{"description":"Conflict: e.g. The token is linked to a Payment Instrument.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete409Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"paymentInstruments":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments"}}}}}},"items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"_links":{"paymentInstruments":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/7010000000001621111/paymentinstruments"}},"errors":[{"type":"instrumentIdentifierDeletionError","message":"Action cannot be performed as the InstrumentIdentifier is associated with one or more PaymentInstruments."}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersDelete500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}}},"/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments":{"get":{"summary":"Retrieve all Payment Instruments associated with an Instrument Identifier","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of an Instrument Identifier.","required":true,"type":"string","minimum":16,"maximum":32},{"name":"offset","in":"query","description":"Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0.","required":false,"type":"string","minimum":0},{"name":"limit","in":"query","description":"The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.","required":false,"type":"string","default":"20","minimum":1,"maximum":100}],"tags":["PaymentInstruments"],"responses":{"200":{"description":"Returns an array of Payment Instruments associated with the supplied Instrument Identifier.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"},"x-Total-Count":{"description":"The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset.","type":"string"}},"schema":{"type":"object","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"A link to the current requested collection.","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=5\""}}},"first":{"type":"object","properties":{"href":{"type":"string","description":"A link to the collection starting at offset zero for the supplied limit.","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=5"}}},"prev":{"type":"object","description":"A link to the previous collection starting at the supplied offset minus the supplied limit.","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=15&limit=5"}}},"next":{"type":"object","properties":{"href":{"description":"A link to the next collection starting at the supplied offset plus the supplied limit.","type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=25&limit=5"}}},"last":{"type":"object","properties":{"href":{"description":"A link to the last collection containing the remaining objects.","type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=35&limit=5"}}}}},"object":{"type":"string","readOnly":true,"example":"collection","description":"Shows the response is a collection of objects.","enum":["collection"]},"offset":{"type":"string","readOnly":true,"example":"20","description":"The offset parameter supplied in the request."},"limit":{"type":"string","readOnly":true,"example":"1","description":"The limit parameter supplied in the request."},"count":{"type":"string","readOnly":true,"example":"1","description":"The number of Payment Instruments returned in the array."},"total":{"type":"string","readOnly":true,"example":"39","description":"The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset."},"_embedded":{"type":"object","description":"Array of Payment Instruments returned for the supplied Instrument Identifier.","items":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=1"},"first":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=1"},"prev":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=19&limit=1"},"next":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=21&limit=1\""},"last":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=38&limit=1"}},"object":"collection","offset":20,"limit":1,"count":1,"total":39,"_embedded":{"paymentInstruments":[{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/paymentinstruments/6036673B73B12F19E0539399D30A2566"}},"id":"6036673B73B12F19E0539399D30A2566","object":"paymentInstrument","state":"ACTIVE","card":{"expirationMonth":"09","expirationYear":"2027","type":"visa","issueNumber":"01","startMonth":"01","startYear":"2017"},"buyerInformation":{"companyTaxId":"12345","currency":"USD"},"billTo":{"firstName":"John","lastName":"Smith","company":"CyberSource","address1":"1 My Apartment","address2":"Main Street","locality":"San Francisco","administrativeArea":"CA","postalCode":"90211","country":"US","email":"john.smith@test.com","phoneNumber":"+44 2890447777"},"processingInformation":{"billPaymentProgramEnabled":true},"metadata":{"creator":"user"},"_embedded":{"instrumentIdentifier":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1"}},"id":"5B32CE6167B09343E05333B9D30A53E1","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"424242XXXXXX1237"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":"123456789012345"}}}},"metadata":{"creator":"user"}}}}]}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1InstrumentidentifiersPaymentinstrumentsGet500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}}},"/tms/v1/paymentinstruments":{"post":{"summary":"Create a Payment Instrument","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"Body","in":"body","description":"Please specify the customers payment details for card or bank account.","required":true,"schema":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}}}],"tags":["PaymentInstruments"],"x-example":{"example0":{"summary":"Create an payment Identifier","value":{"card":{"expirationMonth":"09","expirationYear":"2022","type":"visa"},"billTo":{"firstName":"John","lastName":"Smith","company":"CyberSource","address1":"12 Main Street","address2":"20 My Street","locality":"Foster City","administrativeArea":"CA","postalCode":"90200","country":"US","email":"john.smith@example.com","phoneNumber":"555123456"},"instrumentIdentifier":{"card":{"number":"4111111111111111"}}}}},"responses":{"201":{"description":"A new Payment Instrument has been created.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1PaymentinstrumentsPost201Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46"}},"id":"5910683634E6B035E0539399D30A4B46","object":"paymentInstrument","state":"ACTIVE","card":{"expirationMonth":11,"expirationYear":2020,"type":"visa","issueNumber":1,"startMonth":12,"startYear":2017},"buyerInformation":{"companyTaxID":12345,"currency":"USD"},"billTo":{"firstName":"John","lastName":"Smith","company":"Cybersource","address1":"1 My Apartment","address2":"20 My Street","locality":"San Francisco","administrativeArea":"CA","postalCode":90210,"country":"US","email":"ohn.smith@test.com","phoneNumber":"+44 289044795"},"processingInformation":{"billPaymentProgramEnabled":true},"metadata":{"creator":"user"},"_embedded":{"instrumentIdentifier":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500"}},"id":"58FEBAEFD2EEFCE1E0539399D30A7500","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"424242XXXXXX4242"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":123456789012345}}}},"metadata":{"creator":"user"}}}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPost400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]},"Payment Instrument cannot be linked to instrument identifier because it does not exist":{"errors":[{"type":"instrumentIdentifierNotFound","message":"Action cannot be performed as the InstrumentIdentifier is not found"}]},"Payment Instrument cannot be linked to instrument identifier because it has been deleted":{"errors":[{"type":"instrumentIdentifierGone","message":"Action cannot be performed as the InstrumentIdentifier has gone"}]},"Payment Instrument cannot be linked to instrument identifier due to a token type mismatch":{"errors":[{"type":"invalidCombination","message":"The combination is invalid","details":[{"name":"bankAccount"},{"name":"card","location":"instrumentIdentifier"}]}]},"Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields":{"errors":[{"type":"invalidCombination","message":"The combination is invalid","details":[{"name":"id","location":"instrumentIdentifier"},{"name":"card","location":"instrumentIdentifier"}]}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPost403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPost424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPost500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}}},"/tms/v1/paymentinstruments/{tokenId}":{"patch":{"summary":"Update a Payment Instrument","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of a Payment Instrument.","required":true,"type":"string","minimum":16,"maximum":32},{"name":"Body","in":"body","description":"Please specify the customers payment details.","required":true,"schema":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}}}],"tags":["PaymentInstruments"],"x-example":{"example0":{"summary":"Update Payment Instrument","value":{"card":{"expirationMonth":"09","expirationYear":"2022","type":"visa"},"billTo":{"firstName":"John","lastName":"Smith","company":"CyberSource","address1":"12 Main Street","address2":"20 My Street","locality":"Foster City","administrativeArea":"CA","postalCode":"90200","country":"US","email":"john.smith@example.com","phoneNumber":"555123456"},"instrumentIdentifier":{"card":{"number":"4111111111111111"}}}}},"responses":{"200":{"description":"The updated Payment Instrument has been returned.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1PaymentinstrumentsPatch200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}},"examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46"}},"id":"5910683634E6B035E0539399D30A4B46","object":"paymentInstrument","state":"ACTIVE","card":{"expirationMonth":11,"expirationYear":2020,"type":"visa","issueNumber":1,"startMonth":12,"startYear":2017},"buyerInformation":{"companyTaxID":12345,"currency":"USD"},"billTo":{"firstName":"John","lastName":"Smith","company":"Cybersource","address1":"1 My Apartment","address2":"20 My Street","locality":"San Francisco","administrativeArea":"CA","postalCode":90210,"country":"US","email":"ohn.smith@test.com","phoneNumber":"+44 289044795"},"processingInformation":{"billPaymentProgramEnabled":true},"metadata":{"creator":"user"},"_embedded":{"instrumentIdentifier":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500"}},"id":"58FEBAEFD2EEFCE1E0539399D30A7500","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"424242XXXXXX4242"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":123456789012345}}}},"metadata":{"creator":"user"}}}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]},"Payment Instrument cannot be linked to instrument identifier because it does not exist":{"errors":[{"type":"instrumentIdentifierNotFound","message":"Action cannot be performed as the InstrumentIdentifier is not found"}]},"Payment Instrument cannot be linked to instrument identifier because it has been deleted":{"errors":[{"type":"instrumentIdentifierGone","message":"Action cannot be performed as the InstrumentIdentifier has gone"}]},"Payment Instrument cannot be linked to instrument identifier due to a token type mismatch":{"errors":[{"type":"invalidCombination","message":"The combination is invalid","details":[{"name":"bankAccount"},{"name":"card","location":"instrumentIdentifier"}]}]},"Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields":{"errors":[{"type":"invalidCombination","message":"The combination is invalid","details":[{"name":"id","location":"instrumentIdentifier"},{"name":"card","location":"instrumentIdentifier"}]}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsPatch500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}},"get":{"summary":"Retrieve a Payment Instrument","parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of a Payment Instrument.","required":true,"type":"string","minimum":16,"maximum":32}],"tags":["PaymentInstruments"],"responses":{"200":{"description":"An existing Payment Instrument associated with the supplied tokenId has been returned.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"object","title":"tmsV1PaymentinstrumentsGet200Response","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"id":{"type":"string","readOnly":true,"example":"1234567890123456800","description":"Unique identification number assigned by CyberSource to the submitted request."},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["paymentInstrument"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"bankAccount":{"type":"object","properties":{"type":{"type":"string","example":"savings","description":"Type of Bank Account."}}},"card":{"type":"object","properties":{"expirationMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card expiration month."},"expirationYear":{"type":"string","example":"2022","minimum":1900,"maximum":2099,"description":"Credit card expiration year."},"type":{"type":"string","example":"visa","description":"Credit card brand.","enum":["visa","mastercard","american express","discover","diners club","carte blanche","jcb","optima","twinpay credit","twinpay debit","walmart","enroute","lowes consumer","home depot consumer","mbna","dicks sportswear","casual corner","sears","jal","disney","maestro uk domestic","sams club consumer","sams club business","nicos","bill me later","bebe","restoration hardware","delta online","solo","visa electron","dankort","laser","carte bleue","carta si","pinless debit","encoded account","uatp","household","maestro international","ge money uk","korean cards","style","jcrew","payease china processing ewallet","payease china processing bank transfer","meijer private label","hipercard","aura","redecard","orico","elo","capital one private label","synchrony private label","china union pay"]},"issueNumber":{"type":"string","example":"01","minimum":0,"maximum":99,"description":"Credit card issue number."},"startMonth":{"type":"string","example":"12","minimum":1,"maximum":12,"description":"Credit card start month."},"startYear":{"type":"string","example":"12","minimum":1900,"maximum":2099,"description":"Credit card start year."},"useAs":{"type":"string","example":"pinless debit","description":"Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens."}}},"buyerInformation":{"type":"object","properties":{"companyTaxID":{"type":"string","example":"1234567890123456800","maximum":9,"description":"Company Tax ID."},"currency":{"type":"string","example":"USD","minimum":3,"maximum":3,"description":"Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha"},"dateOBirth":{"type":"string","example":"1960-12-30","description":"Date of birth YYYY-MM-DD."},"personalIdentification":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1234567890","description":"Identification Number."},"type":{"type":"string","example":"driver license","description":"Type of personal identification."},"issuedBy":{"type":"object","properties":{"administrativeArea":{"type":"string","example":"CA","description":"State or province where the identification was issued."}}}}}}}},"billTo":{"type":"object","properties":{"firstName":{"type":"string","example":"John","maximum":60,"description":"Bill to First Name."},"lastName":{"type":"string","example":"Smith","maximum":60,"description":"Bill to Last Name."},"company":{"type":"string","example":"CyberSource","maximum":60,"description":"Bill to Company."},"address1":{"type":"string","example":"12 Main Street","maximum":60,"description":"Bill to Address Line 1."},"address2":{"type":"string","example":"20 My Street","maximum":60,"description":"Bill to Address Line 2."},"locality":{"type":"string","example":"Foster City","maximum":50,"description":"Bill to City."},"administrativeArea":{"type":"string","example":"CA","maximum":20,"description":"Bill to State."},"postalCode":{"type":"string","example":"90200","maximum":10,"description":"Bill to Postal Code."},"country":{"type":"string","example":"US","minimum":2,"maximum":3,"description":"Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2"},"email":{"type":"string","example":"john.smith@example.com","maximum":320,"description":"Valid Bill to Email."},"phoneNumber":{"type":"string","example":"555123456","minimum":6,"maximum":32,"description":"Bill to Phone Number."}}},"processingInformation":{"type":"object","properties":{"billPaymentProgramEnabled":{"type":"boolean","example":true,"description":"Bill Payment Program Enabled."},"bankTransferOptions":{"type":"object","properties":{"SECCode":{"type":"string","example":"WEB","description":"Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)."}}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"alternateName":{"type":"string","example":"Branch Name","description":"Alternate information for your business. This API field overrides the company entry description value in your CyberSource account."}}}}},"metaData":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}},"instrumentIdentifier":{"type":"object","properties":{"_links":{"type":"object","readOnly":true,"properties":{"self":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"ancestor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}},"successor":{"type":"object","properties":{"href":{"type":"string","example":"https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789"}}}}},"object":{"type":"string","readOnly":true,"example":"instrumentIdentifier","description":"Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.","enum":["instrumentIdentifier"]},"state":{"type":"string","readOnly":true,"example":"ACTIVE","description":"Current state of the token.","enum":["ACTIVE","CLOSED"]},"id":{"type":"string","example":"1234567890123456789","minimum":16,"maximum":32,"description":"The id of the existing instrument identifier to be linked to the newly created payment instrument."},"card":{"type":"object","properties":{"number":{"type":"string","example":"1234567890987654","minimum":12,"maximum":19,"description":"Credit card number (PAN)."}}},"bankAccount":{"type":"object","properties":{"number":{"type":"string","example":"1234567890123456800","minimum":1,"maximum":19,"description":"Bank account number."},"routingNumber":{"type":"string","example":"123456789","minimum":1,"maximum":9,"description":"Routing number."}}},"processingInformation":{"type":"object","properties":{"authorizationOptions":{"type":"object","properties":{"initiator":{"type":"object","properties":{"merchantInitiatedTransaction":{"type":"object","properties":{"previousTransactionId":{"type":"string","example":"123456789012345","maximum":15,"description":"Previous Consumer Initiated Transaction Id."}}}}}}}}},"metadata":{"type":"object","readOnly":true,"properties":{"creator":{"type":"string","example":"merchantName","description":"The creator of the token."}}}}}}},"x-examples":{"application/json":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46"}},"id":"5910683634E6B035E0539399D30A4B46","object":"paymentInstrument","state":"ACTIVE","card":{"expirationMonth":11,"expirationYear":2020,"type":"visa","issueNumber":1,"startMonth":12,"startYear":2017},"buyerInformation":{"companyTaxID":12345,"currency":"USD"},"billTo":{"firstName":"John","lastName":"Smith","company":"Cybersource","address1":"1 My Apartment","address2":"20 My Street","locality":"San Francisco","administrativeArea":"CA","postalCode":90210,"country":"US","email":"ohn.smith@test.com","phoneNumber":"+44 289044795"},"processingInformation":{"billPaymentProgramEnabled":true},"metadata":{"creator":"user"},"_embedded":{"instrumentIdentifier":{"_links":{"self":{"href":"https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500"}},"id":"58FEBAEFD2EEFCE1E0539399D30A7500","object":"instrumentIdentifier","state":"ACTIVE","card":{"number":"424242XXXXXX4242"},"processingInformation":{"authorizationOptions":{"initiator":{"merchantInitiatedTransaction":{"previousTransactionId":123456789012345}}}},"metadata":{"creator":"user"}}}}}},"400":{"description":"Bad Request: e.g. A required header value could be missing.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet400Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"Missing Headers":{"errors":[{"type":"missingHeaders","message":"Missing header values"}]}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsGet500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}},"delete":{"summary":"Delete a Payment Instrument","tags":["PaymentInstruments"],"parameters":[{"name":"profile-id","in":"header","description":"The id of a profile containing user specific TMS configuration.","required":true,"type":"string","minimum":36,"maximum":36},{"name":"tokenId","in":"path","description":"The TokenId of a Payment Instrument.","required":true,"type":"string","minimum":16,"maximum":32}],"responses":{"204":{"description":"An existing Payment Instrument associated with the supplied tokenId has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}}},"403":{"description":"Forbidden: e.g. The profile might not have permission to perform the token operation.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsDelete403Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"forbidden","message":"Request not permitted"}]}}},"404":{"description":"Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsDelete404Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Token not found"}]}}},"410":{"description":"Token Not Available: e.g. The token has been deleted.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsDelete410Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notAvailable","message":"Token not available"}]}}},"424":{"description":"Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsDelete424Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}},"examples":{"application/json":{"errors":[{"type":"notFound","message":"Profile not found"}]}}},"500":{"description":"Unexpected error.","headers":{"uniqueTransactionID":{"description":"A globally unique id associated with your request.","type":"string"}},"examples":{"application/json":{"errors":[{"type":"serverError","message":"Internal server error"}]}},"schema":{"type":"array","title":"tmsV1PaymentinstrumentsDelete500Response","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string","description":"The detailed message related to the type stated above."},"details":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that threw the error."},"location":{"type":"string","description":"The location of the field that threw the error."}}}}}}}}}},"/tss/v2/transactions/{id}":{"get":{"summary":"Retrieve a Transaction","description":"Include the Request ID in the GET request to retrieve the transaction details.","tags":["TransactionDetails"],"operationId":"getTransaction","parameters":[{"name":"id","in":"path","description":"Request ID.\n","required":true,"type":"string"}],"x-example":{"example0":{"summary":"Retrieve a Transaction","value":[]}},"responses":{"200":{"description":"Successful response.","schema":{"title":"tssV2TransactionsGet200Response","type":"object","properties":{"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"rootId":{"type":"string","maxLength":26,"description":"Payment Request Id"},"reconciliationId":{"type":"string","maxLength":60,"description":"The reconciliation id for the submitted transaction. This value is not returned for all processors.\n"},"merchantId":{"type":"string","description":"The description for this field is not available."},"status":{"type":"string","description":"The status of the submitted transaction."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"applicationInformation":{"type":"object","properties":{"status":{"type":"string","description":"The status of the submitted transaction."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"applications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"status":{"type":"string","description":"The description for this field is not available."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"reconciliationId":{"type":"string","description":"The description for this field is not available."},"rMessage":{"type":"string","description":"The description for this field is not available."},"returnCode":{"type":"string","description":"The description for this field is not available."}}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"hashedPassword":{"type":"string","maxLength":100,"description":"The description for this field is not available.\n"}}},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"applicationVersion":{"type":"string","description":"The description for this field is not available."},"applicationName":{"type":"string","description":"The application name of client which is used to submit the request."},"applicationUser":{"type":"string","description":"The description for this field is not available."},"comments":{"type":"string","description":"The description for this field is not available."}}},"consumerAuthenticationInformation":{"type":"object","properties":{"eciRaw":{"type":"string","maxLength":2,"description":"Raw electronic commerce indicator (ECI)."},"cavv":{"type":"string","maxLength":40,"description":"Cardholder authentication verification value (CAVV)."},"xid":{"type":"string","maxLength":40,"description":"Transaction identifier."},"transactionId":{"type":"string","description":"Payer auth Transaction identifier."}}},"deviceInformation":{"type":"object","properties":{"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."},"hostName":{"type":"string","maxLength":60,"description":"DNS resolved hostname from above _ipAddress_."},"cookiesAccepted":{"type":"string","description":"The description for this field is not available."}}},"errorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The description for this field is not available."},"message":{"type":"string","description":"The description for this field is not available."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}},"installmentInformation":{"type":"object","properties":{"numberOfInstallments":{"type":"string","description":"Number of Installments."}}},"fraudMarkingInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The description for this field is not available."}}},"merchantDefinedInformation":{"type":"array","description":"The description for this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"The description for this field is not available."},"value":{"type":"string","maxLength":255,"description":"The description for this field is not available."}}}},"merchantInformation":{"type":"object","properties":{"merchantDescriptor":{"type":"object","properties":{"name":{"type":"string","maxLength":23,"description":"For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n"}}}}},"orderInformation":{"type":"object","properties":{"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"middelName":{"type":"string","maxLength":60,"description":"Customer\u2019s middle name.\n"},"nameSuffix":{"type":"string","maxLength":60,"description":"Customer\u2019s name suffix.\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"address2":{"type":"string","maxLength":60,"description":"Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"locality":{"type":"string","maxLength":50,"description":"City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"title":{"type":"string","maxLength":60,"description":"Title.\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"lastName":{"type":"string","maxLength":60,"description":"Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the shipping address."},"address2":{"type":"string","maxLength":60,"description":"Second line of the shipping address."},"locality":{"type":"string","maxLength":50,"description":"City of the shipping address."},"administrativeArea":{"type":"string","maxLength":2,"description":"State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n"},"postalCode":{"type":"string","maxLength":10,"description":"Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n"},"company":{"type":"string","maxLength":60,"description":"Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"phoneNumber":{"type":"string","maxLength":15,"description":"Phone number for the shipping address."}}},"lineItems":{"type":"array","description":"Transaction Line Item data.","items":{"type":"object","properties":{"productCode":{"type":"string","maxLength":255,"description":"Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n"},"productName":{"type":"string","maxLength":255,"description":"For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n"},"productSku":{"type":"string","maxLength":255,"description":"Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n"},"taxAmount":{"type":"string","maxLength":15,"description":"Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n1. You include each line item in your request.\n..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n"},"quantity":{"type":"number","minimum":1,"maximum":9999999999,"description":"For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n","default":1},"unitPrice":{"type":"string","maxLength":15,"description":"Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"fulfillmentType":{"type":"string","description":"The description for this field is not available."}}}},"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"},"taxAmount":{"type":"string","maxLength":12,"description":"Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n"},"authorizedAmount":{"type":"string","maxLength":15,"description":"Amount that was authorized.\n"}}},"shippingDetails":{"type":"object","properties":{"giftWrap":{"type":"boolean","description":"The description for this field is not available."},"shippingMethod":{"type":"string","maxLength":10,"description":"Shipping method for the product. Possible values:\n\n - lowcost: Lowest-cost service\n - sameday: Courier or same-day service\n - oneday: Next-day or overnight service\n - twoday: Two-day service\n - threeday: Three-day service\n - pickup: Store pick-up\n - other: Other shipping method\n - none: No shipping method because product is a service or subscription\n"}}}}},"paymentInformation":{"type":"object","properties":{"paymentType":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"type":{"type":"string","description":"The description for this field is not available."},"subType":{"type":"string","description":"The description for this field is not available."},"method":{"type":"string","description":"The description for this field is not available."},"fundingSource":{"type":"string","description":"The description for this field is not available."},"fundingSourceAffiliation":{"type":"string","description":"The description for this field is not available."},"credential":{"type":"string","description":"The description for this field is not available."}}},"customer":{"type":"object","properties":{"customerId":{"type":"string","maxLength":26,"description":"Unique identifier for the customer's card and billing information."}}},"card":{"type":"object","properties":{"suffix":{"type":"string","maxLength":4,"description":"Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n"},"prefix":{"type":"string","maxLength":6,"description":"The description for this field is not available."},"expirationMonth":{"type":"string","maxLength":2,"description":"Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"expirationYear":{"type":"string","maxLength":4,"description":"Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"startMonth":{"type":"string","maxLength":2,"description":"Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"startYear":{"type":"string","maxLength":4,"description":"Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n"},"issueNumber":{"type":"string","maxLength":5,"description":"Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n"},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"},"accountEncoderId":{"type":"string","maxLength":3,"description":"Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n"},"useAs":{"type":"string","maxLength":2,"description":"Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n"}}},"invoice":{"type":"object","properties":{"number":{"type":"string","description":"Invoice Number."},"barcodeNumber":{"type":"string","description":"Barcode Number."},"expirationDate":{"type":"string","description":"Expiration Date."}}},"bank":{"type":"object","properties":{"routingNumber":{"type":"string","description":"The description for this field is not available."},"branchCode":{"type":"string","description":"The description for this field is not available."},"swiftCode":{"type":"string","description":"The description for this field is not available."},"bankCode":{"type":"string","description":"The description for this field is not available."},"iban":{"type":"string","description":"The description for this field is not available."},"account":{"type":"object","properties":{"suffix":{"type":"string","description":"The description for this field is not available."},"prefix":{"type":"string","description":"The description for this field is not available."},"checkNumber":{"type":"string","description":"The description for this field is not available."},"type":{"type":"string","description":"The description for this field is not available."},"name":{"type":"string","description":"The description for this field is not available."},"checkDigit":{"type":"string","description":"The description for this field is not available."},"encoderId":{"type":"string","description":"The description for this field is not available."}}},"mandate":{"type":"object","properties":{"referenceNumber":{"type":"string","description":"The description for this field is not available."},"recurringType":{"type":"string","description":"The description for this field is not available."},"id":{"type":"string","description":"The description for this field is not available."}}}}},"accountFeatures":{"type":"object","properties":{"balanceAmount":{"type":"string","maxLength":12,"description":"Remaining balance on the account.\n"},"previousBalanceAmount":{"type":"string","maxLength":12,"description":"Remaining balance on the account.\n"},"currency":{"type":"string","maxLength":5,"description":"Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n"}}}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"commerceIndicator":{"type":"string","maxLength":20,"description":"Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n"},"businessApplicationId":{"type":"string","description":"The description for this field is not available."},"authorizationOptions":{"type":"object","properties":{"authType":{"type":"string","maxLength":15,"description":"Authorization type. Possible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture\n request for a verbal payment.\n\nFor processor-specific information, see the auth_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"bankTransferOptions":{"type":"object","properties":{"secCode":{"type":"string","description":"The description for this field is not available."}}}}},"processorInformation":{"type":"object","properties":{"processor":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Name of the Processor.\n"}}},"transactionId":{"type":"string","maxLength":50,"description":"Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n"},"networkTransactionId":{"type":"string","description":"The description for this field is not available."},"responseId":{"type":"string","description":"The description for this field is not available."},"providerTransactionId":{"type":"string","description":"The description for this field is not available."},"approvalCode":{"type":"string","description":"Authorization code. Returned only when the processor returns this value.\n"},"responseCode":{"type":"string","maxLength":10,"description":"For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n"},"avs":{"type":"object","properties":{"code":{"type":"string","maxLength":1,"description":"AVS result code.\n"},"codeRaw":{"type":"string","maxLength":10,"description":"AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n"}}},"cardVerification":{"type":"object","properties":{"resultCode":{"type":"string","maxLength":1,"description":"CVN result code.\n"}}},"achVerification":{"type":"object","properties":{"resultCode":{"type":"string","maxLength":1,"description":"The description for this field is not available..\n"},"resultCodeRaw":{"type":"string","maxLength":10,"description":"The description for this field is not available.\n"}}},"electronicVerificationResults":{"type":"object","properties":{"email":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s email address.\n"},"emailRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s email address."},"name":{"type":"string","maxLength":30,"description":"The description for this field is not available.\n"},"nameRaw":{"type":"string","maxLength":30,"description":"The description for this field is not available."},"phoneNumber":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s phone number.\n"},"phoneNumberRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s phone number."},"street":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s street address.\n"},"streetRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s street address."},"postalCode":{"type":"string","maxLength":1,"description":"Mapped Electronic Verification response code for the customer\u2019s postal code.\n"},"postalCodeRaw":{"type":"string","maxLength":1,"description":"Raw Electronic Verification response code from the processor for the customer\u2019s postal code."}}}}},"pointOfSaleInformation":{"type":"object","properties":{"entryMode":{"type":"string","maxLength":11,"description":"Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n"},"terminalCapability":{"type":"integer","minimum":1,"maximum":5,"description":"POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n"}}},"riskInformation":{"type":"object","properties":{"profile":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"decision":{"type":"string","description":"The description for this field is not available."}}},"rules":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"decision":{"type":"string","description":"The description for this field is not available."}}}},"passiveProfile":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"decision":{"type":"string","description":"The description for this field is not available."}}},"passiveRules":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"decision":{"type":"string","description":"The description for this field is not available."}}}},"score":{"type":"object","properties":{"factorCodes":{"type":"array","description":"Array of factor codes.","items":{"type":"string","description":"Represents a factor code."}},"result":{"type":"integer","description":"The description for this field is not available.\n"}}},"localTime":{"type":"string","description":"Time that the transaction was submitted in local time.."}}},"senderInformation":{"type":"object","properties":{"referenceNumber":{"type":"string","maxLength":19,"description":"Reference number generated by you that uniquely identifies the sender."}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}}},"example":{"id":"5330579740206278601009","rootId":"5330571038726320201013","reconciliationId":"53703847LK9LPPXY","merchantId":"string","status":"PENDING","submitTimeUtc":"2018-07-31T17:26:14Z","applicationInformation":{"status":"PENDING","reasonCode":"100","rCode":"string","rFlag":"string","applications":[{"name":"ics_bill","status":"PENDING","reasonCode":"100","rCode":"string","rFlag":"string","reconciliationId":"53703847LK9LPPXY","rMessage":"Request was processed successfully.","returnCode":"1260000"}]},"buyerInformation":{"merchantCustomerId":"123456","hashedPassword":"fhjfhj"},"clientReferenceInformation":{"code":"ECERT001","applicationVersion":"1.0","applicationName":"string","applicationUser":"ng_paymentech","comments":"test comment"},"consumerAuthenticationInformation":{"eciRaw":"1234","cavv":"12345","xid":"12345678","transactionId":"string"},"deviceInformation":{"ipAddress":"1.10.10.10","hostName":"cybs test","cookiesAccepted":"no"},"errorInformation":{"reason":"string","message":"string","details":[{"field":"string","reason":"string"}]},"installmentInformation":{"numberOfInstallments":0},"fraudMarkingInformation":{"reason":"string"},"merchantDefinedInformation":[{"key":"string","value":"string"}],"merchantInformation":{"merchantDescriptor":{"name":"ng_paymentech"}},"orderInformation":{"billTo":{"firstName":"JAMES","lastName":"DOUGH","middleName":"ROY","nameSuffix":"Mr","address1":"600 Morgan Falls Road","address2":"Room 2-2123","locality":"Atlanta","administrativeArea":"GA","postalCode":"30350","company":"cybersource","email":"jdough@cybersource.com","country":"US","title":"Manager","phoneNumber":"6509656111"},"shipTo":{"firstName":"Test","lastName":"TSS","address1":"201S.DivisionSt._1","address2":"Suite500","locality":"Austin","administrativeArea":"TX","postalCode":"78750","company":"cybs","country":"US","phoneNumber":"5120000000"},"lineItems":[{"productCode":"string","productName":"string","productSku":"string","taxAmount":"string","quantity":123,"unitPrice":"string","fulfillmentType":"string"}],"amountDetails":{"totalAmount":"100","currency":"USD","taxAmount":"5","authorizedAmount":"100"},"shippingDetails":{"giftWrap":"none","shippingMethod":"string"}},"paymentInformation":{"paymentType":{"name":"paymentProcessor1234","type":"credit card","subType":"V1","method":"string","fundingSource":"string","fundingSourceAffiliation":"string","credential":"string"},"customer":{"customerId":"string"},"card":{"suffix":"1111","prefix":"123","expirationMonth":"10","expirationYear":"2017","startMonth":"string","startYear":"string","issueNumber":"string","type":"credit card","accountEncoderId":"string","useAs":"string"},"invoice":{"number":"string","barcodeNumber":"string","expirationDate":"string"},"bank":{"routingNumber":"string","branchCode":"string","swiftCode":"string","bankCode":"string","iban":"string","account":{"suffix":"2222","prefix":"123","checkNumber":"123456","type":"string","name":"string","checkDigit":"string","encoderId":"string"},"mandate":{"referenceNumber":"string","recurringType":"string","id":"string"}},"accountFeatures":{"balanceAmount":"string","previousBalanceAmount":"string","currency":"string"}},"processingInformation":{"paymentSolution":"Visa","commerceIndicator":"7","businessApplicationId":"string","authorizationOptions":{"authType":"0"},"bankTransferOptions":{"secCode":"string"}},"processorInformation":{"processor":{"name":"paymentProcessor1234"},"transactionId":"processortransactionid123","networkTransactionId":"networktransactionid67890","responseId":"string","providerTransactionId":"string","approvalCode":"authcode1234567","responseCode":"responsecode12345678","avs":{"code":"ARM","codeRaw":"avsResults"},"cardVerification":{"resultCode":"Y"},"achVerification":{"resultCode":"rspcodmap","resultCodeRaw":"responsecode12345678"},"electronicVerificationResults":{"email":"email@email.com","emailRaw":"emailRaw12","name":"ename","nameRaw":"enameRaw12","phoneNumber":"01179","phoneNumberRaw":"9925551608","street":"123 street","streetRaw":"SteertRaw12","postalCode":"78717","postalCodeRaw":"1166678717"}},"pointOfSaleInformation":{"entryMode":"posentrymode1234512","terminalCapability":"integer"},"riskInformation":{"profile":{"name":"string","decision":"string"},"rules":[{"name":"string","decision":"string"}],"passiveProfile":{"name":"string","decision":"string"},"passiveRules":[{"name":"string","decision":"string"}],"localTime":"string","score":{"factorCodes":["string"],"result":"integer"}},"senderInformation":{"referenceNumber":"senderRefNumber1"},"_links":{"self":{"href":"https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5330579740206278601009","method":"GET"}}}}},"404":{"description":"The specified resource not found in the system."},"500":{"description":"Unexpected server error."}}}},"/tss/v2/searches":{"post":{"summary":"Create a search request","description":"Create a search request.\n","tags":["SearchTransactions"],"operationId":"createSearch","parameters":[{"name":"createSearchRequest","in":"body","required":true,"schema":{"title":"tssV2TransactionsPostResponse","type":"object","properties":{"save":{"type":"boolean","description":"save or not save."},"name":{"type":"string","description":"The description for this field is not available.\n"},"timezone":{"type":"string","description":"Time Zone."},"query":{"type":"string","description":"transaction search query string."},"offset":{"type":"integer","description":"offset."},"limit":{"type":"integer","description":"limit on number of results."},"sort":{"type":"string","description":"A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc."}}}}],"x-example":{"example0":{"summary":"Create a search request","value":{"save":"false","name":"TSS search","timezone":"America/Chicago","query":"clientReferenceInformation.code:12345","offset":0,"limit":100,"sort":"id:asc, submitTimeUtc:asc"}}},"responses":{"201":{"description":"Successful response.","schema":{"title":"tssV2TransactionsPost201Response","type":"object","properties":{"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"save":{"type":"boolean","description":"save or not save."},"name":{"type":"string","description":"The description for this field is not available.\n"},"timezone":{"type":"string","description":"Time Zone."},"query":{"type":"string","description":"transaction search query string."},"offset":{"type":"integer","description":"offset."},"limit":{"type":"integer","description":"limit on number of results."},"sort":{"type":"string","description":"A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc."},"count":{"type":"integer","description":"Results for this page, this could be below the limit."},"totalCount":{"type":"integer","description":"total number of results."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"_embedded":{"type":"object","properties":{"transactionSummaries":{"type":"array","description":"transaction search summary","items":{"type":"object","properties":{"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"merchantId":{"type":"string","description":"The description for this field is not available."},"applicationInformation":{"type":"object","properties":{"status":{"type":"string","description":"The status of the submitted transaction."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"applications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"status":{"type":"string","description":"The description for this field is not available."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"reconciliationId":{"type":"string","description":"The description for this field is not available."},"rMessage":{"type":"string","description":"The description for this field is not available."},"returnCode":{"type":"string","description":"The description for this field is not available."}}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"applicationName":{"type":"string","description":"The application name of client which is used to submit the request."},"applicationUser":{"type":"string","description":"The description for this field is not available."}}},"consumerAuthenticationInformation":{"type":"object","properties":{"xid":{"type":"string","maxLength":40,"description":"Transaction identifier."},"transactionId":{"type":"string","description":"Payer auth Transaction identifier."}}},"deviceInformation":{"type":"object","properties":{"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."}}},"fraudMarkingInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The description for this field is not available."}}},"merchantDefinedInformation":{"type":"array","description":"The description for this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"The description for this field is not available."},"value":{"type":"string","maxLength":255,"description":"The description for this field is not available."}}}},"merchantInformation":{"type":"object","properties":{"resellerId":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."}}},"orderInformation":{"type":"object","properties":{"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"lastName":{"type":"string","maxLength":60,"description":"Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the shipping address."},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"phoneNumber":{"type":"string","maxLength":15,"description":"Phone number for the shipping address."}}},"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}}},"paymentInformation":{"type":"object","properties":{"paymentMethod":{"type":"object","properties":{"type":{"type":"string","description":"The description for this field is not available."}}},"customer":{"type":"object","properties":{"customerId":{"type":"string","maxLength":26,"description":"Unique identifier for the customer's card and billing information."}}},"card":{"type":"object","properties":{"suffix":{"type":"string","maxLength":4,"description":"Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n"},"prefix":{"type":"string","maxLength":6,"description":"The description for this field is not available."},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"}}}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"businessApplicationId":{"type":"string","description":"The description for this field is not available."}}},"processorInformation":{"type":"object","properties":{"processor":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Name of the Processor.\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"terminalId":{"type":"string","maxLength":8,"description":"Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n"},"terminalSerialNumber":{"type":"string","description":"The description for this field is not available."},"deviceId":{"type":"string","description":"The description for this field is not available."},"partner":{"type":"object","properties":{"originalTransactionId":{"type":"string","maxLength":50,"description":"Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n"}}}}},"riskInformation":{"type":"object","properties":{"providers":{"type":"object","properties":{"fingerprint":{"type":"object","properties":{"true_ipaddress":{"type":"string","maxLength":255,"description":"The description for this field is not available."},"hash":{"type":"string","maxLength":255,"description":"The description for this field is not available."},"smartId":{"type":"string","maxLength":255,"description":"The description for this field is not available."}}}}}}},"_links":{"type":"object","properties":{"transactionDetail":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}}},"example":{"id":"87e1e4bd-cac2-49b1-919a-4d5e29a2e55d","save":"false","name":"Search By Code","timezone":"America/Chicago","query":"clientReferenceInformation.code:12345","offset":0,"limit":2000,"sort":"id:asc, submitTimeUtc:asc","count":22,"totalCount":22,"submitTimeUtc":"2018-09-18T16:59:28Z","_embedded":{"transactionSummaries":[{"id":"5217848115816817001541","submitTimeUtc":"2018-03-23T06:00:11Z","merchantId":"sandeep_wf","applicationInformation":{"status":"string","reasonCode":"string","rCode":"string","rFlag":"string","applications":[{"name":"ics_service_fee_calculate","status":"string","reasonCode":"string","rCode":"string","rFlag":"string","reconciliationId":"string","rMessage":"string","returnCode":"string"}]},"buyerInformation":{"merchantCustomerId":"123456"},"clientReferenceInformation":{"code":"12345","applicationName":"Service Fee Request","applicationUser":"sandeep_wf"},"consumerAuthenticationInformation":{"xid":"12345678","transactionId":"string"},"deviceInformation":{"ipAddress":"1.10.10.10"},"fraudMarkingInformation":{"reason":"fraud txn"},"merchantDefinedInformation":[{"key":"string","value":"string"}],"merchantInformation":{"resellerId":"wfbmcp"},"orderInformation":{"billTo":{"firstName":"Test","lastName":"TSS","email":"null@cybersource.com","country":"US","phoneNumber":"5120000000"},"shipTo":{"firstName":"Test","lastName":"TSS","address1":"201S.DivisionSt._1","country":"US","phoneNumber":"5120000000"},"amountDetails":{"totalAmount":"100.00","currency":"USD"}},"paymentInformation":{"paymentmethod":{"type":"credit card"},"customer":{"customerId":"12345"},"card":{"suffix":"1111","prefix":"123456","type":"credit card"}},"processingInformation":{"paymentSolution":"xyz","businessApplicationId":"string"},"processorInformation":{"processor":{"name":"FirstData"}},"pointOfSaleInformation":{"terminalId":"1","terminalSerialNumber":"123111123","deviceId":"asfaf12312313","partner":{"originalTransactionId":"131231414414"}},"riskInformation":{"providers":{"fingerprint":{"true_ipaddress":"1.101.102.112","hash":"tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=","smart_id":"23442fdadfa"}}},"_links":{"transactionDetail":{"href":"https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541","method":"GET"}}}]},"_links":{"self":{"href":"https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d","method":"GET"}}}}},"400":{"description":"Invalid request.","schema":{"title":"tssV2TransactionsPost400Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"502":{"description":"Unexpected system error or system timeout.","schema":{"title":"tssV2TransactionsPost502Response","type":"object","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["SERVER_ERROR"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["SYSTEM_ERROR","SERVER_TIMEOUT","SERVICE_TIMEOUT","PROCESSOR_TIMEOUT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."}}}}}}},"/tss/v2/searches/{id}":{"get":{"summary":"Get Search results","description":"Include the Search ID in the GET request to retrieve the search results.","tags":["SearchTransactions"],"operationId":"getSearch","parameters":[{"name":"id","in":"path","description":"Search ID.","required":true,"type":"string"}],"x-example":{"example0":{"summary":"Get Search results","value":[]}},"responses":{"200":{"description":"Successful response.","schema":{"title":"tssV2SearchesGet200Response","type":"object","properties":{"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"save":{"type":"boolean","description":"save or not save."},"name":{"type":"string","description":"The description for this field is not available.\n"},"timezone":{"type":"string","description":"Time Zone."},"query":{"type":"string","description":"transaction search query string."},"offset":{"type":"integer","description":"offset."},"limit":{"type":"integer","description":"limit on number of results."},"sort":{"type":"string","description":"A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc."},"count":{"type":"integer","description":"Results for this page, this could be below the limit."},"totalCount":{"type":"integer","description":"total number of results."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"_embedded":{"type":"object","properties":{"transactionSummaries":{"type":"array","description":"transaction search summary","items":{"type":"object","properties":{"id":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."},"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"merchantId":{"type":"string","description":"The description for this field is not available."},"applicationInformation":{"type":"object","properties":{"status":{"type":"string","description":"The status of the submitted transaction."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"applications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The description for this field is not available."},"status":{"type":"string","description":"The description for this field is not available."},"reasonCode":{"type":"string","description":"The description for this field is not available."},"rCode":{"type":"string","description":"The description for this field is not available."},"rFlag":{"type":"string","description":"The description for this field is not available."},"reconciliationId":{"type":"string","description":"The description for this field is not available."},"rMessage":{"type":"string","description":"The description for this field is not available."},"returnCode":{"type":"string","description":"The description for this field is not available."}}}}}},"buyerInformation":{"type":"object","properties":{"merchantCustomerId":{"type":"string","maxLength":100,"description":"Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"clientReferenceInformation":{"type":"object","properties":{"code":{"type":"string","maxLength":50,"description":"Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n"},"applicationName":{"type":"string","description":"The application name of client which is used to submit the request."},"applicationUser":{"type":"string","description":"The description for this field is not available."}}},"consumerAuthenticationInformation":{"type":"object","properties":{"xid":{"type":"string","maxLength":40,"description":"Transaction identifier."},"transactionId":{"type":"string","description":"Payer auth Transaction identifier."}}},"deviceInformation":{"type":"object","properties":{"ipAddress":{"type":"string","maxLength":15,"description":"IP address of the customer."}}},"fraudMarkingInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The description for this field is not available."}}},"merchantDefinedInformation":{"type":"array","description":"The description for this field is not available.","items":{"type":"object","properties":{"key":{"type":"string","maxLength":50,"description":"The description for this field is not available."},"value":{"type":"string","maxLength":255,"description":"The description for this field is not available."}}}},"merchantInformation":{"type":"object","properties":{"resellerId":{"type":"string","maxLength":26,"description":"An unique identification number assigned by CyberSource to identify the submitted request."}}},"orderInformation":{"type":"object","properties":{"billTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"lastName":{"type":"string","maxLength":60,"description":"Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"email":{"type":"string","maxLength":255,"description":"Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"country":{"type":"string","maxLength":2,"description":"Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"phoneNumber":{"type":"string","maxLength":15,"description":"Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"}}},"shipTo":{"type":"object","properties":{"firstName":{"type":"string","maxLength":60,"description":"First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"lastName":{"type":"string","maxLength":60,"description":"Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n"},"address1":{"type":"string","maxLength":60,"description":"First line of the shipping address."},"country":{"type":"string","maxLength":2,"description":"Country of the shipping address. Use the two character ISO Standard Country Codes."},"phoneNumber":{"type":"string","maxLength":15,"description":"Phone number for the shipping address."}}},"amountDetails":{"type":"object","properties":{"totalAmount":{"type":"string","maxLength":19,"description":"Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n"},"currency":{"type":"string","maxLength":3,"description":"Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n"}}}}},"paymentInformation":{"type":"object","properties":{"paymentMethod":{"type":"object","properties":{"type":{"type":"string","description":"The description for this field is not available."}}},"customer":{"type":"object","properties":{"customerId":{"type":"string","maxLength":26,"description":"Unique identifier for the customer's card and billing information."}}},"card":{"type":"object","properties":{"suffix":{"type":"string","maxLength":4,"description":"Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n"},"prefix":{"type":"string","maxLength":6,"description":"The description for this field is not available."},"type":{"type":"string","maxLength":3,"description":"Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n"}}}}},"processingInformation":{"type":"object","properties":{"paymentSolution":{"type":"string","maxLength":12,"description":"Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n"},"businessApplicationId":{"type":"string","description":"The description for this field is not available."}}},"processorInformation":{"type":"object","properties":{"processor":{"type":"object","properties":{"name":{"type":"string","maxLength":30,"description":"Name of the Processor.\n"}}}}},"pointOfSaleInformation":{"type":"object","properties":{"terminalId":{"type":"string","maxLength":8,"description":"Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n"},"terminalSerialNumber":{"type":"string","description":"The description for this field is not available."},"deviceId":{"type":"string","description":"The description for this field is not available."},"partner":{"type":"object","properties":{"originalTransactionId":{"type":"string","maxLength":50,"description":"Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n"}}}}},"riskInformation":{"type":"object","properties":{"providers":{"type":"object","properties":{"fingerprint":{"type":"object","properties":{"true_ipaddress":{"type":"string","maxLength":255,"description":"The description for this field is not available."},"hash":{"type":"string","maxLength":255,"description":"The description for this field is not available."},"smartId":{"type":"string","maxLength":255,"description":"The description for this field is not available."}}}}}}},"_links":{"type":"object","properties":{"transactionDetail":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}}}}}}},"_links":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL"},"method":{"type":"string","description":"HTTP method applied to above URL"}}}}}},"example":{"id":"87e1e4bd-cac2-49b1-919a-4d5e29a2e55d","save":"false","name":"Search By Code","timezone":"America/Chicago","query":"clientReferenceInformation.code:12345","offset":0,"limit":2000,"sort":"id:asc, submitTimeUtc:asc","count":22,"totalCount":22,"submitTimeUtc":"2018-09-18T16:59:28Z","_embedded":{"transactionSummaries":[{"id":"5217848115816817001541","submitTimeUtc":"2018-03-23T06:00:11Z","merchantId":"sandeep_wf","applicationInformation":{"status":"string","reasonCode":"string","rCode":"string","rFlag":"string","applications":[{"name":"ics_service_fee_calculate","status":"string","reasonCode":"string","rCode":"string","rFlag":"string","reconciliationId":"string","rMessage":"string","returnCode":"string"}]},"buyerInformation":{"merchantCustomerId":"123456"},"clientReferenceInformation":{"code":"12345","applicationName":"Service Fee Request","applicationUser":"sandeep_wf"},"consumerAuthenticationInformation":{"xid":"12345678","transactionId":"string"},"deviceInformation":{"ipAddress":"1.10.10.10"},"fraudMarkingInformation":{"reason":"fraud txn"},"merchantDefinedInformation":[{"key":"string","value":"string"}],"merchantInformation":{"resellerId":"wfbmcp"},"orderInformation":{"billTo":{"firstName":"Test","lastName":"TSS","email":"null@cybersource.com","country":"US","phoneNumber":"5120000000"},"shipTo":{"firstName":"Test","lastName":"TSS","address1":"201S.DivisionSt._1","country":"US","phoneNumber":"5120000000"},"amountDetails":{"totalAmount":"100.00","currency":"USD"}},"paymentInformation":{"paymentmethod":{"type":"credit card"},"customer":{"customerId":"12345"},"card":{"suffix":"1111","prefix":"123456","type":"credit card"}},"processingInformation":{"paymentSolution":"xyz","businessApplicationId":"string"},"processorInformation":{"processor":{"name":"FirstData"}},"pointOfSaleInformation":{"terminalId":"1","terminalSerialNumber":"123111123","deviceId":"asfaf12312313","partner":{"originalTransactionId":"131231414414"}},"riskInformation":{"providers":{"fingerprint":{"true_ipaddress":"1.101.102.112","hash":"tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=","smart_id":"23442fdadfa"}}},"_links":{"transactionDetail":{"href":"https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541","method":"GET"}}}]},"_links":{"self":{"href":"https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d","method":"GET"}}}}},"404":{"description":"The specified resource not found in the system."},"500":{"description":"Unexpected server error."}}}},"/ums/v1/users":{"get":{"summary":"Get user based on organization Id, username, permission and role","description":"This endpoint is to get all the user information depending on the filter criteria passed in the query.","tags":["UserManagement"],"operationId":"getUsers","parameters":[{"in":"query","name":"organizationId","type":"string","description":"This is the orgId of the organization which the user belongs to."},{"in":"query","name":"userName","type":"string","description":"User ID of the user you want to get details on."},{"in":"query","name":"permissionId","type":"string","description":"permission that you are trying to search user on."},{"in":"query","name":"roleId","type":"string","description":"role of the user you are trying to search on."}],"x-example":{"example0":{"summary":"User Management","value":[]}},"responses":{"200":{"description":"OK","schema":{"type":"object","title":"umsV1UsersGet200Response","properties":{"users":{"type":"array","items":{"type":"object","properties":{"accountInformation":{"type":"object","properties":{"userName":{"type":"string"},"roleId":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","description":"array of permissions"}},"status":{"type":"string","enum":["active","inactive","locked","disabled","forgotpassword","deleted"]},"createdTime":{"type":"string","format":"date-time"},"lastAccessTime":{"type":"string","format":"date-time"},"languagePreference":{"type":"string"},"timezone":{"type":"string"}}},"organizationInformation":{"type":"object","properties":{"organizationId":{"type":"string"}}},"contactInformation":{"type":"object","properties":{"email":{"type":"string"},"phoneNumber":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"}}}}}}},"example":{"users":[{"accountInformation":{"userName":"auto_nonmember","roleId":"admin","permissions":["ReportViewPermission","ReportGeneratePermission"],"status":"active","createdTime":"2018-06-14T19:45:52.093Z","lastAccessTime":"2018-06-14T19:45:52.093Z","languagePreference":"en-US","timezone":"America/Los_Angeles"},"organizationInformation":{"organizationId":"auto_nonmember"},"contactInformation":{"email":"auto_nonmember@exchange.com","phoneNumber":"4445551234","firstName":"Zeta","lastName":"DMH"}}]}}},"400":{"description":"Invalid request.","schema":{"type":"object","title":"umsV1UsersGet400Response","properties":{"submitTimeUtc":{"type":"string","description":"Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n"},"status":{"type":"string","description":"The status of the submitted transaction.","enum":["INVALID_REQUEST"]},"reason":{"type":"string","description":"The reason of the status.\n","enum":["MISSING_FIELD","INVALID_DATA","DUPLICATE_REQUEST","INVALID_CARD","INVALID_MERCHANT_CONFIGURATION","CAPTURE_ALREADY_VOIDED","ACCOUNT_NOT_ALLOWED_CREDIT"]},"message":{"type":"string","description":"The detail message related to the status and reason listed above."},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"This is the flattened JSON object field name/path that is either missing or invalid."},"reason":{"type":"string","description":"Possible reasons for the error.\n","enum":["MISSING_FIELD","INVALID_DATA"]}}}}}}},"500":{"description":"Unexpected server error."}}}}},"definitions":{"TokenizeResult":{"properties":{"keyId":{"type":"string","description":"The Key ID."},"token":{"type":"string","description":"The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API."},"maskedPan":{"type":"string","description":"The masked card number displaying the first 6 digits and the last 4 digits."},"cardType":{"type":"string","description":"The card type."},"timestamp":{"type":"integer","format":"int64","description":"The UTC date and time in milliseconds at which the signature was generated."},"signedFields":{"type":"string","description":"Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature."},"signature":{"type":"string","description":"Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource."},"discoverableServices":{"type":"object","additionalProperties":{"type":"object"}}}},"TokenizeParameters":{"type":"object","properties":{"keyId":{"type":"string","description":"Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key."},"cardInfo":{"type":"object","properties":{"cardNumber":{"type":"string","description":"Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request."},"cardExpirationMonth":{"type":"string","description":"Two digit expiration month"},"cardExpirationYear":{"type":"string","description":"Four digit expiration year"},"cardType":{"type":"string","description":"Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types."}}}}},"KeyParameters":{"type":"object","properties":{"encryptionType":{"type":"string","description":"How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified."}}},"JsonWebKey":{"type":"object","description":"The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.","properties":{"kty":{"type":"string","description":"Algorithm used to encrypt the public key."},"use":{"type":"string","description":"Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc."},"kid":{"type":"string","description":"The key ID in JWK format."},"n":{"type":"string","description":"JWK RSA Modulus"},"e":{"type":"string","description":"JWK RSA Exponent"}}},"DerPublicKey":{"type":"object","description":"The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.","properties":{"format":{"type":"string","description":"Specifies the format of the public key; currently X.509."},"algorithm":{"type":"string","description":"Algorithm used to encrypt the public key."},"publicKey":{"type":"string","description":"Base64 encoded public key value."}}},"KeyResult":{"properties":{"keyId":{"type":"string","description":"Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser."},"der":{"type":"object","description":"The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.","properties":{"format":{"type":"string","description":"Specifies the format of the public key; currently X.509."},"algorithm":{"type":"string","description":"Algorithm used to encrypt the public key."},"publicKey":{"type":"string","description":"Base64 encoded public key value."}}},"jwk":{"type":"object","description":"The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.","properties":{"kty":{"type":"string","description":"Algorithm used to encrypt the public key."},"use":{"type":"string","description":"Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc."},"kid":{"type":"string","description":"The key ID in JWK format."},"n":{"type":"string","description":"JWK RSA Modulus"},"e":{"type":"string","description":"JWK RSA Exponent"}}}}},"CardInfo":{"type":"object","properties":{"cardNumber":{"type":"string","description":"Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request."},"cardExpirationMonth":{"type":"string","description":"Two digit expiration month"},"cardExpirationYear":{"type":"string","description":"Four digit expiration year"},"cardType":{"type":"string","description":"Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types."}}},"Error":{"properties":{"responseStatus":{"properties":{"status":{"type":"number","description":"HTTP Status code."},"reason":{"type":"string","description":"Error Reason Code."},"message":{"type":"string","description":"Error Message."},"correlationId":{"type":"string","description":"API correlation ID."},"details":{"type":"array","items":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}}}}},"_links":{"properties":{"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}}}},"Link":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}},"Links":{"properties":{"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}},"ResponseStatus":{"properties":{"status":{"type":"number","description":"HTTP Status code."},"reason":{"type":"string","description":"Error Reason Code."},"message":{"type":"string","description":"Error Message."},"correlationId":{"type":"string","description":"API correlation ID."},"details":{"type":"array","items":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}}}}},"ResponseStatusDetails":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}},"ErrorResponse":{"type":"object","properties":{"responseStatus":{"properties":{"status":{"type":"number","description":"HTTP Status code."},"reason":{"type":"string","description":"Error Reason Code."},"message":{"type":"string","description":"Error Message."},"correlationId":{"type":"string","description":"API correlation ID."},"details":{"type":"array","items":{"properties":{"location":{"type":"string","description":"Field name referred to for validation issues."},"message":{"type":"string","description":"Description or code of any error response."}}}}}},"_links":{"type":"object","properties":{"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}}},"ErrorLinks":{"type":"object","properties":{"next":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"documentation":{"type":"array","items":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}},"self":{"properties":{"href":{"type":"string","description":"URI of the linked resource."},"title":{"type":"string","description":"Label of the linked resource."},"method":{"type":"string","description":"HTTP method of the linked resource."}}}}}}}
\ No newline at end of file
diff --git a/generator/cybersource_node_sdk_gen.bat b/generator/cybersource_node_sdk_gen.bat
new file mode 100644
index 00000000..dc3e1c3c
--- /dev/null
+++ b/generator/cybersource_node_sdk_gen.bat
@@ -0,0 +1,9 @@
+mkdir %~dp0cybersource-rest-client-node
+cd %~dp0
+java -jar swagger-codegen-cli-2.3.0.jar generate -t cybersource-javascript-template -i cybersource-rest-spec.json -l javascript -o cybersource-rest-client-node -c %~dp0cybersource-node-config.json
+
+pause
+
+
+
+
diff --git a/generator/swagger-codegen-cli-2.3.0.jar b/generator/swagger-codegen-cli-2.3.0.jar
new file mode 100644
index 0000000000000000000000000000000000000000..df35262c9998e5f3f5192f0fd4bbb433e9738637
GIT binary patch
literal 14298637
zcmbTe1C(UT)-GDMZQHhO+qUiMvTfV8ySr@Lw(Y9d``_p4-Mi0y=jF&XM&?*CXGF}5
ziTL7MsUQsuf&u^m0ReEGn<5SHKfNFUKmcS#RRn1z<;3W}#sC0-0TiUcA^vIs^sif9N|mIL9OI*;Tt5DPWlLMGpC*ee<``3jJdS;Nc32`0$bbVrryQ=4#opGZPD?OOz1KljW*r znK#wH6(Of|nP+yw@ zS({2`$9v1-D%no4u@T 7u8pYHI=|VtmTmh`;gEs6$ey0&(%o>~IhywB;1(dgMg|j^HCW@m^2Ju-5tiSIC zv@MX-kSc&kirE?M3VCUD)fY0+7+h?{eb{VWo3|oU<4MCa`*nUgWD zGf{C*=%UkhJcAjDG@%kO3HPv1}i=NmcqKJIlCmoE74Y-0XoSTtfMT} z1KXd%P>kiawmBz)cuItu>`JX$ojeD+=?J@S)cP4)n_{&WXsn* dqq!athn<(>(n&G}oX5 zj7;5Ao_b4Tp;FK>8wS%f7NCpXIOv0ePw>`Rv`I{Z2w$b%0D>%8%QlH9Iyk^|`z|_C zk3lDB%8X|Gi6sF~d6j-;4rZ8TsmGz^;UQbM!a^+qQk1qvC@hC`la@ wF9VNXy9vCzgBEjmx!nD7k z4MY;kM&(?*##g}sA&dhHbGRXgaDGY3=6oC~vuIOg=f^0Sk2H)Vhi0SwX8i?i=j~3C zKWH1nC?$_mT4|QoY*uwgXPp5wPH4J)M`xJ #S5Cd>4vfc{
Y5>$c6C4I5v^7Ek<6rNOhx0>qPYK1O;#+-FF!!B zErwS`K~iudk6~xW5M$AKw~QmY8kMp4#mb_t+AWj0wZ7lQ$BXKSJtu{ZNMi0Imoa`^ zntHZhR}vieZu3h*+VuX(*hurW+YhYD-QbzJA(I(+9ZOPgxXbgF$PK=AubcHEX|Qif z+~u6Ms)QL!)B$Ihjg3FmF|}qQb1&=1;FfgAFD;r}XPi=>*R1ivUL#iEA;A&)^V`Wk zh+vJvy&$h0wnKT7w`~) 5y(#f+6W!;FNc2E`;FOb&s2pQr_yQiR0Wf!)conEH zU~>Thj4_Va2 #1n(E{q~>U3d$6IBo&hL&3)?zTvGE~5J2cL~h~z0&e1Va6SYN=qh{j*|@nl{| zUTujvVN })hud* zcgXJIz`KzjfF!z7bZ4>{q?DrK(r1_qkDh0m8sUJBh~xN0YJU9cEoj~_r1{B%=-CVB z=#G`1!npWI|7LPTvAZ#zsz*{N`*2D5HlodcifQ4}8ub|1MZtV!A}@N?L-=!Pm% ?Z40l zT4Ni_{|KCB{g1Uf*xS;1*xK}{%i8a=A@m%pmy5w&3Kn-^=L`HkYZMJY>$0t W?(%iGJ6@c6-%Fj_ zzm N0hp)8`^^PI>M6XH$XayS2(F=kaRGSMzD*jeAcWyd z2Hkxc&oMsR_SV&)iVspWZKAH8W&uq)O}T#?KFyQFCH=IaCbw>CtZ cDyfR3EHmrB=e=CV_!127lQFl>ZoQwCLzmB z9sSgGoT**GvqGh3FI^7Na_&sS1EE@4)-BhDY}yE$OVk@_(2Sa^U9^9M!5i0<2K&2O zfmCmy!Ye-Z#abE1x`Z}MK{zHSf#}2qToZW=#+ek(YhQK75~`?;iP~0o3mJU4X2tL- z?s_Ra+qwhvxQq~1=FB~ko4wq2?f|<3{@mSg)B-;DN%|O9y+K~V+=a}ErYS-DEw6U! z(gSLo&VFW03`-LndJ^Edl)4CT0;fd=`JyU)mkuwv7N=k_Z#kA*LTI>e4tCtq!>m2C z;{q;efjrn;>oa#W2Kp(r*e`6dB(>uM-S3!fwNTTAA7zpn8hWFjUg3wFU=%$*AuVXJ zJDGjv8jQh~6IbEf&&B)7#p5@}Y4~gd+PCiCWFI2l-X5bZz3mL1i OwDZ@kN zjyS0BgvB}8C*?oA*2t?;J6>k5Mf(^oqE=R$rRY`A?;yWNmEO+laC8KplAPq$e_>#c z&aYU=4O^%|Dt(?hywnjV`KjA6*gB7us5+hZw}tMy(ntQOv=MCg4F!{}@8<97=@JJh zB+X<>^SR6mJ$_2Q`T_33c_uhKl3UuedQcu#-gC9|X!bP@4c6LiMKMuO`1pR&7+pG! zEvy2q(K<-9Ul}4-1N#L(X@(ier2|=kM~80LA+7PT?=|Tpp5i)LI>hvyi?hcE%Z1v~ zv&0{q@&6S|YhIYxfc^m0REYmBmJ gcIGyzygk*ZzPYdox|IkYu?9ekq7>MFQB;d-0chVxo}-Z~Jk)5@z|%aAO^D=K5l zOhWaLvg@+=G?0|4jogb?#~FN3`ExMG7H{PYCjhd;I1FaUIF5q~4qjMrcy@n*rp?X{ zVifv5SyNwlgm#w=moB12q4MgE*N$t$Iz5Z2zGrA|0Z>F_8l( Q3g)eJ z8;a(3MoqIMWvcqFPzcW>bwBJtbSGAy-2s;! 0j8MT1+4H>+ur f>V*9d%UuOx4cXj*xSU+0up<+5OwqP*Y`m@ zTgnjZP42iWMig1RNuMVNlu?bJ=8mHZ7m}eb%5&FX@Tswn=_duuFu?xN*S#K0(Vtb? z=|$uOz*v&?Hfoa?yl{+f#}1)0f{kdW)d)R2pO_7Ie0%s@eCC$2iSRdI!p&H?+QSS} z^HUChui*t^*I`B!sr-abs1fMz94XSR1->GYOQ$-WusP9eZ)*%&-$v5}a_8E6-eHbw zDPuE$%Eg7%Q5b|d9CWUGVvJ(mf$`%U%N4|8sFnJWR@uWwOrOYqtzsB2r4QFX2l~K& zs)B#U_lf>_70VdfnLGdMh($$Ld0qg8Hwz7j5Gt9zDqNJZ`G?4$yq02h;grct16=I> zJe%&C>0K`g >5L zdnhHWri^vEU@bh<9hMp6a+Igeb#EY)a6jyZilg)(k+8dBCzFnu#KGM;%xI!ID$Hl8 z%b-?&1;jUP-3p3iM(*IH>(%%OKLlBSCkzIe%qeCsT-{=@y#|N^a;+h!YX5;9Ed@gB zwgYD8#fWJ-TTQ2-bD7d%R x jp&D z5~|p!GtQM7B+IE&*v?xeQN2$GDk@`i^7)orJfV%Hcra4~0M}Ge9^t%LlhS-DkGt@a z%Epo-xV!4cydyrm3e71+e)&FOsw&UiEe17J?g_;%Wr9BEQfaR>k;a%w5Dg+G2hyIZ zY0`kwt;{f0?tI4-7H-UEdE$U$)?M6SuNZ}G5zU9KCFK0R>TVJYn=iw}u~sqtDh~vd z=Y28}lKoM&Whxx72zdu_KbLR=>i13G0e6pj5UuB=EEp-4#*@kx?Hb|_E#zG-o||2r zuLD}+^s`{d-SD`A>6&;umn)OJ*y(wutvfpesIV`NI>B;cSp}?HYa%ox-d DwoQnoY-gd`hiH zGoVlgnN&FkjgN>sltyPtQ~U^D65{no=rMK|<_kgAU-{&VSs#FxzDBj(VL#m!qeM1{ zLQJ};K(fhBG=XB*V%P}b*GeeaA{nhbc7I4QCzjHKq8s<6G03_7AW9p}g0Og(`Z1yZ zmseE7TN)1i@ruZQ>lOdNZczT4vLXC8?c#6O$WhgHo)<&;Vsq<`P{ tEG zSep~7m=|E2EOE_`vH0CTKctssYC_qRX!zFjwpW@{Fh4BkuTo}C$|#A|VOkl++jM-F zbDhoG^>$yU?+@$%O$&`$t&twU9uP<46D?2X5VfxiowwT>0=lvLvN6(yqwlc5smA&9 zKx4ms*l}CqC(}4E^7@X42bB2@>oAwFscHz7rZL4LnmguLOgS-TX(m;29M~ssMP7K% z4;DFQt0)6?3)82L#_Vnd#(p1VQN0hX2QMXWTcDHCnfoSR;`OD`4tkXlg&JP_pD1;~ z=;8IpuMuj7b-ATzo#F;fpk`oSQfC^X1%yf_TiE6K#H_<$L5mOzK{nF{_927~5F$9^ zZ7Lyi0cT_xFeTz&>hQ)8wO-vT_|MyDKF`1U)#Gl~F@p;rtLqTU55<8uQ_sf$Ch_d2 zBO@9d;f`%>jG`_)xzq05=-Pk>Z)0MtUs8Ad@Gh~cq|GWsku2M0H=L|J%QmcU_aeJ+ zEl(@!u{(-K8P!z=7<@ 50#`LHnw znZ?62=ZFo`u@ReSk$W9l^Lw(GR?OR(h-wi-bQi~c#BNtn1I~(l=wj|hyv&Tjf5wo% z^!@=L=jwBKq_L+Rex^^~GEe$^`D$QHSyFO&zPaK)x|?LjLbjZ_*fv-!RSlNIxLbju zpXVI;zU4VS(76zAqC>{`0G`cKXUfX=#Gfr#r*wNz?6<1DOS*Y8%c{c!79&2s6J0QD z@MRL^B)K2hVmIT2VzqiA9lw5y;K}2oghIC{ehpdbpQM+bdF>{-HHtrsoC$_gb4Xuz zybk@I$SHdSy5vcWK6sg%HsCKg;?$z9a6&`3Y+(lX`5{e0?ucoJ_W}NzBEiS~TVtLQ zH~%6!Z99LCYV!vEcUZauSy+9x@_Y(=y*BAF?=Mw1vd^XV`=8sD9Lj!C-1C0ceHpi5 z4z2cZj9n}Pr`wK4=qi{nc}ipE0e68?6v($whins-CK<$RuzO7bo;-t#$#q$dg^Bzm znx$E+@@Qgw%nymQN+Hsosu@RMmO~EAHNKdviD;{6Cv~p4N&dipd8d6uOTFYDN)^Jt zr3jGzbI$s26oG&Frkb`owkpaOT(FEpsJ2$QWfi8@LNHQcs#XDtEhVi*yMz|PnQdY= zNtm43Tm~|fhvj!D{m-}RanP#9)VGW28}k=~P4h$n;C78Fcuw=FpV#)+P4ZuF&u!a) zI)n2JM(LLWIDAVtk{Fliu!KcVuX5d?AqZ%ThLq9r4b_C$VjxXc9r#1Q)fO7CMc{d& z^`Vatczez*J_WndqOVf@%Z4xpYC#o*WrWiRH *#VP+cxTgsnPF zCFM7$yAj!g_N%SLvXnUM#_jQla%(8Hq>+t3*Liw0RCVTHR?I?}n@d1~a-|@ =P*Ger;IY`WJUL&Q0)VvRD0d{Po?41%-9eRbDWF zFvZ2nK7IWLJG%(tuA*t&?xEBs%bgNwiLMfu1?wnPR&nYcMiJ?Cej-6oQBW;x5VX57 zOJKhotg3)&eTF>AaiTz6u#ZTCi|&vRK S=6r3cpB;sHDLSuxVv{ zQFuufunRAF9p4Z*(-S*e5-NM?aTed#W6n`sWiC7Gz4hD!)J}7`nBw AHAY+Y{;IT2m?s;v!%G>g;G@kHA1ivzz5)3E?KCA zzBM*p&_2>{z^=M6p5HT2T0H>^#5)nVS5Z@j@pyF@7*q3gvbw};`elapGhbjp;rt?5 z;QhqC(s*>n7P$6%wD9&xEXwX_ONNQ^^HUbr7+b*a8GLIFAxru47ef#=Ub+C3(Ur@= zDp+GSp*WTz-cQhLPqRN;!vva*(R+9G3ue(^XB(rYbc3G}32SpZ3N>izqiSChbY18# zip*(S!nPs=Xl`(PVUTefVvoa_K7QPvox}9!ad0D&z%w?Yew_|(OEu>0ii jIL6J5!+Is4@<;+%L<3-vdz3 )5q1j`fT^;@ z$RueDc6r1(;R=U-Nkt>F?YD SehqFs|bFAsd2jqul zVU@D@l +E55|wO8=aIajijuiM5T%YjfBjUgzAkfjr624!xHl%^A6SDgrFwYIcBiC zxu`p7XdY!7=KIIUapd`V<*0U~C@H3Sq$KGdg$jh52Or4`4+}h-2iY=o|3w@+$Trs1 z{4+rPKi5A`;s3ThX8hOoSnbsv`A>*0mE;~}5YR@W4F{oMk<~7RC~U26MVUd1PZm;) zs!K{U88ac9kkNu_?AW2Z3hyc`{0cr6&^p9 ;#D?)g0V z>-+N+{YTA<>`(#&)=jntjw*tvj#yow)Ii8VdNdy>Ar5*RvZ0O0uk;+0rek3b!DxD@ z(H|b!NN)5YzfoX>)CmX?f%Jn(l%VDqf=wiPEz=221}q}NY6zm32|1v2JeZuALWMCD z>+#G@qp3vpv!m~s^imxKg*XOjuNbD?NNg_HY$kCHD^T27Hsu_&=D9o*4`uBAC2Ms1 z_6*IIyeA|b>*fi%NH>LT(k)FkOw+SbgoFrtdB_Yc4QY=tOPBf^n>AYc>tXEEf+buk zH(4f!_#k`Xj0go_qVUH|!8+#0!DJH`+}636-_wo5p9>jIN?_Fky=I7Namk!@5`* zJxk1ywBVmLKGBRw&Rbb0aOL}!EI1E6=(1XHr|XsYriV_imPp#At0tIjs>a!nvyBQ@ zIO((QgTV&-_cN+TdGgxrZJ4M_26@96APKUYb71aya^ndS<{~3-;qbQH)s8g-Xu>-| z$&lD4g2+j!t{6XAK
S3k6dWPbNUL*6SE({*3yqjrP;1(S6tl&9s=^B*BCVL1QR{Y818y@Tmm8EPYAZc} zxj(h;996nCH9VvT*M(kjyQSf5rVez*Br_8o6$iaN^aoje1WXzCFo>WMNP5M2xShTN zqv2J3g5ykm3ip(C)NeU|Cf}w+*4@T{l)s>DSG?fykF;0piGPSNbmrjZz}+`RYPVAv zYGxEB)}IM-#U0U1kK9N`QFEs+?ubV628uVv(lXI~yovU8aw1pmN%D{yPF9mE2t7U| z7V5FoWo8;_amXc88C5thqk^1#xKGZS9jW)IL wNJ>|nU*fvhG9TX(Pe@B^;Mvl+ zm#d4IOMwcgHm(q{C6lu0`mP=v30a|y&qyjr nS{fv#2dYZkf}GTKs! zw`J=S+L3PThyI{A-;?BOmO+Osx3{&W4IXw=%CshHgSFgjEe8s$$fYa#vel6EmNS=% ziOh~TaT9aa9OAWoS*60It106kY%NYK!9esWH#S-m%06nWp|5D;cd(GQu8P(_9ikqr zSvT{elTYs9Fx$wvUvZ^ky4>WjFC1_VzEj#`LD0RigN};Kq mA zNe#Y)?xXUY<&&1=DR;@pJM^*>n@sBfAh+_Xp-@YG46q1_w(Te}_KwDabj`q;{q5PC zzf6}swsH}&k>z%Q=*alqQccUCz7U9g@}77G45$(=4OL!?#-7bTM=Gvg4ESb0h&JaH zZ3cd#E1@=+c~wZX DFP^C-6Po*jew|hLH&pm!Oa8%FW;e3|O-a^K5UZFJ^`l!=G1ln;Sg|1){>0yN& zaap_;+ulwC?Gl7Vx^d%ISR3r&$h8#O;0JI#C<7dL=yAt|!-h&XSG>3d(0dKxMghFI zR@E(`7zPb)!x<%Y&RB_Y+cjTb|I5%L#)a=o?pw@SV_Z<7_E(n5(+q-V4$idV_|nl9 z!sh Q4r+j#X$%>tc)33Xn02vqb`7wR^f)tuU76rUd zI~;BX +ISzc0)1>tFb6 zRTVV?NcIID^^AP#)AwqEsT}$nO8x5@<7C^&nY0eM`57p)cK411dG@V&qwM@IdI|NZ zb{SgVHR0o>_vl3kC6xjC+XeU0Rd>JtivxVXH`IUrXY2h2^Y3!UzbWv=P3=sb{&0Z* z&K@P2&>lGIu6*i=Jzmu`nzz!eMscXaskW1LHpiCQWU(gWZfdFV9}+gdF)ydA#J4sx zCMKlNYCV(DETq?)O9VVpkSr{*pa@5Yc33R4*eDh7LeSoV`IIdn1Hjg1$Y$=hJ!^{x zUF&~cUv+$c9&dP0^B!-6@!j{!^U8^I1usewKj<*~mW9O5xFbL0)hvii7u@kgUKhOZ zMSct2Zd2$9+ybL~&r9Jx{DSmC{B>89rga+jKwJy8SBVghMZnq`N!9?eSW-?#z*=M> z*n+BrT})E!CNWOnDsUFujH85JTt!gxqZw(AN}`IeCSU>9lD612-itsN){?gvHXcO+ zoA6Pn6Ksx5Vp(Vn#uB=iPePl}HmJEr^#K}H6iO6p(3Qe1e@K6hVe zV};BPiJg3aw#KM!1z6V`*@%Gf3DRmJ8V>qwEd5Dkjq<22PtJUzf^u_ HB? 2Ds!I#qtYn3C$pp@#E*2QCFPxkx>nVZ5h%%9aWQ}E6jCZSLUXzK800d8_N4W~ za*3@SyDdM=_b9nraRIl4Uc12-Ci<5$*>Q4q?lP5Vnzxk`4R4emOlx!{mg!Qhmj<+7 zF_0iT>SVPJ$l$~{UbZIedBu ej`GiM`FCkp2?oIT8pTP;spttCe8M 0EYv=R(3jXrG&@)nt11Pil$Nrbn>TfBQfkL0BKi zb`^K@PJkVRzY{B-?yJHd8;=n }<}%8AD@If{qoZ{qD^P)TBI0mfX}PdQIRDy6@RKv0Fa&a(};rjIL_a zkH~aeXuUj AmbPSWQV&oV7nQ?TF9L|S5dOUyP( zj{BX!3D1`<0!0@J#jT )Ubp&y14+t?qoiqm!M5e2Ez2dz3T{%0+j z!ok%SZISbsyQOFrX#~r*&(4j9+q((GG@J;Nm%w;xsxabAH aH0J;bAlHeWOmeGOj=KdQoL9-zzB8K8gyFm5LZ1 z?4e1dpW#99EjXTW{4TUOBPcx1Rue)xHI^0U$gth4v1qNCguM`tAX%QyfyJ52?h7|7 zN$&5)c8tq5lf^#8rLk|%oh)@xk8lsRrBVsm6~hZA$yK^yp=PRWDKw@6wH1paZLMw# zG1KhW09u{V^J(-ZE!IZ%xn9R$`5dw7U#0ebz*iFh&cme!8dJicBq=30)L zxZ7;GQy ie~9{V@9iON;-AzfYeF?KHagS^-9gWq@i z7QcxaSrmUjL@FlfMU~ hra%nL%h`f!bKn GIcxMP&S*6 zImB^yUQQ=kQ+WqoP9|F4Kx )i~>Lz9}l>9jh$XRhdGPd{*wMz7H8Me(k7*-S?&<7EQn@H8}C? z({c!+=`8nUKRb)px^NO~b+f{s1ME#MiI>9Ta lGH^Cr1MW!mN#N@w5F{cJH# zzbRusnVmoO-G2Ps?F)H$CD7Mh>Eqm9>L|kGbw^tFOh)Q71g#TI;r69rt%lM%z$8c| z (j(+i|dY=eQyhV+Z}ly7_5r3bSSuO-M$vov+f2!-HWR`vmnyUnT(F~ zkz7Vy;fYs1^iZ0NIG-?;SBHX%8PpwTF}Q}^Yo!xy{-8J>26r4- uQ;-nI6 z?l5TmFumQ|6o`3>=yLz!BUR1mBC3-zb)y(}Kl7VU6e=+FYS7{qVX^HoIKNad1D~5o zOp{-WQufYJB5MG(nYy2hGIz!X*cIQVZ|(*bEKc@kz}%nrsuCUVg*nkrJ@z$J9!k+= zrFpbuy$4}Q$@c~ZjQ1alH1~bx3r_H9huqVwQ56`~gtz9G$UeoK;|WCIx%udv%h#r= zTMOFc6OlQKJzZ|z3@0eLkRGmR-jdi4b|v2RrY|nVzjpwobNLQ)__P^tw~P>bB;T~( zxCN7oX>yLng&(L8@mi8tq>mFH=uoajZvj#8g>Dg1^aXCYxN=bH5Za)W>PEaIy+~uo z2fm8iWnst$<2mAs*=IeJaDr9x=OG!hQNjjxi#dqwWalU!oVlfmf+}OqAc~QSi{iJS zEK%mx31S30!RM$6dvNDCiopqF1>QJ{jpOk`U2x_^CCCYQ!A?nv$q6 }Pw2_k zWigDn2&c$SHG8#BL&smdgpv~rX(mWw<}mEnW{u}h4w`dK(=H?PZ>2geLX@1h*rap8 z;ht!H3f8;^6B>PblNiJD{Hapl*_aOG8=miFcSUZ1x|^;SQrs6uvB<2pb=h`#wVNE` zB=#YPX}Fzex;`Lr&3_$F%vy1D2jKt4)tTvh=?3@g&z`xiH9%hpG9>Fj#+*XFn`G@> zjP|h=>o51YNP#c2SfSr$OKWhU`6^wDEnVr70bdrk!c*%6BKcxb0tS;u89#Kek}s=2 zaB!$k&KZP@&~5PYnCeH**x?9`fDu2Y{e_jC!H{+Pk^!#9ui~wy86im9$XlDTy|n7* zrZ?;K4!zue9JaSH(A~DOZcbCoDA@Km>7UdiRMw~0toP*T(HkVQGOiV;;LHexz5M6k zq~STVUNS-U9lgUcEO|09vBH}c*TsxyPfQX=|3Uzb>fB|r*K>WT#WyN+H87?sVwyKr z1~Sc@zLHVKxVrjyxTPuVE*-7AxGwiQtRg7$+dK@7PtXIQ6d7K31J08L`m0zJ`xGK3 zKEJ3rpfdqKq8xA?$rzcYZg1N-8i!vN7B0u(gk*DfCMWvF?7$gi)bftA&go?F0V`~3 zMz>4?*gJ7`HNHo#5!=^oiV*jLCtO*EW !R94^B^n_z2Fqzi7= zaRjshXb%S2v+LMNE_1i#E{Js&yszNi;2UKHJ^i+m%S!)x23x>~IGlfSfIS4QhV(01 zm>+sCOV9@zc^k{B`ttes_nT+EUx224RsWl4y&q(?zS$D5tHv*&rMkdJ>j^J!+@-pp zN4WZ}(Q0?yA-d hcAu;Saf_p8mMVkZ+~w54xlu^vE6!nSImo z;eF(*uoQ8%@ au-_`Z;Bs8le1NEh6%ip}6FZP9VG}dZDj~y1as13m$F2;W zR>kT5s6@RfK+S1LmEGK$B*^Y0w>GUw*01;N+P5hj8}SwJh3Fqv<_|Tr&M~ourFocW z3$Oexs+GF>#nPf%2zOP>+`n>HR&LDgSGAy8QYF{e-WR4OVL_U&if;MXlMK>XDP;}d zDz4z3vIJxmoj*iX1H6DN$gA3kHS-3crC$R3BN;-evKdjq9^_H&6iXnB$U-@#7POf& zkWJkZI{zocS=F4Hz&eqIc1kPoSzP`XRmBe_#N 0h)T-q_!*ch>~pWUuZP-YIa=I)y>q6a75B!g {vY!rCRJnsbTwyR~KJLK0ffyif^NHpMW-m z`4NP^ocSf|?MV~ee#(Vg&XVXfi0B|p?$H*CZV)H#Z5HZokaG=w8g-OMqV731DDjZ0 zMNCI6?ok`XykwrBO^3JatsCWd=;>_E4D|Tu;sKffy!6h}=oR`O%|hPtxZb|x?gG5B z4=vB1p<9Xu{+w+&;cs1F? NIUQUQ|c^6LhR1m|3=~7{HZJP5>OZdQN>T+Rv zqs94w QT^8`!vB}fmBfUZnVC67{=h0?_D;5jF8_V*ISP|j{R}Wak11Vj z3fi$l8W6$Wi|Uof8+m_ZQi$dtgKNW?5?=GMLrV9#Wy&GFeHBB^%kv FEB-pIKS~BK-n?Cw{Pd;5Ceq zI-#)|FK+5_q_G+EXuW lja73T({&z!3=w-qo^N_oXiJiot`dPypz2j? z!dNvV{Mrn(DTy#oZaf}6^z2ok=n3SR!M7M|!;82fH}w|YzFBF7HA>DXu%2Wq71`jI zRZ;mT*k7kO@WhnhD1V;BX8gk>`DY8m{jtBPlg%F*742UO>_7ak51ju^+SSF<=6|fq z8g*OweGY`Lsk-{k>Vt5BfRuJsL+Sz`eYG|125LSXRZ%iW%UA?(a^2SDbN^qrFQik@ zmyMlL&7&T<=DC>b#?CJ!iKauRUb^)!3A{J-7ZLVsvyD &~k! zf>M&1{LNr^1fdj_Xe}*%78=kQU*U-=aB=UG i5 zmgkani{h@q9fAdShv4pR!QEYhTY|g0yIXK~_u%dxTmt7Ky?S-`|M$v%*16dG;=QbT zs^&XuT8%j>7x*EuN`iY+u-&71KL!Gr0~ckxu#@G8mXHoMBew3Edid$AbzM>#>oH4} za`yAi=XO6qX@tTx4<)gLx#w*QwIsI}Ah#7g{Jm3Ezb%PrdEl=$@ZY0VMWifEkVhoC z%a-3S>0hG`Q0ez9y?hG}E-R#~%9b-RAkD!ol^(G>#E-Z`y+dP caoa;a#puwd32+_g6b@};|GPKnU)v`o 4z$E#<5Y=t(mKBGGj4i?RRvKsl?fB9IJNd!AB;z)=!FT)BrAwjB2s7L^WvfJ z{uO@Z&3@F1RaX0Y{cAO%56fYoxo@!mc9?b^-tD=DUk4l9ZMgJg*6h^owP$>*ZVWkL z%^Jf&_S|>DFB$_u5&J*Nv4N((uEV&`o?IV|F5>ZPYUPSfrpA=1QYfgq%oL=PIaJ9f zY=fkZJ6?YxHxcE%QWkrmE}0HI4+FBxxNu8(+C8cIlH&du>43;%JVAXoM=w_KsQ{Pf z2O5}o-CeNqu2Yi}SZSn@WP8_3dBzbLvk4Zx@2b$nQn-rcgmuWfeY1YiBdRamIp6!) za~8H3ND_s88_AR4RroL>)Z;@u@)WMtij#3f^>z8#o{hra=SHg|v@okTi!AC#U&t@? zm152pIe}0rPM&>Vy4>)A3j(dI){&$zTyEUKiYy%j&(Ijk?GR3xIRrXVKoD?=?5tAJ z5`%zYPjZt@X=7475)ig=gUEmEQZClGSyZWom^WHR)sX#WuHLUKE_TJPNroG+KGQ{< z$T1PrHtf3Y!e?2x_geMI}V@l;Hec__7A*Lpq&vY3)-;6j^kNc*L~dixsr`4EFWZh4Ey@U zIt(c5KAHu83EHN@8aKSjpUVxK85w1G?GHTaq=HlUF*ZkjU<)W6Y}?+r%k1@ni72P= zGF +HGz60oEoa_J||2@TRZQ@@=I^UQl0H5$1;R>a~$>xl9_<0)}x z1{@d~<)-B|5uS?(a;N9;p)xuxtt}PziCgy@=aW`RX{1%jak`T8il*c8jB$9~YcVM9 z5>Sgc-;xv8X=?3yezRGjr$bw8iOdu4o9PrHd|9XkT!1G7cqjhabmIRn FzMG(awNLZWy7v#qH4u<*p?jB&hx>yH=T*%gbm^OyLx%w2jP zFyD0DNnC^STav>cMZ!gu5ylZR(`q-sTNagRByb^kP@XGUW9HQq`(s|~P>ho|-6xNx zS-P|_!=0BQkT0}AqiWT)`)zF`pSU|m-L7-+th}c;rp>RRd&EN*+NVk%Y7Q&zR-TbV z$c$T^ 0Qmm;cLVeRh~H4}Z$)o!L{@KOtN>_COB#JZ #8?GV4>lAHvs Ta$^S8E1KNa_}w&7vN|X)$`n3kD()vRqlPUFR1;wsiu?hs zwWH=i>*R?0lUag7VEbTab2b(`HM6b }@_Z(606Q42)bg9hAmU@fL2URw;Y5iT=@${?_= zj~`q$4?ZL6q3m&Su$c#D#GU6H=96&8+&9+TDCi{W Yw2glQOv^&*_byV}k^if4xC6a9}}Wg1$Rl0~~mI jG07bE>YY=Ki0mjx&TQo!d|nCcBOq|BN8C`&j5JH2jX zt|;1ryt#C~NI@#n%Z|tshiJ${XWpP>z5B-*uG@%UOE{1-bV*%IrCHW%5DC`CyDIIm zZy{aZ+ewm3tyv7hW`Y?X`yibmrRFx^sPGLZE0&~fz!fae^F)CK#|@4RSs5NyNkCbL zxuL%KI(#{^zb^_Ed=$-$(iew`EUeaO2g8 >+D#rVgQgeosv4Wd%AmC zunnx@CP{f-Vlrx7?mb+}F&N=Vt_{2p4UT7{>*f)sb-P} 7zZss115R0FseN8U1e1dj2 zaI}5xqalW~aqzTlm})uy0U{0lgAyp43sHQoc0<&HZiVlXD=+g~5b jnh3mo;G %M4T;^a)PG0E-5J9IjlQ& z%04oTfPXYwQ^~fH6T5GR2JxApW7gIv6T)+ZBWS@CW;kd)%pO4bWbr W5Rg~gI=cid+8LN- zg4P~AD8}*qajZQR! @)y~FaBB?--q=eU0a zAr3Z9_6A0OYGl6hh&4bXxkYvO+4+b-gPanVKgCFXhJs-}sD_}LVgL;$8H^A0(d}rH zl&I5=*q;43IBT29Bssj)5`rOxd8>Sq=MY@qSWm5Plol!}6st)aQbK{HuBNFpi^*@X zx8mM`dE&{M)#Tca^B#&p12KDD0edhmA;ipeb?f6uoOi{YM4QRIe%^P=68M>Nw`oi% zaX+h!$gs<~SF7<9U8mi7Q68IHQ3u`h)#zN&oz4#$RgghxrZAsic4&~1$>+N>h=r&* zjZD&GkgMH3x=SYpOGCZT-vGBDZrNUa*wlu}`b59Vzs^$0aRK_-UHL%Grrb&}itfNt zvLRO*oY!oQaF11M(sIxAv=RlA>>io gJku=+P4t?V|3#7S!zfDXlixy09TJ{k?zB~Ut|Q(yXVn< zunF0|ctu;`Zl+v2;n~uCQrwHdHd!HG0b8e;;wp4lPy#}&28T(ll2x@EtNSia7S;I_ zOud++4V=)#>#vbj+n~2B9Z$e^i5@gH_jVDIk*~j+9qQP#o^b%$Ir-aW2LMnC$kx=B z#=*_X*v8uJZ`n(N|1tKLmg>AYyFYa_T)x`68(=lB(8!<>j3z^PG#+lGTvn!<@1c z!ouxMFsWa;Oa@3NX;*$+(@sp#O)OEq|0-|dc=VNmr5ZT7!U|RZ) +1AN zv70nACEydG@@tGq BLj=*@NOqqN7`;{mXO zkWf7#5s}`2)%F3tzqX1*f3Y8aTU$vZdut<0TEK2S ={Rc$+M}F8*j)_p;21l_eAQuy*CPM{mTQXC`X)5sG!h1ez$-=(>vGI_G zQbnHDh(>Jp4uj^4ch!-tRJQ?lv6u-jJ~4*7 3v1eiOE?iL|qAT7tb|>&NnZwp&|n&PUPxRAARSwsPSnj`A5*JRv`;F@66p |CYwTotj^R0Q4M2*8jRR7?U3{@8N@MeWC*6Aqk4{;5#6?o>tKK zWRLiv0h?~IZ0w_$-*@jyOB+T18Og)!X6lr9V-W=$XN`C{b4P@vr^c%5>~V&V=ED7; z={(89U3&pfJd1tJ%7 EWp1^9oi=hY382e246b|b6Q(q?jK-pj=2i}WT z!x*UvQn2t6A|Th~K;--g!I5Heiy?XVYEIeCO)=W-$wVdtimIlgZaO!YMf~HcQJf?l zd13 yC%!z&`=x$WzwaLGgA!POtmTado=_WB0o#7hf;;66RC?mvx3Sml4b z_l1?}wF^bc&%D^ICCBF*RKawUr1TxdL<50meNB5r8W87_r#aaPX3)9E0yCm^&F97B zR%q}+O^$-2r!dJ9P&gbLWW4xPGgCSvY?{NX7^NC?Yynb=Wc=>ak6>HZdbOQ4wmcx{ zkJBFvVjEE(uj3_PC3rl0&9Me}@^Q78FK}VCJ(?ov(}%!~@?vZT@@i(~577A*1pL-T zalY={W8?(Opa*62FYFb+lTn8*TL}rwrG|1*Bl`X=?R|%4#El0;kQl`43ACVNWAV36 z-&A4`2o7y|UPCAcbrhqh+?_!uE<~pj_|nIAQS|kmkp!&_nP4Mcc%5QBISRYQI+*R8 zk0PXz5STrbVe+0~@@V}RVB8IucBTBr>&>0jAvF$S=WJPNgcIefuQgJyOzIj;J+4`* zC+BHyyz4H&R)iH^Bcqp)?nV-0@oR{#YPSWO?U#EFUv0H{%X+*?mrmV~>ejLKK=aI$ z&e6ltW$7&{LdeH2kM3rpIo2G-lfgf^9wdxFqtWTuuD37lrbp6#&Q*-K3dI*Lv`{3n z;X%5!Z@mLX9PX69g ?%`ERhuKby+0BDDB^8NDJSF|B+B~34} zbCnRg(smpc(WK*JqaN(-w@5!Et%{Cm`s;g#X*H@y&m+6wb(^TcU2{yEeXw?&J3)2- zw2A^o0S%s*7ad}Z*vehU_`Hj=Dtk5DTUwD#dh40&a?}X4_cH27S*ui2Vjg5cRg7>g z;EghY%Tn+I6(Y2A@S}%*L#NrT2{P8zGoDDam>S>6Q7FXet~fz0LOvq)s!$kd4D61s ztyN;eh8W!V-9QlFbQD57vs AI2t;i_0a;rh7)2UN-UQIxoI$?V|9;b0wpo@T` z5euku{IwlI`{(hn)ibcrGx=92U9UJI(?gHcx=*FD2?BZKha~U;UO+etpAQZ7tfE%B zoU_5Gr4DI#-EQk62u&m`huc7GI@ag(Pc*Q=m8R6HH5i$W%?w$Fl-rEweG|FM+oAWA z;W0!;Oew^!4Rvj ZoQhNg2lOQuS zc^V6)C4R@7K#zX8j?jxpAiRPja0}y~B|yQ!2yo2TIzxeT1zf#13ZQg2oriyPg0d|` zD5J&0AEKzllP+$qW(x`88CPvs!^py>?3-p)GLFi3>zz$Kd=oeCS!0; )l*}dLl30z~n{%U8y+_@A^n3?ImJd+nTdkq-lK&`Z-$aY3>65j79i} zmlZRSJ=c653;1d9ecXh?5T5tIiQelJgs(f(G0v!mhfLocV`<@PEBDL0kmh6T$agjF z%VyWV9AV9fPg(@P3Bvz2w|cw8{N*Fwf=(S9Cr2ZD9YdRcRq+*7iYjEr#i?n>B}b*p z%XhaFR8(xosK$1;N-9)jMuzWTl41;Uz~Yq-iS3!9(&vNPFIe`ry*i1O^ t$zT0Y2XD@~ryaebj7AeK&uRbO5j62r)qqDe zJacH6=-w8}|48)Ltwb(G^Y;nB) 2Ur-H~>V25#ZndtG>4SY1Ltw^_};fj_+f3 z_8xOu!`)u*{3n$Cqg1K1erKCKPETEu!96_T5)xCRVXYcYNx-hdfP-XkpgcnQ`?k7gh-*jze42G~FFDaeJ3P_`*xa3Jj+b16YqdzRs*G zPYry~I=hx`2(jLVw_5wscuh4!h$!D49-DO9O_1xS5kl9&n1Vj&x4VfK8oNMFZdRAw z$Eu<5;~CET1!Z+6Qm$_O%j1hx0;4HLNK^s4+eaeXKDneqc>x&oYFF_DaV69p#W+wF zZVFdYd9+F^d|r{Tk|mCC74?*p!MT LIjPvvWu2V7ynt8lHZNjpI=?xDNBGFblvR!gDQ`NnE+3W`7XVk? zFdQj!C1;S7ilZyrOu6c6-!a4RCPCeR_&Bsb?;H_*&{v&&(~-Vg$If)c?93I8%M zm%&~SpTB13mH;wHe@I0xqh5)by_bxFtGU9^nY~=r11^tvF}M?j*&$SQk{>-V@2+EV zeyJLJ7b%GUyq}Gb;3nGs1!u>K<)X~Bk;uz^Zhw;k|NX}iHe^^Cd0{&lRpnZfow+NQ zCsjTnRy$u-FG{skmZabXk|-^dbn f(kG|zIfhxaiDpe* zXW* Wkm98qx-%tH&d1B@-5hcRC)=Je4ufiH{eGyP9NAQ+Un_i0 zS<{~BUMT#^<5*K4C=pUFLC51Z-P`8&2pt4vYfDZq(gdkpNI}KFm{`jh^rI&*g!^@H zi 7~=E~Ku8xH z#N1+(FVJ-4fR3n5BWWG8c2)IPcYXMbMcOy#3DapqRENsn19yahFbqr*!Gyqc>_6iI z6-6Y1g=*7DXRh>e*ZADN0wmD5P9bfteYy8Jnh0wgBW9#hQ>=_Abyy(`X(N~SM0S7P z3)7%IN=AN2oN{=?^T}{W#w7!Gxr~&cd_`BcecbasWKVo7Y~5-pi>onkjEg(%QdV9Z zvDk!Ccw;xI?U$xf8Z9P!>M1dkH8V#Hl(k#a_1G>K0UE7`4YdeYXQl{JV)>)4xuUL{ z3`UL`frBlBRQw}){iU3|FE-!Gx_bz4V@-|tAi060@Qm5t_xYFjLO>JIRLT-#PoK&Z z;B?6`JBkT28pJ&M-fQ-?Qz(#I G_4)`vXT_;(2b|nHtRCB )$=LH;~JaVw8cXP@Z^Orz }Nx?sw zDF@HpEjc3V3|X5ma)%&Yw?cbx>0WoKP{%aXb^WO$xgrG`d_2-9t+OmYcPeX&G#J;5 zQl0RL&ag}Xd0gi{a+0;LCdzxL2JEX%PW=Hk9n`}_K_7b&2JxUvSjw#2WNLHglJRjM zK_{qdhIk~Y*L5f|kWs3?Jyf?o9N75i(T?r8U<; ;rdq{ee<+#6F=9a2(@~dDRk^%)9UI874ZU z9m5u(r7%Z~h>5`kQwVziqa!Pz0wwbxvO|I4QxuznXx9Z+m)vr#ds*`M!pp)qEfcor zgWIzTpPtf`nX}a;6v%~<5ZUi$|JC(Kt1VEo(y_YY`mn1hhU`myF2XMI&5p7B@ffVq zVMpMx&lMxE*Z`jMQG78@N+yhAk@0(GP|FXZpWvl~C|T}x&B`U%AwyKbcnPUGf)kP3 z3I);hoEf=Mtm##`8=C8nz7+U7Nmlkj^=)}fkup{` tWi2aOk_4)Gtx^ zijksH1}Kc(e`w$)VVYO~bDEP08L4L=)d#g@Hz`7dHPB$naFysY(j1T`At2rU92F7P zx8EnGHK8czFeU|O-iJF#U_LOEp^|`@H|>Tphp@N1%y;-BG5awCPVw7@kSWA>xrlGu zELbJaHeY4X(m?w}lb=1czbLx4ZIoI#x!YDm59ys23AzcvH>uBZUV$j5*lcocv_4~r zYn?Hw-J#^bu%*FG1mKLKx%8qd#!DhhS3 t7ejl>5EGzs3 -OD zx|yi;nC6}12d5$W2x1nZI9FU-@>?jcCTzrNO^R6*4V+-`Rrn(Vvd1UoFKKNZ&vWp* zuHm*$`0#7tAA?Mk4)hZ0&D*--yVNcLNav)m$Frlsl~&%7c^Uxxp`yE3UNg&pUC2ot zYxd|zzmkgF7akwu&O;hqkQ>%oYOc~s5(m034m1|?1itGl+F-3Q_ZsZvjrL=;7CfK& zQdepnz4W*nsi`f?#OoK#Z(B5gZL}W9npdf#OYtiS%n-0vV+|gPQ-P}?6h@Al4Hu3l z Y*}D2@-lzk)$pn~X$syuX<~2&bc~{jrzd}PHwMqSZYfnZ zNaxG|;*yUAYgSjZ&%eD@79G_#GSo@u^UNuaOGLI=NOpGpyoy*q|G<+fyq`4do)eJ| zNL4V|3yH`qJ~nwh*>cMRaZ0?4&CB&|ARdJP!VQSA@! h}5Pjj0#Wa507XJq1^? zwYaDP?ErDQvo6 Bnl=?tV%6QUOBz#ire_+d z&*imjS}JaNDD?nKS%V02qr7fW&ptT}PsmEy?+ z!}Wo5^NVuu*c7Zn_`(P6TOf@@Mp}enRZ_S-Vgnzt>vrS1k!4{Au%k7C@a?Lfz4iJ* z1L0^2j+>AvYqgN}{O!lQ? bi qBmNlB_7cGF1ZCYv6H=ns4!W{d~SvTa;@bRBV!#}K7 3K$02-_SXyS(`4Xzg z3C>N81>&o}#5E26u)=CE@u;EZQ|v3qTM{4KK#5fiz&L~|{Vtt)tAzhEoieiqv}^xD zG{1%aN^Z9QO6h;$su8HAX-fV;HiIh`lNJjT#e)~S>n0zWdn&Qa5lRCGlVYje_>gpJ zL@D_=x#p1- 3CdTKiUYa0D#P!2m!A>PQ2?>pEHL+5gSE=?{N3iJq+)Euh-xWcjbHEC1sX zK;(|2&nL7*%-v@T_>(J$9YdWW^iCuR8qv;~jCp`F13gpg-6h4gmY6L>n2&ZBZkn&m zZR^4zM0P`fCk?h>?owaa;6vy2*mwmh11FB6bW4lb6xc!s`Pd`7Gs^== -V!~RhO{r7r6e9RxHK5lRYTIoEJiOFJ~lS$f? z0<9b+fv)&TF =rt4nEkY|OF9gBCqPsT3`3OrNB&Z?A zCCvOTcHjg{`TWf5-J a$3#|N4^ZvVJVWp7qkVWHTCqfu&4%4 z-JhDhY?n3)6lKTF!pd_K$GhgW{auU|k7ho|1ERUR+R2POerehziDTOY7Rl(OVV|fN znoH4(4+{8Ya+V+R({m4=f1zDcOatAh0e>m e>OK*MU9#F(!&Lu zd% =igtwY7yAu!Yfu@MJoF%xY=Ua_l(R%>h)Je6Rcv;ZYm|B9bIm zqrg6<6e7tI )0ht^*I~h96-R)PXb$SHSk|Gu%F2p29FKal`Fqf zjxj%KdO2_5lBh8xr)n4{c-M{_Il %JOg=3Zv0+dUh| zxmka6hD~#O3)XkTSZCX0FPY9q=^tsI4Ww$g=SZ!EIru@NOMrA(tkBrD1Ef*OmdQOT zG?39Y&jiNBCRK7@Vfp+9JzLZGZk2C<=h%po5q`vOV^=c@X9^<+)PDr!zAQ{w%u{#g z{3jf+^9G}+a`d3Db^iQuixIn`4Y$mv76b#M^e{!0OG?;WtkFpjPAv_GFmGKv70@+9RqbVy_lJgmqv+7_VItb^}qlatW!1+Xd1rh+De5UelUhCx%8jjfj6b89-~ zO!-jVP{4+VC~sM+etoXjcJu~L9^EKBo0w2PA>p5t?`7+bq;L3&v49g5M3J*8O(e7T z?02{pOIM$d(cj1R9Q37X8Vih(V!RuU9}MBAp0#6|Bs4?1%&CIX8PK)we&ju9N^otp z@}6N((B2hQym^L;oxreA>{<9O%)3C>G>BMI`aal#3!kM<(^EoaGK6xMuf=1=*e?WN zGw6K*0=e5tIQvb*>lu@7YeMZUw4Mx+BD%0iH_`U$M|Ba@F&W#BxDsLM_B~(V^`%tJ zzTcFzEK$3z)#iUH)to-b3~#*PGqWv>%~sC%=-8PSJrG#fYi3uaPmt9CQXWnD @x!Ki SglXG*Qn@shHjiPp z_=O*%`$rdGxu0t<4MzOOxtZrL P29ALq5HUA 7La75dDAt9bC725Lw(hX`e zZ3ffbYa1EE9d)7C!V^2AV{k@UuGd2=O7vv1&w`E*!nX!J+PimflkfHXy1FD-Rk_B= zkr_9fYysmuXdho4A*eZ`M902q^->EA7c+1UGsHX=45qG9NyvyVUImGF_iRM;pcgG+ zl*X)qeIw^9#ZHn~qoF(e5$ycKS4B2nBv$Aj?(sjmRke#) V#M8@+n?5hiRD3 zI^)r$7dMT*zta}M(wZCH-{B~#m3$-X$^XW`?1$E!tei<*rH(7<9|?DFfeItm+Tb4p z(Kbzj&s!ZxLD?s@wRm)ThW_cDjZwy?#P^lma{2lSfvt#D7um0E&xL|HYN+Gluhby1c5!vkL-QD=jEhAEzbnC2DMePw zRH+ZpvxN-rm A*syQB JE2ng2rX3jqo;hlBbiry zEu+Hh6uZZ2)^*1Ed~(HFF*IyA3fV^SRE{l!#hhH`#-CAC42Tn+lEib?*zH&x&znCA zKjOm5wR|CdleM9@aqTKvbj6$Rk(RxulE57DaysdY6eJ?D)E8d366mm#z15Ii7T~&c z9y(R|u#;FQh`BOZzBBV7tieL1O?@98L%%j>{IZ*vDYTa4pV0_l*__iU@;xFtv2eW* zlFv!}H)?zDEH8%|ucX#R^Is;3opLMMr;5;N VFJJZ1Qd+zLFGNz!2yf@|R61e0kBHLr)QZo60tV=3FJY+o>H+!NinGo;e| z9ko7$wgm6fTvj@SwPaZlt6a_!vQp&LJDfZ0&&eyd90;(f79ahv_Lvikc{*Ozj2`5D zE_K@`(|3oA9oBH<;C7iR^dB%eabqkpY(C&WJvph&BHAoNSMNKY9OBoyQi853hroDh zA{t FFq%E=ibFeUJ_x}*9&654vPtxsFDj C^6_*OJsC7X|(9_V2A`D&hU_zOK?cJ zN}{+-S0ptnq$W`B5|yH1OGO}3{X}CV D zQlw#e!qT)T#R-&EK=;0LGPxm5_p>;vE2EXIUx;KrBPiyL<2XIshF_w7JPEZ bFkuEaY$BfWRI?+8ruX+}s<-uZ`kan}EI6w_8LApMCl+zwS~q zK=)W6aYWYH2JIJ6vMwq0q_$DG+N&|B)oe-Zbw2oAn8UQwkXT7c#7fOd=5H-q#xL6_ zl|=dzX7#8h7&4F}A|ftg(^8R!ej;=Hs8dD=>+!Mh{g7dWX+o${ml^gE<8lUN^u HQn8-d`1= 1=#FsIl>?C3R%8p1&PDRCcMt%+G9yLoux;E~HM58lEE_wj`kd)sc=YsVt=h(eTjG z>O{XCZ0C#`-8Ptp+{Zcf9&f^2xgUd#2W;8I$FUc+^zl&EQ+I-^5p6nQcAwh%$%<|Z zwjpFLlUh5wbUvZ~2S_SU)$DxjY{GkMMUny?PEXKrV=fbd`2AO%+poh51HJg0s4srQ zAF2!4?OT0Au>xK)yS}qxojk2jcC@*SYg1K!A*&>Hwii3ZD6GK1?}{25HDAnbXyb!k z5S+mBjzfzhz=2)rEDXA-3Ajb}Gl>2uU)bNQ)5eT9GtswxNdB1ogEhj5X`e;6!c`j( z)FZFZfPa(DmD-vOC!za54b@E5qp3Dirf|{}eZC@$K~M1&t`<5l)ULUd0{jQIOXS^Y z(MNdth6?ABIgvazzGHVi@VV5&4_+A61*e5UN*((AekrnYn7i+hzs0iEaHV8~v2LbI zdkC-O+jX!pmrbAkEHKx_^qGNo6jO1NEpevL|MJw;YX(Vc^O)($uR5!i$fOLUaK3%E zWEqViEkveuHe8N!A5@26O=nUwfkZZooBn9#Ipf=SHevar1r^znPP|~g&RQdqQRAH3 zBt6= ~=#PZ>V{?gO)DJ)>jKrnrz z3V6;A)~$#Fmadu|>a@Aa_u3r|^JPSzI>tDNVuvV3Z9SkQjAzWKOlS6>M7^nDSZ>}C z4A} 76HWn% zSxED)xqdSm8Z^k 8>6%-mF zDf?`8zK?#GFOiMYknp^Q8S1T--oDl7>)J2Ck{}N9xln Q^MV9>|c z9A#1QY-J~ov3k7HYm;`-o<=E^e>AH&v=T_X+J#S*H}30DbVcjNea?|Y&Zs^%>cX3q z5xZTXY6u?|j^bs`a4_IQQ|u2!5Uhrs& CrIm*q5VxW1+`Sj->E>zuM@)j?2_ V!VTm$cN3BD>FFWXTCd&dFvOh1zowD?ikzh9l!9nD&a(5w*ZNw=WkmV-uiSL z4D>AZXe{+iY^?tObaqq!_bK$9%q$K6?b+@>)sISsa_WyaylYt|nV9F9nE&Xm%b!wk zddp_tpm=|cZvZ^K2qdBBtS6!8s-XC{Ab#ZkF;c?DQ16W-K*`L?NY38I*$hCI@aH1K zm82b(=uum*sMdB2WtnW2m;#8T+4E+S-w~cx6Oa0bEY*}Cf|9zRXkIx|A;MzMt~%H$n&BY@v0nPN~Qu8&&X~7VasDaWf(%sPFRs%X(!aXAR5KD*E2PF zR4vNr>kE44FFWT?qwt7$5ilF)r9N%ko;a&OPDytkqojEpgl73gGhAZ3mb5;TzOTk> z;g(HfMKbwE09HomB`wh*dHVO^tEMK{&bYcz{+VT{G%Vw?b_5UkXYsNhGCrlin)~pC zsun9dl0iWLQ1a;HiuB7?E(>?x#3wG;HhH-N@fKSmz8J>x&DdC|9UmYU!r=U%#tOYj zGA~$uBd9O<--yuYR^F9;)1_d3>4eB+DWJ_S{c1Yf>n#(G 4hjIf8)CHz3}T37vTxbkoxk))sFv=J&r!hry1_ z7{#wNX}cvG#SUB=B#iz<6NGvpTg!xvA82IsnA!aWAn`Es*Cq!PtX2RP`LDH> 3PwWGPclRS#X){dC}wg~L5{GWdLSmIcPDIRw)LG-?k5GwcT5gG5dj=< z-9iEX08DY@4vK{W7XJH!IpzP}n!b^q^&gKfnAunh0=ggnv<&sJ06g#;1nMQE8nlbT z_XL(!-4R7hGW)Z?SYdS$4UVQ;-TT+I=$o%UOcm*xXTn69_q7)#!m-In8@6nH9zxX% zXe#X14TBYi&+%h|6_|7=(L~WOBvCEYJ6++>mX`q#h(q7#b+&k%Nr}p5SjDA@IGBP0 z=3K4;@p7!VW*9nnEHP(nxv!7d!Y_~^z$qm56~`<4Y^#X3OPMW@N3 C&rZ;^?jG z?Yo9nc4zYqk s^{Fn)Q>@ zPJhIjNx~#l#N_gdIh|P(qd$bv$o$aTTQxg6Fwx8WBEP0ZAUbjV3Eg<9Ln|_drxPJt zR}&0^ww;EG4Kvk++b&9HzaGotgk(d;3)n^UD=#!02`?8^?ei~olEiJH7%PAyWBBd) zdh;3o@(Pw_`u2MEW=4OnA@2>|_uu9)2SB}y+!+4WdHK)t{;&1?b1ne8y}6OW-|L8F z{y(hmpL70C*ZV&`?ljZJKib))4JMo3!o;^I;IB>B@5RFSx5UEr+buBC$r>92g4Mrv z%h4m&{%?oRqc1K#`n@;bjA)7DstAk%hB5{Uqa3zDk(F4=SMN$`F(_!yQ4q|h`|-AK zou+}%UDjWOIhWa-cy3#nsqBq5K&e(P>h~lZmM}jG1}-uuqEQH%Kl54^{Gil&2|@(^ zlqJP3k&MG^M*Gln>ENS?3L654*a357lgdo|f;*5hN{kI-WpO2qz|@xW=_|9JSl0aH zJ_4K?4?mW8t{yw~2{$5u1)gnl73)Cd9pgZT^eT6wIiyV^v2B0X_W`KptV)~7pFnuu zDJE60K`mtLOCJNUs(ofmf(2^5AlAT+i#C+{;@>M$LdVP}CM +PiM+asH|OSA7k z`Z0_Fr!N2h7(V{%#Jsf+8tFOwy{@je^3Q*n!bs2dZz A^czW#eZ;*wW+LH1A^-I2}L1W!BSdoAan3lmEvi& zDb7>-7;%~4Ws+OVFWqIWPZ6i=?7$6Y1#HotFYQ-XeXQh%u#0?UEH0%5$->Aq94Ih> zq$62sZqoK{lky3Jsx^x~Vq(e+!l*{^Qs`+FUkP_l0#=z8q0J0Td7RA`neh@dF+Iu) z)0;s($TVYSL(qpXDCbVpT1h }` z4pnor+gw7K(G)Gc(#+;lSbdWG2Cndv5PZyXp=vPWvSCK|K!TFrG+*QVkirITm>r7E zuK>EyS#-CC7In9`t}#$wKbE^Pxwn^(lF&Z$B4 aCpWJnEeEpu^#xss$c-c?@!mB)ojy~<8s+cxD51A<0`QbzMH)(tVhODKy%E?b zF4zwAoBSZ%s2f^bdN@A^XO%wk#57w|o5ynniJ`=9BtSnd#~a7g 6DS<>ZJ6R$=|>4g5`D}bFQ|qz z(Hu@@_s48Q5cxQGiHo{8Xfd)+qlAT$=>kJ(cD&|EFR?84Dd` lNcRmb4*x$q+V z2*_vmK(r2`VUoW6AcI pcd)x>O97wJ6pj|0O zz7G@p7pdf 3pDyq7&lxf4{^k(BY(hD}Q8hLFbYkBC4-#6N zG`sXN9NXVEi}!dE0()Xiw~9xhsY-E@oVH~&?JcQ+x_zv_6O1gz)NjgD9Cs})Fxq04 zenhJGK2CZX!avXn`DdhPX~s?Bwjju)@WY%>*XPTA*HHxC1|H7B@ub@DMq@RG^TgNJ zh%`oCK32#%&u@Z9X;{$eMo(HskitO|zvPR14R|LQVEuZ2i%EFH%lsD$X!_qM7>%OF z-kK=>Kla`!%F;Gl7mN%$GHlznZQHhO+qP|I*mgvQjSSmn$6sf6)vi-}SC7-9`{Imo zF4pB*-~8VBuE}RUGf0>CS1L*n4}b9%S2);BH!~%$0_I)eXv5WIiE!0JGw0n@9fZ7j zKMsE(Z$PMj+d4aA^dgXzz+y!}7*j|jD^14D@MJIn1@~6sO<6i?ZhbTlzWiNN5Rl~v z={?F!8!b4^NwvlpMdK7MrF*oh7>kSqEbWs^w>3na*i@~OYb2`5?$gg}fIv0jY6l=8 zwk|E1iBkrab%mzaoWHeiXeexmi@x8B{@>bu%K!S!`R&YQ9n4M5ZA8qizOhn&PoI+I z*S{k;XzwFRs+>GPpS(4qg?i_?5*5lfKWMGd6cY7>t)S pX(9$QXH6Oy^ z78LBFQ%cQoDEG_4`WOzh(B_!UG-Yji(5UnDge=8~waGN(Kc&+7L7JfkU>pi-IbhuO z{G0p@NX;OMkMnz@uRDaT`5sJxRSVVgdW1+T8Xt%nGvr`}j|AzO5IkW}&+Lt87@-$d zM={!Ut^xYMk=ofyV){%F6jB_Cia%m=Q9vxPXMkBH>e!5>&i8yYeSkj);jTPiV@gnp zFSojl+<_;C#$QX%sV5jQy$_!d9(Tg)fT}F)eUjY79W{)1nH&nTczKhWx2kKJWx@@A z3NQvJ$Vk(fkvwOp)OCYrxwJSm>70H1ZG5TgPEkhTTTSTyHd W%Ki>Dm#Qc}s{{DfcKVh$FIo di;i_v!4wED^L2Up0@xp2!{eqeT9166= zzzJfVDH300VTjIS9~odQyxT^Gb%V%Y?Ufc1(6z#@pPk1Y2~DkHS=eHfe$M;70bcXv zCe=#@59w4PZz&|ccy`yGZTgrBIl=)YGk2{c7H4|2%w{Wj5?}QgE2@LbvUeUyxoEYo z(~(UG{&{gg%hWK3y=W_hW(2*Gk&BE@g->7lp >PpE+QpY(;BKCy%7;U57`{5nvKf**Rid{E`H4Nrl(WO zd8poxO){)lSE$y>=`+kclM4aC2ETB9doNA?Z5Rqv*SLKVu$$y^V5SS3=ppCKACjyR z#okvJf2-QV_j{@cee0<6-|7hApLAsCW HJP% z-K}Fh9A;ilbE|$BapYtH;7maZYrwtN0TZiDfCG|ztxtML2Cqs)%S|J~cZ*teB=4Zr zk+45>KmzJjsM}{$O;azz0(_V>0s_zrYb5!xM5FbgR-HGQHbK}v4*(}NaflXtNCua< zs_p%lXdV5E 4E_3XXGAHQiUzSZPcaLPtP$`AJY>Xltv~!OgG{6DkauhYkC|C?m5Y=3nb+(;D6BVzDRy&&EAVegNiUh$t!iu}K z$H*kIR|@Oiv{)r#%YymKU1zss?*`b{{p*sDu10LIl_jVYsg M*x_4v(80WUy7ZF|Q3F*ejE`Bm1jqd!&^>13*4x zO3Xq+s RyUZfe@-_sk!xZ?hwnPuJC*55;rT6x2~u$`q!@o5XmGEr8AO(#Fq5F}tV% z;|bl+Nu8|`nPc>V!-XAF&M&8YyrF`SwY1-~BwXJM#cYEZ#)h5`h=Dzu&J8|`;?S;X z8DWi<@rQX-Ye9|<;IVndDD7J2mHbUq+NVTT*+J~6CQeA33kvAQBI)15?Zqr!&PUyg zQ{OI+^V0_y=ukH>U-S&sm&-tAnc^cvLeuvjFS8>K_@5?g6y?<}Pm``&^5QiT-w8pi zN)YXgaN8y_;M)PiMUatjv|5gj9l3yB8+=B41Yp}#&F;A0DfbPzb>y8ofrD&SA&1=f zA){3c$U(Pi8rX!PG9)W-ZiA$M6K8mZR{TiiZ=iArzB=BVBrmn2T-du0tR?2!;~eUq zFOsZv9iM~sXrXxXN7|q~%&+Iwx~WiZ!`^Er_SX?p$dS)!kO=?AU$i?r(fi+rOdcs= z2PvZ|;UH3vsho841*8g!WfU0@tIJ$O>ZdN6D3Va}e}gTr#F~D6XlVXXL@9#0ul-Gi zdZ&3zD68>@UOoe{T7At@w9q1$M`K=g<^7q&@5=}6BNe12`6Flz$6jF@fw8RGb0D?? z5=bEb GmA1Am>%v|;@Zn*PvKLq~> z6CcXV32MGcRsWt %MAe>tgU 2@F !VHw z{?c(V4;;>s;I#w_&1z )LHcEd6*g^f(~1=3kIc|-e?71oJ!Ceh^;u_Vl}asYN8)(JZ1D!;vW zPGIjCu*im=im>|39SDkco+PHQcV _Bb! z&GKk!Y(s5sYV)6ag2{=Tj^BuyAkWW;yRv#_$kmQ{G8q!#46cYIJU0S(e*hpqkNss+ zxFTWlymh^dbe99V4eoam#CJ$C#6Pv>KDRLMLP06u%&WC z3sMwZ39^sgNd7+@Y+gsz52SNTqRptY)O|({;J5zc!)HLDC&J`->tf^Zxyrn1TShON zkbok3H6jbwTWo&TV2u;5#WA~|6R}13zbk +*5P?7J)Tm%!5MdtvNC=d5Z%Nqh(2DMp{s1EKj zu3<#GI`tpRA>#W{BHvVpgL!E2_IX@+H`RPb9kp#&3@ecsqNCVYBJcBv=1%(_bmn_V z?R&MOOrf^?;A0Lki(#lIpLEW-3bcJ!+a933hvLcj1bsQg@f^D$X=s>D+(Y3V1mu(- zWiYSQ!#9eBlWic$Ww`7#OjS490tpsQZ{BLf5;)?vsbf{ArwtU+xlQp7)KXBdzTuJ< zjsmm%C4OA^E{*?X_ y6T{Xdexe-+_B?V}mI(f<4Ek19 zwyydHR>t3Lc4y;%Fll@r!@m%v2qV@he-o(C1dc1Ks-7(dl(B7Q4elnaX?&A@TX>UU zjtZ1T2GU0&+|4Ok7y5_nn;iNZ-S<-DXR*;$XQrp7q^GJYKqLa7S7v3Z`4{2zhXc)z zj`P2(5mow6FOFOz{wsh+|S4aqu`oCixvNVEE zPXXgFdIq)XvUn0W;?VU<0u05)4ID&lEOa0$JW>}D1}CxdXwoFW5%uZ+Cg)|WV72nM zjN$)Q&VR1={$ Ti$wmvbE=d&y+|zDfVSj`Pp?|9_N{ Ezr_pwx0n4d>e_$!enlsTZ?;S2@9i>wKOkoX>2ES+=&mrnmPX2n?`!}(?n^;;r#;h)bvv9EP|R^@OFL |WyIKw04j$9RMmP7 zrC%t+5VWM_!m-Ku4DI0BRA7S}5_@5dMd>^dYeKN7wH?!vkYft7wttxgEn0L#|Azna zr>z%H>p`P9mob1}8rhvTuL~lnRZPKOMhBU;qk`uaq+bY$K&~x!JqwK=P_Yy*8xE*V zo(sWg3s%pXn0E|%Pdh}KJ=9kMC}xR6K%eckmcr@ZQJ*4sngUfKCDzgjnRLn;C<=Y> z6~>Jb{$n8S%aNp*62;65G#AROovMX!`DR6N%}T8{$FHpIp|cSdjJGGRC8+~bDy;-} zx%SrjQiHwOz|}86Sh3cZ@;s(uAOm9c^t-+^XkAdSW(g!ogmnu#TIErLAU3L0)wxx$ zu07x2XYTrP1Q$L{Bd~%M%v&hcwV)ajbPNilg*bB2?FXM_vRih2>X%5Qv `~K7CS}>AN%@g z0VV>UlOU>5ze_AbG7rwK+$ln&(A1UJAJhGuvaB=Y2v`^D;5A>r4!5&O2Qw=x3#&;V zMo?tnhy2_OgmsUd_L0W!)pI}o*6t=VF2E!HZuIp3Tc7?H0@cjP+DgdQ(D8o_{_@u% zkbivB!co`G!Pv>k+~hwkd(gD>TyIYJywufatQJU%Gh!$03JXvkv0p#8&tkIokWo$0 z*1-#B5vJ%=Q<1u`-F5{~D6lGB-?V-El`r-aZSo+y51Q{uffnL$b#{7-Ew+;?j4*L? zn`7+K6#hWpj5c627Pa~bw}$8Q^>TjotWp+NwpL~ VDgiG;59`a{85=(+9#c5q=CXV4Deh+4 zwW?!CE3|qEP)ZD-j>40cLd1UirN$OI)D=u5)d$*SOa;Z4%JeH{RpB^vi7niel-O8~ z;$Ss-aLx|=a6!AV9bK6<6;xVJt$~uYv(?#nY4D%{dE6{PIum;-gFT& nJ2&4U`+=z&aQfE^_Ubx3azx{H~=58 znp_%@i@fA9CdSgJWTa9#)3k91zgSb8wHW6WOjeBFSZqJwD;ZBS@weta{)E|&AcR(7 zMwC-Cr}rg=5}Jf|UFo0<-IqDKsUev>-0%Ik*Ln0jGg36WnSQ?{&TZHo!e6H5Hwt+l z0kZh WXTa5^7+gi!jeI&voKOnX@N=KtkLIZpJ2@;=5Smj0EV>TWcR}bEL&c2 zx51zp>SNu|+204-9>7>7MU^8P62keGT;y>OEwD-^*Jm(;)}#MzI?P#n>P}5cJvygD zI(BkEl2b~GU=nQ`A5irEw^^DZv-FFSex7;VE1A?tnsyf!x+Uwi#xlK aV4|fK+@wz`9y?a_5}NUw(-$w0@-cp~LZ!E1Ev+TVPiWz@W5?I3Me(9$P1t zdXS4OTQN CJ@vzB%$#^ MbOR=Qo!_$@&mq|m;0&@!420wDzLk$C}a4gF5Xf^wY zA`snoiyCIr>O+krK8>>(aZ)na5JICvBI1AwYs=bytE*m~xM@fuHzTmaVasM*^x5C> zW*?#o(RI79v| 0uYqBsm@YEm;CfX!3vA)bD|eb3AR2(j?fqLu?f%j kPEEXUb*U%th$*R~@Yb{pN5GnDJZMW@P5$mg2b{4_zT zf5o}K09>PyYchZ?jA)`nymN(H8e!4|O{Mp|3>rL0l#&^UEQLS3Sc7+T>|}EzO5y?q zoP62a5J7J&dtq-V_{6R!#a?RC!5*K4FzwQSJ#{dJR7jNiz_VtF2;e7&xyR)s(L8== zNK_!vluQZ#@p{e$L@n}I$GPE-Ko~@38V;bkcp9j|DsLnz1Ab*X Izn(*y+$HRO%Z*GiYo$5qwhwj9OE1UB8#2F^NVDzxxHhk$-Ka7U bH z4tUdaOh+I}*PvFWFy@9z&L7BF_FMdXE>f6A80v0~2J(IKlWmS>uO~HVFqWd;GJ-)E zbVq$Wz5nQ*&vrWb6#jCJP97Wn32pmPqubUaOJ7@ibpDE2B9qf^Jhad3mS|Vp$IN=D zZ=@F=jPpl;x>V~}K?UhIg;&D+CBPrLGA)`@@m8%O`A=csK(j$qvACWnHx&q85;BvY z6gXEjWLl?wHg)vuKGeAmV7e^&E=E^+D@n$?l4Btno&4ELuH06LHCIZlB|j|Gci}|p z-yG6l8PS(=gXQKLkU{-N4X_t<4Tiw8%?jq)gsp#Y?9iG+tT8r<6e5upMwO7nBS27L znD3%LqRq!q3 ody+SzHD9FEYdmm;jGs> zTc1!SK)0j2k#q^+RrIJrtYQ##eKiz+WK OsX|`&Ws~s||dY>~5P>194a% z$FfEeZ~#!-E~92LwRQGnQ+jqp>>;xzy^vB@Rt;kQ+zAOLZ%6fR*Z3Ss5)LP|nH|pf z_AOgtx6agjw=T&EFjim-E&ON>uWwDm*wH8nE6B{ m`d3~;k3 zCN`~JEV|5`!N&Bch6NY%ALj13jmBh^!`&x1&MfVByXf*hpawHJ Iz!- z$ZlN1ttWFo jL>xO%le* zjmAHL$&moAQY#-wJHO$OKr$s*=L1b>lNDxyX^rCi*AvWyFn_^MyKse_%LB^xtmDIi zPFZTf&29>8oM m>*Fe~L6vcaLE&)=nF!Fp4#KtUykA@9o1+H= zGVi}q?zJybI=1CNBLIJEo7P(*utNE+%j{I-43uac)duexvpL1{Bs|s9OR|IDQ#K)~ zxsv0G9A@HTv4MpcOto6YubkMmnt9(L4l$KM`kQap;pV}lxlmWcKh1rx0N3VIj4H8V zcsUAh0WH5ClKOE0&~`2aLPiGW)`)mlaELDDE!CsZR8?9XQ =@)Mo#i-RmYcb=&)EAXdcsmE!z~ ze68}4O9OLY(Sv4r0}&D3gZk_fF1vAALF=hjf|khMRdzu;Gs0X^sXocUrGP z7YoJ%shSnawnXx>;!r*VQCDbF@+~I|^May}>t;5?Z;f&gHWhWDu0zN;_v0j&k^n`& zjLGfsQ^0IKgpM O5N27$T&DvbwW=(q%2(VIZ6nAq68v1eZoXky__ut$QEiy zRSALg7t{>(#g@e^Yf1ZB1h SvU0}H|D$2dLhw>Jyf{;l;Kzq(zk`k|*R2iflC1L)Oe5_Z0N z^UTjBzT+)j!XyixO!ofTX0q&8nQ7ID?eyQluJloBS&;2+@MHVV=Lf&o2$pNC+%P08 z=*@ZkP-Za%R;N-xPp?>B?*?~FfXQ%H_-EG7!9n>NS;5JE3INX2ngPua`V}*9P6KeU z&J>w%AP~VU6f{p? RFPmx)sxrNr&I6TdZU@cyxt(^?sOuH6nu`BY=^iENOvs ziP^glhB5jmmb!;1Q`UJsS|0(>vIL+EH6!5gZ<7(S8*;6lx(lvVu@W_1Gtr)1IWzCu zR-}ek=!_R4`O=}U^72wCYc2UoA1GpkhVdLoM ZlSg!kCUQX26$M-MEHBm1iKYZn&GMuF&SD>v z<`ErNWd4a0O~LiWWhauE{@GR@5r?xbhIiS7LPPdWkOUkxzZGhD#TVQkOyJE$VA4$F zbO&0$WsF4Se7T6zZp+)vj$J}RO?8pdnV5sl-qJTXwp)};=zuK?Kq5r!PrM)@5Arw& zw=psbZux|LVbyDRS@G%)xDhw=JT5yf(z2nE1)y>!T@HNyGi^}n2Eo3ZF5Ci%mMB8? z5N6*@7QlXv1MA@rV!UzmLLu|6rfd}@wSAZz5_eJk@K{#+oDXF5@$VAQvbA*Q6~rHH zswU-|p}|uO1j-4ys;p3&5mw6dvF>4qX%zN4m%LI#t;q@~o40{T?9&OnZYUx_a#m!S z<#fl7Hs`0Ue>`>sMhntzRCnmeuNdVyO+1F4>rcThee>C4m*Z_@s|OBg>jq4$Gp@6v z9)lGh4pW^E4+_NuQ>M=M*2W(r5ssy>c*9)k**wuy=GqYP>js<9_^?tnX uyfI-Cb-;0&%y!+l_c-JhipSl;-0VBLDsb-HEMbf*!$+-z0_94*L!)qX z{@~|>xz)%_UL_ykteLlKxKpr>u6`ia6GV}kY?