Treezor.MerchantIdRestrictionGroupsApi

All URIs are relative to https://sandbox.treezor.com/v1/index.php

Method	HTTP request	Description
deleteMerchantIdRestrictionGroups	DELETE /merchantIdRestrictionGroups/{id}	cancel a merchant id restriction group
getMerchantIdRestrictionGroup	GET /merchantIdRestrictionGroups	search merchant id restriction groups
getMerchantIdRestrictionGroupsId	GET /merchantIdRestrictionGroups/{id}	get a merchant ID restriction group
merchantIdRestrictionGroupsIdDeltaUpdatePut	PUT /merchantIdRestrictionGroups/{id}/DeltaUpdate/	edit the merchant ID list for a restriction group
merchantIdRestrictionGroupsIdPresenceCheckGet	GET /merchantIdRestrictionGroups/{id}/PresenceCheck/	check the presence of merchants IDs list for a restriction group
postMerchantIdRestrictionGroup	POST /merchantIdRestrictionGroups	create a merchantIdRestrictionGroup
putMerchantIdRestrictionGroups	PUT /merchantIdRestrictionGroups/{id}	edit a merchant id restriction group (Deprecated)

deleteMerchantIdRestrictionGroups

InlineResponse20016 deleteMerchantIdRestrictionGroups(id, opts)

cancel a merchant id restriction group

