openapi: 3.0.1 info: title: Internal RBA WS Admin description: Rest RBA Admin Config Operations version: "25R1.0" paths: /admin/authtypes/{service}: get: tags: - authType summary: Retrieve all authentication types of rule. description: Retrieve all authentication types of rule. operationId: getAuthTypeList parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/AuthTypeListResponse' /admin/blacklist/create: post: tags: - blacklist summary: Create blackList element. description: "Create blacklist element, Type and Value are validated. Control\ \ that it doesn't exist, otherwise return error: 400050001." operationId: createBlackList requestBody: description: Blacklist object to create content: application/json: schema: $ref: '#/components/schemas/BlacklistDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseOneBL' /admin/blacklist/delete: delete: tags: - blacklist summary: Delete blackList element. description: "Delete blackList element. The request object is validated. Error\ \ cases: service doesn't exist: 400050005; type invalid: 400050002; value\ \ incorrect: 400050003" operationId: deleteBlacklistItem requestBody: description: The blacklist item to delete content: application/json: schema: $ref: '#/components/schemas/BlacklistDTO' required: true responses: "200": description: OK "400": description: Bad Request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext /admin/blacklist/getAll/{service}: get: tags: - blacklist summary: DEPRECATED description: DEPRECATED. Get all blackListed elements. operationId: getAllBlackLists_1 parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListBL' deprecated: true /admin/blacklist/getAll/{service}/{page}: get: tags: - blacklist summary: Get all blackListed elements. description: Get all blackListed elements. operationId: getAllBlackLists parameters: - name: service in: path description: Service required: true schema: type: string - name: page in: path description: Page required: true schema: type: integer format: int32 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListBL' /admin/blacklist/update: put: tags: - blacklist summary: Update blackList element. description: Update blackList element. operationId: updateBlacklist requestBody: description: The updated blacklist item to persist content: application/json: schema: $ref: '#/components/schemas/BlacklistDTO' required: true responses: "200": description: OK "400": description: Bad Request content: application/json: schema: type: object description: MessageContext /admin/blacklist/{service}/{types}: get: tags: - blacklist summary: "Search blackListed elements by service, type and value or label." description: "Search blackListed elements by type and value or label. It's possible\ \ to filter by issuer or sub-issuer. If the request is invalid, the following\ \ error will be returned: 400050000." operationId: searchServiceBlackLists_1 parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "Blacklist types: PHONE, IP, CARD_BLACK ..." required: true schema: type: string - name: searchBy in: query description: "Where to search the value, Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: SubIssuer Code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListBL' /admin/blacklist/{service}/{types}/count: get: tags: - blacklist summary: "count blackListed elements by service, type and value or label." description: "count blackListed elements by type and value or label. It's possible\ \ to filter by issuer or sub-issuer. If the request is invalid, the following\ \ error will be returned: 400050000." operationId: countServiceBlackLists parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "Blacklist types: PHONE, IP, CARD_BLACK ..." required: true schema: type: string - name: searchBy in: query description: "Where to search the value, Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: SubIssuer Code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseCount' /admin/blacklist/{service}/{types}/{page}: get: tags: - blacklist summary: "Search blackListed elements by service, type and value or label." description: "Search blackListed elements by type and value or label. It's possible\ \ to filter by issuer or sub-issuer. If the request is invalid, the following\ \ error will be returned: 400050000." operationId: searchServiceBlackLists parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "Blacklist types: PHONE, IP, CARD_BLACK ..." required: true schema: type: string - name: page in: path description: Page number required: true schema: type: integer format: int32 - name: searchBy in: query description: "Where to search the value, Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: SubIssuer Code schema: type: string - name: size in: query description: Page size (elements per page) required: true schema: type: integer format: int32 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListBL' /admin/blacklisted: get: tags: - blacklist summary: Check if value is blacklisted. description: Service to check if value is blacklisted. operationId: isBlackListed parameters: - name: service in: query description: Service type. required: true schema: type: string - name: type in: query description: Value type. required: true schema: type: string enum: - IP - IPV6 - IP_RANGE - IPV6_RANGE - EMAIL - PHONE - CARD_BLACK - CARD_WHITE - CARD_EXEMPTION - MERCHANT_URL - MERCHANT_COUNTRY - MERCHANT_ID - MERCHANT_NAME - MERCHANT_DOMAIN - RCPT_COUNTRY - name: value in: query description: Value to check. required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseServiceBoolean' /admin/config: put: tags: - config summary: Update config element. description: "Update config element. The request object is validated. Error\ \ Codes: 404150000, 400090051, 400090052, 400090053, 400090054, 400090056,\ \ 400090057, 400090058" operationId: updateConfig requestBody: description: The updated config item to persist content: application/json: schema: $ref: '#/components/schemas/ConfigDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext post: tags: - config summary: Create config element. description: "Create config element. All required parameters are validated.\ \ Error Codes: 400090051, 400090053, 400090054, 400090056, 400090057, 400090058,\ \ 400090056, 400090057, 400090059" operationId: createConfig requestBody: description: Config object to create content: application/json: schema: $ref: '#/components/schemas/ConfigDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ConfigResponse' delete: tags: - config summary: Delete config element. description: "Delete config element. Error Cases: Config element not found:\ \ 404150000" operationId: deleteConfig requestBody: description: The ID of config item to delete content: application/json: schema: $ref: '#/components/schemas/ConfigDTO' required: true responses: "200": description: Default response "404": description: Not found content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext /admin/config/{service}: get: tags: - config summary: Get all config elements. description: Get all config elements. operationId: getAllConfigs parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ConfigListResponse' /admin/counters: post: tags: - counters summary: Get all counters. description: Get all counters. operationId: getCounters requestBody: description: TransactionActivity request content: application/json: schema: $ref: '#/components/schemas/TransactionActivityRequest' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/CTACountersResponse' /admin/counters/{service}/{tokenPan}: get: tags: - counters summary: DEPRECATED description: DEPRECATED. Get all counters. operationId: getCounters_1 parameters: - name: tokenPan in: path description: Token pan required: true schema: type: string - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/CTACountersResponse' deprecated: true /admin/eligible-merchant/search: post: tags: - eligibleMerchant summary: Search eligible merchants. description: Will return search results and a count of all active (not deleted) merchants. operationId: searchEligibleMerchants requestBody: description: SearchEligibleMerchantsRequestDTO content: application/json: schema: $ref: '#/components/schemas/SearchEligibleMerchantsRequestDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/EligibleMerchantListResponse' /admin/eligible-merchant/search-by-payee: post: tags: - eligibleMerchant summary: Search eligible merchants by like operation. description: Will return search results and a count of all active (not deleted) merchants. operationId: searchEligibleMerchantsByPayee requestBody: description: SearchEligibleMerchantsByPayeeRequestDTO content: application/json: schema: $ref: '#/components/schemas/SearchEligibleMerchantsByPayeeRequestDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/EligibleMerchantListResponse' /admin/eligible-merchant/update: put: tags: - eligibleMerchant summary: Update eligible merchant. description: "If eligible merchant not found or already exists with the same\ \ service/issuer/subIssuer/type/vale, exception will be thrown" operationId: updateEligibleMerchant requestBody: description: UpdateEligibleMerchantRequestDTO content: application/json: schema: $ref: '#/components/schemas/UpdateEligibleMerchantRequestDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext /admin/issuerconfig: put: tags: - issuerConfig summary: Update an issuer config. description: Update an issuer config. operationId: updateIssuerConfig requestBody: description: The updated issuer config item to persist content: application/json: schema: $ref: '#/components/schemas/IssuerConfigDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext /admin/issuerconfig/all/{service}: get: tags: - issuerConfig summary: Get all issuers configs. description: Get all issuers configs. operationId: getAllIssuerConfigs parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/IssuerConfigListResponse' /admin/issuerconfig/{service}: get: tags: - issuerConfig summary: Get a specific issuer configs. description: Get a specific issuer configs. operationId: getIssuerConfig parameters: - name: service in: path description: Service required: true schema: type: string - name: issuer in: query description: Issuer code schema: type: string - name: subIssuer in: query description: Sub-issuer code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/IssuerConfigListResponse' /admin/issuerconfig/{service}/{id}: get: tags: - issuerConfig summary: Get a specific issuer config by ID. description: Get a specific issuer config by ID. operationId: getIssuerConfigById parameters: - name: service in: path description: Service required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int64 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/IssuerConfigResponse' /admin/operand/label/{service}: put: tags: - operand summary: Update an operand label. description: Update existing operand label in order to change its operand value. operationId: updateOperandLabel parameters: - name: id in: query description: ID required: true schema: type: integer format: int64 - name: ruleSetID in: query description: Ruleset ID required: true schema: type: integer format: int64 - name: label in: query description: Label required: true schema: type: string - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext /admin/operand/value/{service}: put: tags: - operand summary: Update operand value operation. description: Update existing operand value by operand value label and ruleset ID. operationId: updateOperandValue parameters: - name: ruleSetID in: query description: Ruleset ID required: true schema: type: integer format: int64 - name: label in: query description: Label required: true schema: type: string - name: value in: query description: Value required: true schema: type: integer format: int64 - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext /admin/operand/values/{service}: put: tags: - operand summary: Update operand values operation. description: Update existing operand values by operand values list and ruleset ID. operationId: updateOperandValues parameters: - name: service in: path description: Service required: true schema: type: string - name: ruleSetID in: query description: Ruleset ID required: true schema: type: integer format: int64 requestBody: description: The list of ruleset operand value DTO content: application/json: schema: type: array items: $ref: '#/components/schemas/OperandValueDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext /admin/operand/{service}/{ruleSetId}: get: tags: - operand summary: Get rule set operand values description: "Get rule set operand values by rule set id and service, if nothing\ \ found empty map will be returned" operationId: getRuleSetOperandValues parameters: - name: ruleSetId in: path description: Ruleset id required: true schema: type: integer format: int64 - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ListOperandValueDTO' "400": description: Bad request content: application/json: schema: type: object description: MessageContext /admin/presetrules/{service}: get: tags: - rule summary: "ruleset details, rules, conditions, operands" description: "ruleset details, rules, conditions, operands. If the rule set\ \ not found, the following error will be returned: 404060004" operationId: getPresetRuleSetDetails parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetListResponse' /admin/rule/activation/{service}: put: tags: - rule summary: Update rule to make it active or inactive. description: "Update rule activation flag. ID, Service and Flag are mandatory.\ \ Error codes: 400090031, 400090032, 400090033, 400090034, 400090035, 400090039,\ \ 400090040, 400090041, 400090042, 400090043" operationId: updateRuleActivation parameters: - name: id in: query description: ID required: true schema: type: integer format: int64 - name: activate in: query description: Flag required: true schema: type: boolean - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext /admin/rule/authtype/{service}: put: tags: - rule summary: Update rule authentication type operation. description: Update rule authentication type operation by rule identifier. operationId: updateRuleAuthType parameters: - name: id in: query description: ID required: true schema: type: integer format: int64 - name: value in: query description: value required: true schema: type: string - name: reason in: query description: reason required: true schema: type: string - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext /admin/rule/ordinals/{service}: put: tags: - rule summary: Move up/down rule by updating ordinals. description: "If the ordinal is the first one then up is impossible, if the\ \ ordinal is the last one then down is impossible." operationId: updateRuleOrdinal parameters: - name: service in: path description: Service required: true schema: type: string requestBody: description: UpdateRuleOrdinalRequest content: application/json: schema: $ref: '#/components/schemas/UpdateRuleOrdinalRequest' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext /admin/rule/reorder/{service}: put: tags: - rule summary: Reorder all rules by updating ordinals. description: "If rulesetId exist, all rules exists and are linked to the provided\ \ rulesetId, all rules of rulesetId are included in the list, then reorder\ \ is possible. Error codes: 400100000, 400090020, 400090031, 404060004, 400090048." operationId: reorderRules parameters: - name: service in: path description: Service required: true schema: type: string - name: userID in: query description: User ID required: true schema: type: string requestBody: description: UpdateAllRulesOrdinalsRequest content: application/json: schema: $ref: '#/components/schemas/UpdateAllRulesOrdinalsRequest' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "412": description: Precondition failed content: application/json: schema: type: object description: MessageContext /admin/rule/{service}: put: tags: - rule summary: Update rule params. description: Update rule params by rule. operationId: createOrUpdateRule parameters: - name: service in: path description: Service required: true schema: type: string - name: userID in: query description: User ID required: true schema: type: string requestBody: description: Rule content: application/json: schema: $ref: '#/components/schemas/RuleDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "412": description: Precondition failed content: application/json: schema: type: object description: MessageContext delete: tags: - rule summary: Delete rule. description: "If rule exists and linked to the rule set with status DRAFT_EDIT,\ \ rule will be deleted. Error Codes: 400090020, 400090031, 404060004, 400090050,\ \ 400090030." operationId: deleteRule parameters: - name: service in: path description: Service required: true schema: type: string - name: ruleSetId in: query description: Ruleset ID required: true schema: type: integer format: int64 - name: ruleId in: query description: RuleId schema: type: integer format: int64 responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "412": description: Precondition failed content: application/json: schema: type: object description: MessageContext /admin/ruleset: put: tags: - ruleset summary: Update Ruleset by dto. description: Update Ruleset by dto. operationId: updateRuleSet parameters: - name: userID in: query description: User ID required: true schema: type: string requestBody: description: Ruleset content: application/json: schema: $ref: '#/components/schemas/RuleSetDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "412": description: Precondition failed content: application/json: schema: type: object description: MessageContext /admin/ruleset/clone: post: tags: - ruleset summary: Clone a rule set by ID. description: Will return the clone of the rule set passed by parameter. operationId: cloneRuleSetById requestBody: description: RuleSetStateRequestDTO content: application/json: schema: $ref: '#/components/schemas/RuleSetStateRequestDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetDetailsResponse' /admin/ruleset/export/{service}/{id}: get: tags: - ruleset summary: Export ruleSet json file by ID. description: Export ruleSet json file by ID. operationId: exportRuleSet parameters: - name: service in: path description: Service required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int64 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetExportDataResponse' /admin/ruleset/import/{service}/{id}: post: tags: - ruleset summary: Import ruleSet from json file. description: Import ruleSet from json file. operationId: importRuleSet parameters: - name: id in: path description: ruleset ID required: true schema: type: integer format: int64 - name: service in: path description: Service required: true schema: type: string - name: userID in: query description: User ID required: true schema: type: string - name: comment in: query description: Comment required: true schema: type: string requestBody: description: RulesetExportData content: application/json: schema: $ref: '#/components/schemas/RulesetExportData' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetDetailsResponse' /admin/ruleset/list: get: tags: - ruleset summary: "List of RuleSet by service, issuer and sub-issuer." description: "Retrieve all ranges information at platform level, for a specific\ \ issuer or for a specific sub issuer of an issuer. If the request is invalid,\ \ the following error will be returned: 400010010 or 400010018." operationId: getRuleSetList parameters: - name: service in: query description: Service required: true schema: type: string - name: bcf in: query description: Issuer required: true schema: type: string - name: bdom in: query description: SubIssuer required: true schema: type: string - name: excludeRules in: query description: ExcludeRules required: true schema: type: boolean responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetListResponse' /admin/ruleset/state: post: tags: - ruleset summary: Change the status of a rule set description: Will change the status of the rule set passed by parameter operationId: changeRuleSetState requestBody: description: RuleSetStateRequestDTO content: application/json: schema: $ref: '#/components/schemas/RuleSetStateRequestDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetDetailsResponse' /admin/ruleset/{service}: get: tags: - ruleset summary: "ruleset details, rules, conditions, operands" description: "ruleset details, rules, conditions, operands. ID is mandatory.\ \ If the request is invalid, the following error will be returned: 404080000" operationId: getRuleSetDetails_1 parameters: - name: id in: query description: ID required: true schema: type: integer format: int64 - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetDetailsResponse' /admin/ruleset/{service}/{groupId}: get: tags: - ruleset summary: "ruleset details, rules, conditions, operands" description: "ruleset details, rules, conditions, operands. If the request is\ \ invalid, the following errors will be returned: 400090049, 404060004" operationId: getRuleSetDetails parameters: - name: service in: path description: Service required: true schema: type: string - name: groupId in: path description: GroupId required: true schema: type: string - name: state in: query description: State schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RuleSetDetailsResponse' /admin/scoreconfig: put: tags: - scoreConfig summary: Update a score config. description: Update a score config. operationId: updateScoreConfig requestBody: description: The updated score config item to persist content: application/json: schema: $ref: '#/components/schemas/ScoreConfigDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext /admin/scoreconfig/all/{service}: get: tags: - scoreConfig summary: Get all score config elements. description: Get all score config elements. operationId: getAllScoreConfigs parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ScoreConfigListResponse' /admin/scoreconfig/{service}: get: tags: - scoreConfig summary: Get a list of score configs. description: Get a list of score configs. operationId: getScoreConfig parameters: - name: service in: path description: Service required: true schema: type: string - name: issuer in: query description: Issuer Code schema: type: string - name: subIssuer in: query description: SubIssuer Code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ScoreConfigListResponse' /admin/scoreconfig/{service}/{id}: get: tags: - scoreConfig summary: Get a score configs by ID. description: Get a score configs by ID. operationId: getScoreConfigById parameters: - name: service in: path description: Service required: true schema: type: string - name: id in: path description: ID required: true schema: type: integer format: int64 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/ScoreConfigResponse' /admin/service/create: post: tags: - service summary: Create service element description: Create service element operationId: createService requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceDTO' responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseServiceServiceDTO' /admin/whitelist: put: tags: - whitelist summary: DEPRECATED description: "DEPRECATED. Update trusted beneficiary element, the request object\ \ is validated. Error Cases: TrustedBeneficiary element not found: 404130000" operationId: updateTrustedBeneficiary requestBody: description: The updated trusted beneficiary item to persist content: application/json: schema: $ref: '#/components/schemas/TrustedBeneficiaryDTO' required: true responses: "200": description: Default response "400": description: Bad request content: application/json: schema: type: object description: MessageContext "404": description: Not found content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext deprecated: true post: tags: - whitelist summary: Create trusted beneficiary element. description: Create trusted beneficiary element. All required parameters are validated. operationId: createTrustedBeneficiary requestBody: description: TrustedBeneficiary object to create content: application/json: schema: $ref: '#/components/schemas/TrustedBeneficiaryDTO' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseOneTB' delete: tags: - whitelist summary: Delete trusted beneficiary element. description: "Delete trusted beneficiary element. Error Cases: TrustedBeneficiary\ \ element not found: 404130000" operationId: deleteTrustedBeneficiary requestBody: description: The trusted beneficiary item to delete content: application/json: schema: $ref: '#/components/schemas/TrustedBeneficiaryDTO' required: true responses: "200": description: Default response "404": description: Not found content: application/json: schema: type: object description: MessageContext "520": description: Unexpected error content: application/json: schema: type: object description: MessageContext /admin/whitelist/search: post: tags: - whitelist summary: Search trusted beneficiary elements by TrustedBeneficiaryInternalRequest. description: "Search trusted beneficiary elements by service, trusted beneficiary\ \ type, payer, payer type, payee, payee type, issuer and sub-issuer." operationId: searchTrustedBeneficiaries_2 requestBody: description: TrustedBeneficiaryInternalRequest content: application/json: schema: $ref: '#/components/schemas/TrustedBeneficiaryInternalRequest' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListTB' /admin/whitelist/search-by-payer: post: tags: - whitelist summary: Search trusted beneficiary elements by TrustedBeneficiaryExternalRequest. description: "Search trusted beneficiary elements by service, issuer, sub-issuer,\ \ trusted beneficiary type, payer, payer type, and payee if it is provided\ \ (payee filtering using like operation with all payee types)" operationId: searchTrustedBeneficiaries_1 requestBody: description: TrustedBeneficiaryExternalRequest content: application/json: schema: $ref: '#/components/schemas/TrustedBeneficiaryExternalRequest' required: true responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminExternalResponseListTB' /admin/whitelist/{service}: get: tags: - whitelist summary: Get all trusted beneficiaries. description: Get all trusted beneficiaries. operationId: getAllTrustedBeneficiaries parameters: - name: service in: path description: Service required: true schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListTB' /admin/whitelist/{service}/page/{page}: get: tags: - whitelist summary: Get all trusted beneficiaries. description: Get all trusted beneficiaries. operationId: getAllTrustedBeneficiariesPage parameters: - name: service in: path description: Service required: true schema: type: string - name: page in: path description: Page required: true schema: type: integer format: int32 responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListTB' /admin/whitelist/{service}/{types}: get: tags: - whitelist summary: "Search trusted beneficiary elements by service, type and value or\ \ label." description: "Search trusted beneficiary elements by type and value or label.\ \ It's possible to filter by issuer or sub-issuer. If the request is invalid,\ \ the following error will be returned: 400050000" operationId: searchTrustedBeneficiaries parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "TrustedBeneficiary types: TRUST_LIST_ACS ..." required: true schema: type: string - name: searchBy in: query description: "Where to search the value. Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer code schema: type: string - name: bdom in: query description: Sub-issuer code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListTB' /admin/whitelist/{service}/{types}/count: get: tags: - whitelist summary: "count trusted beneficiary elements by service, type and value or label." description: "count trusted beneficiary elements by type and value or label.\ \ It's possible to filter by issuer or sub-issuer. If the request is invalid,\ \ the following error will be returned: 400050000" operationId: countTrustedBeneficiaries parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "TrustedBeneficiary types: TRUST_LIST_ACS ..." required: true schema: type: string - name: searchBy in: query description: "Where to search the value. Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: Sub-issuer Code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseCount' /admin/whitelist/{service}/{types}/page/{page}: get: tags: - whitelist summary: "Search trusted beneficiary elements by service, type and value or\ \ label." description: "Search trusted beneficiary elements by type and value or label.\ \ It's possible to filter by issuer or sub-issuer. If the request is invalid,\ \ the following error will be returned: 400050000" operationId: searchTrustedBeneficiariesPage parameters: - name: service in: path description: Service required: true schema: type: string - name: types in: path description: "TrustedBeneficiary types: TRUST_LIST_ACS ..." required: true schema: type: string - name: page in: path description: Page number required: true schema: type: integer format: int32 - name: searchBy in: query description: "Where to search the value. Possible values: value or label" required: true schema: type: string - name: value in: query description: Value to search either among labels or values required: true schema: type: string - name: bcf in: query description: Issuer Code schema: type: string - name: bdom in: query description: Sub-issuer Code schema: type: string responses: "200": description: Default response content: application/json: schema: $ref: '#/components/schemas/RbaAdminResponseListTB' components: schemas: AuthTypeDTO: required: - name type: object properties: name: type: string description: AuthType dto name reasons: type: array items: type: string enum: - LOW_VALUE - LOW_SCORE - RECURRING - ACQ_EXEMPTION - SEC_CORPORATE - INSTALMENT - THREE_RI_INSTALMENT - THREE_RI_CARDINFO - THREE_RI_WHITELIST - THREE_RI_RECURRING - THREE_RI_MOTO - FRICTIONLESS_DECISION - FRICTIONLESS_MERCHANT_TOP_LEVEL - ACQ_EXEMPTION_TRA - ACQ_EXEMPTION_DATA_SHARE_ONLY - ACQ_EXEMPTION_SCA_ALREADY_DONE - FRICTIONLESS_TRUSTED_BENEF_ACS - FRICTIONLESS_TRUSTED_BENEF_3DSSERVER - FRICTIONLESS_TRUSTED_BENEF_DS - THREE_RI_ADD_CARD - THREE_RI_PAYMENT - THREE_RI_SPLIT_TRN - SCA_SPLIT_DELAYED_TRN - THREE_RI_ACCOUNT - DAF_MUST_APPROVE - DAF_ISSUER_DECISION_LOW_RISK - FRICTIONLESS_MAINTENANCE_MODE - DAF_FIDO_ASSERTION_OK - DAF_FIDO_ATTESTATION_OK - DAF_FIDO_ATTESTATION_KO - DAF_FIDO_ASSERTION_OBO_OK - DAF_FIDO_ATTESTATION_OBO_INFO - DAF_FIDO_ASSERTION_OBO_VTS_INFO - DAF_FIDO_ASSERTION_VTS_OK - DAF_FIDO_ASSERTION_VTS_KO - HIGH_VALUE - HIGH_SCORE - MID_VALUE - MID_SCORE - MAX_FRICTIONLESS - NO_RULES - RBA_FALLBACK - FIRST_RECURRING - FIRST_SCA - ACQ_SCA_REQ - THREE_RI_DECOUPLED - FIRST_INSTALMENT - SCA_DECISION - SCA_MERCHANT_TOP_LEVEL - ID_V_SCA_REQ - SCA_TRUSTED_BENEF_3DSSERVER - SCA_TRUSTED_BENEF_DS - SCA_TRUSTED_BENEF_ACS - THREE_RI_SCA_ADD_CARD - DAF_ENROLMENT - DAF_FIDO_ENROLLMENT_AUTHORIZED - DAF_FIDO_ENROLLMENT_REFUSED - HIGH_RISK - MEDIUM_RISK - SCA_ADD_CARD - RISK_FRAUD - BIN_ATTACK_FRAUD - BLACKLISTED - DECLINE_DECISION - DECLINE_MERCHANT_TOP_LEVEL - THREE_RI_DECLINE_ADD_CARD - THREE_RI_NOT_SUPPORTED - DAF_ISSUER_DECISION_HIGH_RISK - DAF_NOT_SUPPORTED - DAF_NON_VDAP - DAF_SUSPECTED_FRAUD - DECLINE_MAINTENANCE_MODE - DAF_STOLEN_CARD - PRIOR_TRN_NOT_FOUND - INVALID_CARD_NUMBER - STOLEN_CARD - TRN_NOT_PERMITTED - DAF_FIDO_ASSERTION_KO - DAF_FIDO_ASSERTION_OBO_KO - EXT_RBA - LOW_RISK_MERCHANT_CB - MC_CARD_TESTING_ATTACK - UNKNOWN description: AuthType DTO resource representation AuthTypeListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array description: List of AuthTypeDTO items: $ref: '#/components/schemas/AuthTypeDTO' description: List of AuthType DTO resource representation AuthenticationHUBError: type: object properties: authMeans: type: array items: type: string authentId: type: string blackListStatus: type: array items: type: string cardHolderId: type: string comment: type: string errorCode: type: string extRbaDecision: type: string extRbaLevel: type: integer format: int32 externalWSResponse: type: string id: type: string issuerCode: type: string issuerRbaDecision: type: string issuerRbaLevel: type: integer format: int32 language: type: string message: type: string principal: $ref: '#/components/schemas/ErrorPrincipal' rbaDecision: type: string rbaLevel: type: string rbaReasonType: type: string site: type: string subIssuerCode: type: string tokenPan: type: string urlSite: type: string BaseRuleEngineDTO: required: - id type: object properties: createdTime: type: string description: Entity creation time format: date-time dates: $ref: '#/components/schemas/BaseRuleEngineDTO' deletedTime: type: string description: Entity deletion time format: date-time id: type: integer description: Entity id format: int64 updatedTime: type: string description: Entity last update time format: date-time description: Common base for all rule engine DTOs. BlacklistDTO: required: - id - service - type - value type: object properties: bcf: type: string description: Blacklist dto bcf bdom: type: string description: Blacklist dto bdom createdTime: type: string description: Blacklist dto createdTime format: date-time deletedTime: type: string description: Blacklist dto deletedTime format: date-time id: type: integer description: Blacklist dto identifier format: int64 keyboarded: type: string description: Blacklist dto keyboarded value label: type: string description: Blacklist dto label location: type: string description: Blacklist dto location pivotAmount: type: integer description: Blacklist dto pivotAmount format: int64 pivotAmountOperator: type: string description: Blacklist dto pivotAmountOperator enum: - GREATER_THAN - LESS_THAN - EQUAL_TO - LESS_THAN_OR_EQUAL - GREATER_THAN_OR_EQUAL - DIFF service: $ref: '#/components/schemas/ServiceDTO' type: type: string description: Blacklist dto type enum: - IP - IPV6 - IP_RANGE - IPV6_RANGE - EMAIL - PHONE - CARD_BLACK - CARD_WHITE - CARD_EXEMPTION - MERCHANT_URL - MERCHANT_COUNTRY - MERCHANT_ID - MERCHANT_NAME - MERCHANT_DOMAIN - RCPT_COUNTRY updatedTime: type: string description: Blacklist dto updatedTime format: date-time value: type: string description: Blacklist dto value description: Blacklist DTO resource representation CTACountersResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' transactionActivity: $ref: '#/components/schemas/TransactionActivityDTO' ConditionDTO: required: - id - name - ruleId type: object properties: createdTime: type: string description: Entity creation time format: date-time dates: $ref: '#/components/schemas/BaseRuleEngineDTO' deletedTime: type: string description: Entity deletion time format: date-time id: type: integer description: Entity id format: int64 name: type: string description: ConditionDTO name operandDTOs: type: array description: ConditionDTO list of operand dto elements items: $ref: '#/components/schemas/OperandDTO' ruleId: type: integer description: ConditionDTO rule ID format: int64 updatedTime: type: string description: Entity last update time format: date-time description: ConditionDTO resource representation ConfigDTO: required: - entry - id - service - value type: object properties: createdTime: type: string description: Config dto createdTime format: date-time deletedTime: type: string description: Config dto deletedTime format: date-time entry: type: string description: Config dto entry id: type: integer description: Config dto identifier format: int64 issuer: type: string description: Config dto issuer service: type: string description: Config dto service subIssuer: type: string description: Config dto subIssuer updatedTime: type: string description: Config dto updatedTime format: date-time value: type: string description: Config dto value description: Config DTO resource representation ConfigListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array items: $ref: '#/components/schemas/ConfigDTO' ConfigResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/ConfigDTO' EligibleMerchantDTO: type: object properties: categories: type: array description: EligibleMerchantDTO categories items: type: string description: EligibleMerchantDTO categories enum: - SECURE_CORPORATE - TRUSTED_BENEFICIARIES_ACS - TRUSTED_BENEFICIARIES_3DS_SERVER - DELEGATED_AUTHENTICATION - TRA - RISK - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - LEVEL_5 createdTime: type: string description: EligibleMerchantDTO created time format: date-time id: type: integer description: EligibleMerchantDTO id format: int64 issuer: type: string description: EligibleMerchantDTO issuer payeeType: type: string description: EligibleMerchantDTO payee type enum: - MERCHANT_ID - MERCHANT_URL - MERCHANT_NAME - MERCHANT_MCC - MERCHANT_URL_CONTAINS - MERCHANT_URL_STARTS - MERCHANT_URL_ENDS payeeValue: type: string description: EligibleMerchantDTO payee value service: type: string description: EligibleMerchantDTO service subIssuer: type: string description: EligibleMerchantDTO sub issuer updatedTime: type: string description: EligibleMerchantDTO updated time format: date-time description: EligibleMerchantDTO resource representation EligibleMerchantListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/SearchEligibleMerchantsResponseDTO' ErrorPrincipal: type: object properties: type: type: string value: type: string IssuerConfigDTO: type: object properties: active: type: boolean alwaysRetrieveExternalScoring: type: boolean description: IssuerConfigDTO always retrieve external scoring bypass3DS1: type: boolean description: IssuerConfigDTO bypass 3DS1 bypassVPAN: type: boolean description: IssuerConfigDTO bypass VPAN createdTime: type: string description: IssuerConfigDTO created time format: date-time defaultDecision: type: string description: IssuerConfigDTO default decision enum: - FRICTIONLESS - SCA - DECLINE - EXTRBADECISION defaultScore: type: integer description: IssuerConfigDTO default score format: int32 deletedTime: type: string description: IssuerConfigDTO deleted time format: date-time eligibleMerchantActive: type: boolean description: IssuerConfigDTO eligible merchant active id: type: integer description: IssuerConfigDTO id format: int64 interfaceType: type: string description: IssuerConfigDTO interface type enum: - THREE_DS - ONLINE_BANKING issuer: type: string description: IssuerConfigDTO issuer originPriority: type: array description: IssuerConfigDTO origin priority items: type: string description: IssuerConfigDTO origin priority enum: - DS - DS_CB - DS_CB_BANK - DS_VISA - DS_MASTERCARD - EXTERNAL - ISSUER - DS_ISSUER - EXTERNAL_ISSUER relevantScore: type: boolean description: IssuerConfigDTO relevant score scoringProviders: type: array description: ScoringProviderDTO scoring providers items: $ref: '#/components/schemas/ScoringProviderDTO' service: type: string description: IssuerConfigDTO service skipCounters: type: boolean description: IssuerConfigDTO skip counters subIssuer: type: string description: IssuerConfigDTO sub issuer trustedBeneficiariesActive: type: boolean description: IssuerConfigDTO trusted beneficiaries active updatedTime: type: string description: IssuerConfigDTO updated time format: date-time description: IssuerConfigDTO resource representation IssuerConfigListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array items: $ref: '#/components/schemas/IssuerConfigDTO' IssuerConfigResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/IssuerConfigDTO' ListOperandValueDTO: type: array properties: empty: type: boolean items: $ref: '#/components/schemas/OperandValueDTO' OperandDTO: required: - conditionId - id - name - reversed - type type: object properties: conditionId: type: integer description: OperandDTO condition id format: int64 createdTime: type: string description: Entity creation time format: date-time dates: $ref: '#/components/schemas/BaseRuleEngineDTO' deletedTime: type: string description: Entity deletion time format: date-time id: type: integer description: Entity id format: int64 longValue: type: integer format: int64 name: type: string description: OperandDTO name operandLabel: type: string description: OperandDTO operand value label operandValue: $ref: '#/components/schemas/OperandValueDTO' reversed: type: boolean description: OperandDTO reversed type: type: string description: OperandDTO type enum: - DEFAULT - EQUALS - IN - STATUS - STRICTLY_ABOVE - STRICTLY_UNDER updatedTime: type: string description: Entity last update time format: date-time value: type: string description: OperandDTO value description: OperandDTO resource representation OperandValueDTO: required: - label - ruleSetId - value type: object properties: id: type: integer format: int64 label: type: string description: OperandValueDTO label ruleSetId: type: integer description: OperandValueDTO rule set id format: int64 value: type: integer description: OperandValueDTO value format: int64 description: OperandValueDTO resource representation RbaAdminExternalResponseListTB: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/TrustedBeneficiaryExternalResponse' RbaAdminResponseCount: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: integer format: int32 RbaAdminResponseListBL: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' numberOfElements: type: integer format: int32 pageNumber: type: integer format: int32 size: type: integer format: int32 success: type: array items: $ref: '#/components/schemas/BlacklistDTO' totalElements: type: integer format: int32 totalPages: type: integer format: int32 RbaAdminResponseListTB: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array items: $ref: '#/components/schemas/TrustedBeneficiaryDTO' RbaAdminResponseOneBL: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/BlacklistDTO' RbaAdminResponseOneTB: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/TrustedBeneficiaryDTO' RbaAdminResponseServiceBoolean: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: boolean RbaAdminResponseServiceServiceDTO: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/ServiceDTO' RuleDTO: required: - authType - id - name - ordinal - reasonType - ruleSetId type: object properties: active: type: boolean description: RuleDTO active authType: type: string description: RuleDTO authentication type enum: - FRICTIONLESS - SCA - DECLINE - EXTRBADECISION conditionDTOs: type: array description: RuleDTO list of condition dto elements items: $ref: '#/components/schemas/ConditionDTO' createdTime: type: string description: Entity creation time format: date-time dates: $ref: '#/components/schemas/BaseRuleEngineDTO' deletedTime: type: string description: Entity deletion time format: date-time id: type: integer description: Entity id format: int64 name: type: string description: RuleDTO name ordinal: type: integer description: RuleDTO ordinal format: int32 reasonType: type: string description: RuleDTO reason type enum: - LOW_VALUE - LOW_SCORE - RECURRING - ACQ_EXEMPTION - SEC_CORPORATE - INSTALMENT - THREE_RI_INSTALMENT - THREE_RI_CARDINFO - THREE_RI_WHITELIST - THREE_RI_RECURRING - THREE_RI_MOTO - FRICTIONLESS_DECISION - FRICTIONLESS_MERCHANT_TOP_LEVEL - ACQ_EXEMPTION_TRA - ACQ_EXEMPTION_DATA_SHARE_ONLY - ACQ_EXEMPTION_SCA_ALREADY_DONE - FRICTIONLESS_TRUSTED_BENEF_ACS - FRICTIONLESS_TRUSTED_BENEF_3DSSERVER - FRICTIONLESS_TRUSTED_BENEF_DS - THREE_RI_ADD_CARD - THREE_RI_PAYMENT - THREE_RI_SPLIT_TRN - SCA_SPLIT_DELAYED_TRN - THREE_RI_ACCOUNT - DAF_MUST_APPROVE - DAF_ISSUER_DECISION_LOW_RISK - FRICTIONLESS_MAINTENANCE_MODE - DAF_FIDO_ASSERTION_OK - DAF_FIDO_ATTESTATION_OK - DAF_FIDO_ATTESTATION_KO - DAF_FIDO_ASSERTION_OBO_OK - DAF_FIDO_ATTESTATION_OBO_INFO - DAF_FIDO_ASSERTION_OBO_VTS_INFO - DAF_FIDO_ASSERTION_VTS_OK - DAF_FIDO_ASSERTION_VTS_KO - HIGH_VALUE - HIGH_SCORE - MID_VALUE - MID_SCORE - MAX_FRICTIONLESS - NO_RULES - RBA_FALLBACK - FIRST_RECURRING - FIRST_SCA - ACQ_SCA_REQ - THREE_RI_DECOUPLED - FIRST_INSTALMENT - SCA_DECISION - SCA_MERCHANT_TOP_LEVEL - ID_V_SCA_REQ - SCA_TRUSTED_BENEF_3DSSERVER - SCA_TRUSTED_BENEF_DS - SCA_TRUSTED_BENEF_ACS - THREE_RI_SCA_ADD_CARD - DAF_ENROLMENT - DAF_FIDO_ENROLLMENT_AUTHORIZED - DAF_FIDO_ENROLLMENT_REFUSED - HIGH_RISK - MEDIUM_RISK - SCA_ADD_CARD - RISK_FRAUD - BIN_ATTACK_FRAUD - BLACKLISTED - DECLINE_DECISION - DECLINE_MERCHANT_TOP_LEVEL - THREE_RI_DECLINE_ADD_CARD - THREE_RI_NOT_SUPPORTED - DAF_ISSUER_DECISION_HIGH_RISK - DAF_NOT_SUPPORTED - DAF_NON_VDAP - DAF_SUSPECTED_FRAUD - DECLINE_MAINTENANCE_MODE - DAF_STOLEN_CARD - PRIOR_TRN_NOT_FOUND - INVALID_CARD_NUMBER - STOLEN_CARD - TRN_NOT_PERMITTED - DAF_FIDO_ASSERTION_KO - DAF_FIDO_ASSERTION_OBO_KO - EXT_RBA - LOW_RISK_MERCHANT_CB - MC_CARD_TESTING_ATTACK - UNKNOWN ruleSetId: type: integer description: RuleDTO rule set ID format: int64 updatedTime: type: string description: Entity last update time format: date-time description: RuleDTO resource representation RuleSetDTO: required: - id - service type: object properties: cardScheme: type: string description: RuleSetDTO card type enum: - CB - MASTERCARD - VISA - MAESTRO - BANCONTACT - JCB createdTime: type: string description: Entity creation time format: date-time dates: $ref: '#/components/schemas/BaseRuleEngineDTO' deletedTime: type: string description: Entity deletion time format: date-time deviceChannel: type: string description: RuleSetDTO device channel draftOngoing: type: string description: RuleSetDTO draft state groupId: type: string description: RuleSetDTO group identifier id: type: integer description: Entity id format: int64 issuer: type: string description: RuleSetDTO issuer label: type: string description: RuleSetDTO label location: type: string description: RuleSetDTO location operandValues: uniqueItems: true type: array description: RuleSetDTO list of operand value dto elements items: $ref: '#/components/schemas/OperandValueDTO' rules: type: array description: RuleSetDTO list of rule dto elements items: $ref: '#/components/schemas/RuleDTO' service: type: string description: RuleSetDTO service status: type: string description: RuleSetDTO status enum: - PROD - BACKUP - DRAFT_EDIT - DRAFT_SUBMIT - DRAFT_TEST - DELETED - PRESET subIssuer: type: string description: RuleSetDTO sub issuer transactionType: type: string description: RuleSetDTO transaction type enum: - ONLINE_BANKING - PROT_1X_3DS - PROT_2X_3DS - XS2A - PERSONAL_ID_SYSTEM updatedTime: type: string description: Entity last update time format: date-time version: type: string description: RuleSetDTO version description: RuleSetDTO resource representation RuleSetDetailsResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/RuleSetDTO' description: The RuleSet DTO resource representation RuleSetExportDataResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/RulesetExportData' description: The RuleSet export data resource representation RuleSetListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array description: List of RuleSetDTO items: $ref: '#/components/schemas/RuleSetDTO' description: List of RuleSet DTO resource representation RuleSetStateRequestDTO: required: - comment - id - service - status - userID type: object properties: comment: type: string description: RuleSetStateRequestDTO comment deleteProd: type: boolean description: RuleSetStateRequestDTO deleteProd id: type: integer description: RuleSetStateRequestDTO id format: int64 service: type: string description: RuleSetStateRequestDTO service status: type: string description: RuleSetStateRequestDTO status enum: - PROD - BACKUP - DRAFT_EDIT - DRAFT_SUBMIT - DRAFT_TEST - DELETED - PRESET userID: type: string description: RuleSetStateRequestDTO userID description: RuleSetStateRequestDTO resource representation RulesetExportData: type: object properties: checksum: type: string description: RulesetExportData checksum ruleSet: $ref: '#/components/schemas/RuleSetDTO' description: RulesetExportData resource representation ScoreConfigDTO: type: object properties: active: type: boolean adviceServiceUrl: type: string alwaysRetrieveExternalScoring: type: boolean bypass3DS1: type: boolean createdTime: type: string format: date-time defaultDecision: type: string enum: - FRICTIONLESS - SCA - DECLINE - EXTRBADECISION defaultScore: type: integer format: int32 deletedTime: type: string format: date-time eligibleMerchantActive: type: boolean id: type: integer format: int64 important: type: boolean interfaceType: type: string enum: - THREE_DS - ONLINE_BANKING issuer: type: string originPriority: type: array items: type: string enum: - DS - DS_CB - DS_CB_BANK - DS_VISA - DS_MASTERCARD - EXTERNAL - ISSUER - DS_ISSUER - EXTERNAL_ISSUER providerType: type: string enum: - STET - SCORINGSTD - INFORM - MOCK relevantScore: type: boolean scoreServiceUrl: type: string service: type: string skipCounters: type: boolean subIssuer: type: string trustedBeneficiariesActive: type: boolean updatedTime: type: string format: date-time ScoreConfigListResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: type: array items: $ref: '#/components/schemas/ScoreConfigDTO' ScoreConfigResponse: type: object properties: error: $ref: '#/components/schemas/AuthenticationHUBError' success: $ref: '#/components/schemas/ScoreConfigDTO' ScoringProviderDTO: type: object properties: active: type: boolean adviceServiceUrl: type: string description: ScoringProviderDTO advice service url bypassNPA: type: boolean description: IssuerConfigDTO bypass NPA bypassSCHEME: type: string description: IssuerConfigDTO bypass SCHEME createdTime: type: string description: ScoringProviderDTO created time format: date-time deletedTime: type: string description: ScoringProviderDTO deleted time format: date-time id: type: integer description: ScoringProviderDTO id format: int64 ordinal: type: integer description: ScoringProviderDTO ordinal format: int32 providerType: type: string description: ScoringProviderDTO provider type enum: - STET - SCORINGSTD - INFORM - MOCK scoreServiceUrl: type: string description: ScoringProviderDTO score service url scoreType: type: string description: ScoringProviderDTO score type enum: - ISSUER - EXTERNAL updatedTime: type: string description: ScoringProviderDTO updated time format: date-time description: ScoringProviderDTO resource representation SearchEligibleMerchantsByPayeeRequestDTO: type: object properties: categories: type: array description: AbstractSearchRequest category type list items: type: string description: AbstractSearchRequest category type list enum: - SECURE_CORPORATE - TRUSTED_BENEFICIARIES_ACS - TRUSTED_BENEFICIARIES_3DS_SERVER - DELEGATED_AUTHENTICATION - TRA - RISK - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - LEVEL_5 issuer: type: string description: AbstractSearchRequest issuer payeeValue: type: string description: AbstractSearchRequest payee value service: type: string description: AbstractSearchRequest service size: type: integer description: AbstractSearchRequest size format: int32 start: type: integer description: AbstractSearchRequest start format: int32 subIssuer: type: string description: AbstractSearchRequest sub issuer description: SearchEligibleMerchantsByPayeeRequestDTO resource representation SearchEligibleMerchantsRequestDTO: type: object properties: categories: type: array description: AbstractSearchRequest category type list items: type: string description: AbstractSearchRequest category type list enum: - SECURE_CORPORATE - TRUSTED_BENEFICIARIES_ACS - TRUSTED_BENEFICIARIES_3DS_SERVER - DELEGATED_AUTHENTICATION - TRA - RISK - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - LEVEL_5 issuer: type: string description: AbstractSearchRequest issuer payeeType: type: string description: SearchEligibleMerchantsRequestDTO payee type enum: - MERCHANT_ID - MERCHANT_URL - MERCHANT_NAME - MERCHANT_MCC - MERCHANT_URL_CONTAINS - MERCHANT_URL_STARTS - MERCHANT_URL_ENDS payeeValue: type: string description: AbstractSearchRequest payee value service: type: string description: AbstractSearchRequest service size: type: integer description: AbstractSearchRequest size format: int32 start: type: integer description: AbstractSearchRequest start format: int32 subIssuer: type: string description: AbstractSearchRequest sub issuer description: SearchEligibleMerchantsRequestDTO resource representation SearchEligibleMerchantsResponseDTO: type: object properties: count: type: integer description: SearchEligibleMerchantsResponseDTO count format: int64 merchants: type: array description: SearchEligibleMerchantsResponseDTO merchants items: $ref: '#/components/schemas/EligibleMerchantDTO' description: SearchEligibleMerchantsResponseDTO resource representation ServiceDTO: required: - id - label type: object properties: id: type: integer description: ServiceDTO identifier format: int64 label: type: string description: ServiceDTO label service: type: string description: ServiceDTO resource representation TransactionActivityDTO: type: object properties: count: type: integer description: TransactionActivityDTO count format: int32 totalAmount: type: integer description: TransactionActivityDTO total amount format: int64 description: TransactionActivityDTO resource representation TransactionActivityRequest: type: object properties: service: type: string description: TransactionActivityRequest count tokenPan: type: string description: TransactionActivityRequest tokenPan description: TransactionActivityRequest resource representation TrustedBeneficiaryDTO: required: - payee - payeeType - payer - payerRef - payerType - service - type type: object properties: createdTime: type: string description: TrustedBeneficiaryDTO createdTime format: date-time deletedTime: type: string description: TrustedBeneficiaryDTO deletedTime format: date-time id: type: integer description: TrustedBeneficiaryDTO id format: int64 issuer: type: string description: TrustedBeneficiaryDTO issuer payee: type: string description: TrustedBeneficiaryDTO payee payeeType: type: string description: TrustedBeneficiaryDTO payeeType enum: - MERCHANT_ID - MERCHANT_URL - MERCHANT_NAME - MERCHANT_MCC - MERCHANT_URL_CONTAINS - MERCHANT_URL_STARTS - MERCHANT_URL_ENDS payer: type: string description: TrustedBeneficiaryDTO payer payerRef: type: string description: TrustedBeneficiaryDTO payerRef payerType: type: string description: TrustedBeneficiaryDTO payerType enum: - TOKEN - CARD_HOLDER_ID service: type: string description: TrustedBeneficiaryDTO service subIssuer: type: string description: TrustedBeneficiaryDTO subIssuer type: type: string description: TrustedBeneficiaryDTO type enum: - TRUST_LIST_3DSSERVER - TRUST_LIST_ACS - TRUST_LIST_DS - REFUSAL_TRUST_LIST_3DSSERVER - REFUSAL_TRUST_LIST_ACS updatedTime: type: string description: TrustedBeneficiaryDTO updatedTime format: date-time description: TrustedBeneficiaryDTO resource representation TrustedBeneficiaryExternalRequest: required: - service - type type: object properties: issuer: type: string description: TrustedBeneficiaryInternalRequest issuer pageSize: type: integer description: TrustedBeneficiaryInternalRequest page size format: int32 payerRef: type: string description: TrustedBeneficiaryInternalRequest payerRef payers: type: object additionalProperties: type: string description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\ \ type/value" description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\ \ type/value" service: type: string description: TrustedBeneficiaryInternalRequest service start: type: integer description: TrustedBeneficiaryInternalRequest start page format: int32 subIssuer: type: string description: TrustedBeneficiaryInternalRequest subIssuer type: type: string description: TrustedBeneficiaryInternalRequest type enum: - TRUST_LIST_3DSSERVER - TRUST_LIST_ACS - TRUST_LIST_DS - REFUSAL_TRUST_LIST_3DSSERVER - REFUSAL_TRUST_LIST_ACS withPayee: type: string description: TrustedBeneficiaryInternalRequest payee description: TrustedBeneficiaryInternalRequest resource representation TrustedBeneficiaryExternalResponse: type: object properties: totalCount: type: integer format: int32 trustedBeneficiaries: type: array items: $ref: '#/components/schemas/TrustedBeneficiaryDTO' TrustedBeneficiaryInternalRequest: required: - service - type type: object properties: issuer: type: string description: TrustedBeneficiaryInternalRequest issuer pageSize: type: integer description: TrustedBeneficiaryInternalRequest page size format: int32 payees: type: object additionalProperties: type: string description: "TrustedBeneficiaryInternalRequest payees, key/value - payee\ \ type/value" description: "TrustedBeneficiaryInternalRequest payees, key/value - payee\ \ type/value" payers: type: object additionalProperties: type: string description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\ \ type/value" description: "TrustedBeneficiaryInternalRequest payers, key/value - payer\ \ type/value" service: type: string description: TrustedBeneficiaryInternalRequest service start: type: integer description: TrustedBeneficiaryInternalRequest start page format: int32 subIssuer: type: string description: TrustedBeneficiaryInternalRequest subIssuer type: type: string description: TrustedBeneficiaryInternalRequest type enum: - TRUST_LIST_3DSSERVER - TRUST_LIST_ACS - TRUST_LIST_DS - REFUSAL_TRUST_LIST_3DSSERVER - REFUSAL_TRUST_LIST_ACS description: TrustedBeneficiaryInternalRequest resource representation UpdateAllRulesOrdinalsRequest: required: - ruleIds - rulesetId type: object properties: ruleIds: type: array description: UpdateAllRulesOrdinalsRequest rule ids items: type: integer description: UpdateAllRulesOrdinalsRequest rule ids format: int64 rulesetId: type: integer description: UpdateAllRulesOrdinalsRequest ruleset id format: int64 description: UpdateAllRulesOrdinalsRequest resource representation UpdateEligibleMerchantRequestDTO: required: - id - payeeType - payeeValue - service type: object properties: categories: uniqueItems: true type: array description: CreateEligibleMerchantRequestDTO categories items: type: string description: CreateEligibleMerchantRequestDTO categories enum: - SECURE_CORPORATE - TRUSTED_BENEFICIARIES_ACS - TRUSTED_BENEFICIARIES_3DS_SERVER - DELEGATED_AUTHENTICATION - TRA - RISK - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 - LEVEL_5 id: type: integer description: UpdateEligibleMerchantRequestDTO id format: int64 issuer: type: string description: CreateEligibleMerchantRequestDTO issuer payeeType: type: string description: CreateEligibleMerchantRequestDTO payee type enum: - MERCHANT_ID - MERCHANT_URL - MERCHANT_NAME - MERCHANT_MCC - MERCHANT_URL_CONTAINS - MERCHANT_URL_STARTS - MERCHANT_URL_ENDS payeeValue: type: string description: CreateEligibleMerchantRequestDTO payee value service: type: string description: CreateEligibleMerchantRequestDTO service subIssuer: type: string description: CreateEligibleMerchantRequestDTO sub issuer description: UpdateEligibleMerchantRequestDTO resource representation UpdateRuleOrdinalRequest: required: - ruleId - type type: object properties: ruleId: type: integer description: UpdateRuleOrdinalRequest rule id format: int64 type: type: string description: UpdateRuleOrdinalRequest type enum: - UP - DOWN description: UpdateRuleOrdinalRequest resource representation