Skip to content

Latest commit

 

History

History
281 lines (190 loc) · 9.12 KB

AntifraudApi.md

File metadata and controls

281 lines (190 loc) · 9.12 KB
Raw

conekta.api.AntifraudApi

Load the API package

import 'package:conekta/api.dart';

All URIs are relative to https://api.conekta.io

Method HTTP request Description
createRuleBlacklist POST /antifraud/blacklists Create blacklisted rule
createRuleWhitelist POST /antifraud/whitelists Create whitelisted rule
deleteRuleBlacklist DELETE /antifraud/blacklists/{id} Delete blacklisted rule
deleteRuleWhitelist DELETE /antifraud/whitelists/{id} Delete whitelisted rule
getRuleBlacklist GET /antifraud/blacklists Get list of blacklisted rules
getRuleWhitelist GET /antifraud/whitelists Get a list of whitelisted rules

createRuleBlacklist

BlacklistRuleResponse createRuleBlacklist(createRiskRulesData, acceptLanguage)

Create blacklisted rule

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final CreateRiskRulesData createRiskRulesData = ; // CreateRiskRulesData | requested field for blacklist rule
final String acceptLanguage = es; // String | Use for knowing which language to use

try {
    final response = api.createRuleBlacklist(createRiskRulesData, acceptLanguage);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->createRuleBlacklist: $e\n');
}

Parameters

Name Type Description Notes
createRiskRulesData CreateRiskRulesData requested field for blacklist rule
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']

Return type

BlacklistRuleResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createRuleWhitelist

WhitelistlistRuleResponse createRuleWhitelist(acceptLanguage, createRiskRulesData)

Create whitelisted rule

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final String acceptLanguage = es; // String | Use for knowing which language to use
final CreateRiskRulesData createRiskRulesData = ; // CreateRiskRulesData | 

try {
    final response = api.createRuleWhitelist(acceptLanguage, createRiskRulesData);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->createRuleWhitelist: $e\n');
}

Parameters

Name Type Description Notes
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']
createRiskRulesData CreateRiskRulesData [optional]

Return type

WhitelistlistRuleResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRuleBlacklist

DeletedBlacklistRuleResponse deleteRuleBlacklist(id, acceptLanguage, xChildCompanyId)

Delete blacklisted rule

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final String id = 6307a60c41de27127515a575; // String | Identifier of the resource
final String acceptLanguage = es; // String | Use for knowing which language to use
final String xChildCompanyId = 6441b6376b60c3a638da80af; // String | In the case of a holding company, the company id of the child company to which will process the request.

try {
    final response = api.deleteRuleBlacklist(id, acceptLanguage, xChildCompanyId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->deleteRuleBlacklist: $e\n');
}

Parameters

Name Type Description Notes
id String Identifier of the resource
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']
xChildCompanyId String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

DeletedBlacklistRuleResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteRuleWhitelist

DeletedWhitelistRuleResponse deleteRuleWhitelist(id, acceptLanguage, xChildCompanyId)

Delete whitelisted rule

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final String id = 6307a60c41de27127515a575; // String | Identifier of the resource
final String acceptLanguage = es; // String | Use for knowing which language to use
final String xChildCompanyId = 6441b6376b60c3a638da80af; // String | In the case of a holding company, the company id of the child company to which will process the request.

try {
    final response = api.deleteRuleWhitelist(id, acceptLanguage, xChildCompanyId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->deleteRuleWhitelist: $e\n');
}

Parameters

Name Type Description Notes
id String Identifier of the resource
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']
xChildCompanyId String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

DeletedWhitelistRuleResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRuleBlacklist

RiskRulesList getRuleBlacklist(acceptLanguage)

Get list of blacklisted rules

Return all rules

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final String acceptLanguage = es; // String | Use for knowing which language to use

try {
    final response = api.getRuleBlacklist(acceptLanguage);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->getRuleBlacklist: $e\n');
}

Parameters

Name Type Description Notes
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']

Return type

RiskRulesList

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getRuleWhitelist

RiskRulesList getRuleWhitelist(acceptLanguage)

Get a list of whitelisted rules

Return all rules

Example

import 'package:conekta/api.dart';

final api = Conekta().getAntifraudApi();
final String acceptLanguage = es; // String | Use for knowing which language to use

try {
    final response = api.getRuleWhitelist(acceptLanguage);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AntifraudApi->getRuleWhitelist: $e\n');
}

Parameters

Name Type Description Notes
acceptLanguage String Use for knowing which language to use [optional] [default to 'es']

Return type

RiskRulesList

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]