Cancel a merchant id restriction group from the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let id = 789; // Number | Merchant ID restriction Group internal id.
let opts = { 
  'fields': ["fields_example"] // [String] | List of the object's properties you want to pick up.
};
apiInstance.deleteMerchantIdRestrictionGroups(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
id	Number	Merchant ID restriction Group internal id.
fields	[String]	List of the object's properties you want to pick up.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

getMerchantIdRestrictionGroup

InlineResponse20016 getMerchantIdRestrictionGroup(opts)

search merchant id restriction groups

Get merchant ID restriction groups that match search criteria.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let opts = { 
  'accessSignature': "accessSignature_example", // String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). 
  'accessTag': "accessTag_example", // String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). 
  'accessUserId': 56, // Number | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'accessUserIp': "accessUserIp_example", // String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'fields': ["fields_example"], // [String] | List of the object's properties you want to pick up.
  'filter': "filter_example", // String | You can filter the API response by using filter(s). Filterable fields are :   - id   - name   - isWhitelist   - status   - startDate   - createdDate    Filters should be separated by a \";\". Example for 3 filters : FILTER1;FILTER2;FILTER3.    A single filter has the following syntax : \"fieldName criterion expression\".    Where :     - fieldName : the name of a filterable field of this object.      - expression : the values to be included or excluded (see the table below for more information)      - criterion : a filter criterion.    Here are the possible values for criterion :    | Criteria |         Description    |                   Type                   | Expression Example |   |----------|------------------------|------------------------------------------|--------------------|   |     >    |      greater than      |            alphanumeric string           |         100        |   |    >=    | greater or equal than  |            alphanumeric string           |         100        |   |     <    |        less than       |            alphanumeric string           |         100        |   |    <=    |   less or equal than   |            alphanumeric string           |         100        |   |    !=    |      not equal to      |            alphanumeric string           |         100        |   |   like   |          like          |            alphanumeric string           |         100        |   |    in    |           in           | alphanumeric strings separated by commas |      100,30,25     |   |    ==    |         equals         |            alphanumeric string           |         100        | 
  'pageNumber': 56, // Number | Pagination page number. More info [here](https://agent.treezor.com/lists). 
  'pageCount': 56, // Number | The number of items per page. More info [here](https://agent.treezor.com/lists). 
  'sortBy': "sortBy_example", // String | The transaction element you want to sort the list with. Default value : _createdDate_. More info [here](https://agent.treezor.com/lists). 
  'sortOrder': "sortOrder_example" // String | The order you want to sort the list. * **DESC** for a descending sort * **ASC** for a ascending sort.  Default value : DESC. More info [here](https://agent.treezor.com/lists). 
};
apiInstance.getMerchantIdRestrictionGroup(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
accessSignature	String	Access signature can be mandatory for specific context. Treezor will contact you if so. More info here.	[optional]
accessTag	String	Access tag is used for idem potency query. More info here.	[optional]
accessUserId	Number	Access user's id is used for user's action restriction. More info here.	[optional]
accessUserIp	String	Access user's ip is used for user's action restriction. More info here.	[optional]
fields	[String]	List of the object's properties you want to pick up.	[optional]
filter	String	You can filter the API response by using filter(s). Filterable fields are : - id - name - isWhitelist - status - startDate - createdDate Filters should be separated by a ";". Example for 3 filters : FILTER1;FILTER2;FILTER3. A single filter has the following syntax : "fieldName criterion expression". Where : - fieldName : the name of a filterable field of this object. - expression : the values to be included or excluded (see the table below for more information) - criterion : a filter criterion. Here are the possible values for criterion :	Criteria
pageNumber	Number	Pagination page number. More info here.	[optional]
pageCount	Number	The number of items per page. More info here.	[optional]
sortBy	String	The transaction element you want to sort the list with. Default value : createdDate. More info here.	[optional]
sortOrder	String	The order you want to sort the list. * DESC for a descending sort * ASC for a ascending sort. Default value : DESC. More info here.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

getMerchantIdRestrictionGroupsId

InlineResponse20016 getMerchantIdRestrictionGroupsId(id, opts)

get a merchant ID restriction group

Get a merchant ID restriction group from the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let id = 789; // Number | Merchant ID restriction Group internal id.
let opts = { 
  'fields': ["fields_example"] // [String] | List of the object's properties you want to pick up.
};
apiInstance.getMerchantIdRestrictionGroupsId(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
id	Number	Merchant ID restriction Group internal id.
fields	[String]	List of the object's properties you want to pick up.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

merchantIdRestrictionGroupsIdDeltaUpdatePut

InlineResponse20016 merchantIdRestrictionGroupsIdDeltaUpdatePut(id, opts)

edit the merchant ID list for a restriction group

Edit the merchant ID list for a restriction group in the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let id = 56; // Number | Merchant ID restriction group's id.
let opts = { 
  'body': new Treezor.IdDeltaUpdateBody(), // IdDeltaUpdateBody | 
  'accessSignature': "accessSignature_example", // String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). 
  'accessTag': "accessTag_example", // String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). 
  'accessUserId': 56, // Number | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'accessUserIp': "accessUserIp_example" // String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
};
apiInstance.merchantIdRestrictionGroupsIdDeltaUpdatePut(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
id	Number	Merchant ID restriction group's id.
body	IdDeltaUpdateBody		[optional]
accessSignature	String	Access signature can be mandatory for specific context. Treezor will contact you if so. More info here.	[optional]
accessTag	String	Access tag is used for idem potency query. More info here.	[optional]
accessUserId	Number	Access user's id is used for user's action restriction. More info here.	[optional]
accessUserIp	String	Access user's ip is used for user's action restriction. More info here.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

merchantIdRestrictionGroupsIdPresenceCheckGet

InlineResponse20016 merchantIdRestrictionGroupsIdPresenceCheckGet(id, opts)

check the presence of merchants IDs list for a restriction group

Check if merchants IDs list for a restriction group in the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let id = 56; // Number | Merchant ID restriction group's id.
let opts = { 
  'body': new Treezor.IdPresenceCheckBody(), // IdPresenceCheckBody | 
  'accessSignature': "accessSignature_example", // String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). 
  'accessTag': "accessTag_example", // String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). 
  'accessUserId': 56, // Number | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'accessUserIp': "accessUserIp_example" // String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
};
apiInstance.merchantIdRestrictionGroupsIdPresenceCheckGet(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
id	Number	Merchant ID restriction group's id.
body	IdPresenceCheckBody		[optional]
accessSignature	String	Access signature can be mandatory for specific context. Treezor will contact you if so. More info here.	[optional]
accessTag	String	Access tag is used for idem potency query. More info here.	[optional]
accessUserId	Number	Access user's id is used for user's action restriction. More info here.	[optional]
accessUserIp	String	Access user's ip is used for user's action restriction. More info here.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

postMerchantIdRestrictionGroup

InlineResponse20016 postMerchantIdRestrictionGroup(opts)

create a merchantIdRestrictionGroup

Create a new merchant ID restriction group in the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let opts = { 
  'body': new Treezor.MerchantIdRestrictionGroupsBody(), // MerchantIdRestrictionGroupsBody | 
  'accessSignature': "accessSignature_example", // String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). 
  'accessTag': "accessTag_example", // String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). 
  'accessUserId': 56, // Number | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'accessUserIp': "accessUserIp_example" // String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
};
apiInstance.postMerchantIdRestrictionGroup(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
body	MerchantIdRestrictionGroupsBody		[optional]
accessSignature	String	Access signature can be mandatory for specific context. Treezor will contact you if so. More info here.	[optional]
accessTag	String	Access tag is used for idem potency query. More info here.	[optional]
accessUserId	Number	Access user's id is used for user's action restriction. More info here.	[optional]
accessUserIp	String	Access user's ip is used for user's action restriction. More info here.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

putMerchantIdRestrictionGroups

InlineResponse20016 putMerchantIdRestrictionGroups(id, opts)

edit a merchant id restriction group (Deprecated)

Edit a merchant id restriction group in the system.

Example

import {Treezor} from 'treezor';
let defaultClient = Treezor.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new Treezor.MerchantIdRestrictionGroupsApi();
let id = 56; // Number | Merchant ID restriction group's id.
let opts = { 
  'body': new Treezor.MerchantIdRestrictionGroupsIdBody(), // MerchantIdRestrictionGroupsIdBody | 
  'accessSignature': "accessSignature_example", // String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication). 
  'accessTag': "accessTag_example", // String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics). 
  'accessUserId': 56, // Number | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
  'accessUserIp': "accessUserIp_example" // String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics). 
};
apiInstance.putMerchantIdRestrictionGroups(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
id	Number	Merchant ID restriction group's id.
body	MerchantIdRestrictionGroupsIdBody		[optional]
accessSignature	String	Access signature can be mandatory for specific context. Treezor will contact you if so. More info here.	[optional]
accessTag	String	Access tag is used for idem potency query. More info here.	[optional]
accessUserId	Number	Access user's id is used for user's action restriction. More info here.	[optional]
accessUserIp	String	Access user's ip is used for user's action restriction. More info here.	[optional]

Return type

InlineResponse20016

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

MerchantIdRestrictionGroupsApi.md

Latest commit

History

MerchantIdRestrictionGroupsApi.md

File metadata and controls

Treezor.MerchantIdRestrictionGroupsApi

deleteMerchantIdRestrictionGroups

Example

Parameters

Return type

Authorization

HTTP request headers

getMerchantIdRestrictionGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getMerchantIdRestrictionGroupsId

Example

Parameters

Return type

Authorization

HTTP request headers

merchantIdRestrictionGroupsIdDeltaUpdatePut

Example

Parameters

Return type

Authorization

HTTP request headers

merchantIdRestrictionGroupsIdPresenceCheckGet

Example

Parameters

Return type

Authorization

HTTP request headers

postMerchantIdRestrictionGroup

Example

Parameters

Return type

Authorization

HTTP request headers

putMerchantIdRestrictionGroups

Example

Parameters

Return type

Authorization

HTTP request headers