All URIs are relative to https://sandbox.treezor.com/v1/index.php
Method | HTTP request | Description |
---|---|---|
deleteAcquirerMerchantIdGroups | DELETE /acquirerMerchantIdGroups/{id} | cancel a merchant id restriction group |
getAcquirerMerchantIdGroup | GET /acquirerMerchantIdGroups | search acquirer merchant id restriction groups |
getAcquirerMerchantIdGroupsId | GET /acquirerMerchantIdGroups/{id} | get a acquirer merchant ID restriction group |
postAcquirerMerchantIdGroup | POST /acquirerMerchantIdGroups | create a acquirerMerchantIdGroup |
putAcquirerMerchantIdGroups | PUT /acquirerMerchantIdGroups/{id} | edit an acquirer merchant id restriction group |
InlineResponse200 deleteAcquirerMerchantIdGroups(id, opts)
cancel a merchant id restriction group
Cancel a merchant id restriction group from the system.
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.AcquirerMerchantIdGroupsApi();
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.deleteAcquirerMerchantIdGroups(id, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
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] |
- Content-Type: Not defined
- Accept: application/json
InlineResponse200 getAcquirerMerchantIdGroup(opts)
search acquirer merchant id restriction groups
Get acquirer merchant ID restriction groups that match search criteria.
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.AcquirerMerchantIdGroupsApi();
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.getAcquirerMerchantIdGroup(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
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] |
- Content-Type: Not defined
- Accept: application/json
InlineResponse200 getAcquirerMerchantIdGroupsId(id, opts)
get a acquirer merchant ID restriction group
Get a acquirer merchant ID restriction group from the system.
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.AcquirerMerchantIdGroupsApi();
let id = 789; // Number | Acquirer merchant ID restriction Group internal id.
let opts = {
'fields': ["fields_example"] // [String] | List of the object's properties you want to pick up.
};
apiInstance.getAcquirerMerchantIdGroupsId(id, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
Name | Type | Description | Notes |
---|---|---|---|
id | Number | Acquirer merchant ID restriction Group internal id. | |
fields | [String] | List of the object's properties you want to pick up. | [optional] |
- Content-Type: Not defined
- Accept: application/json
InlineResponse200 postAcquirerMerchantIdGroup(opts)
create a acquirerMerchantIdGroup
Create a new merchant ID restriction group in the system grouped by acquirer.
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.AcquirerMerchantIdGroupsApi();
let opts = {
'body': new Treezor.AcquirerMerchantIdGroupsBody(), // AcquirerMerchantIdGroupsBody |
'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.postAcquirerMerchantIdGroup(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
Name | Type | Description | Notes |
---|---|---|---|
body | AcquirerMerchantIdGroupsBody | [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] |
- Content-Type: application/json
- Accept: application/json
InlineResponse200 putAcquirerMerchantIdGroups(id, opts)
edit an acquirer merchant id restriction group
Edit an acquirer merchant id restriction group in the system.
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.AcquirerMerchantIdGroupsApi();
let id = 56; // Number | Acquirer Merchant ID restriction group's id.
let opts = {
'body': new Treezor.AcquirerMerchantIdGroupsIdBody(), // AcquirerMerchantIdGroupsIdBody |
'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.putAcquirerMerchantIdGroups(id, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
Name | Type | Description | Notes |
---|---|---|---|
id | Number | Acquirer Merchant ID restriction group's id. | |
body | AcquirerMerchantIdGroupsIdBody | [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] |
- Content-Type: application/json
- Accept: application/json