Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Rules

Edit Rules Advanced

This web service allows to edit rules details.

post/pws/pws_edit_rules/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

parametersstring required

Parameters for rules.<ul><li class="docBullet">format of parameter is TAG:VALUE </li><li class="docBullet">parameter can be combination of multiple TAG:VALUE separated by semicolon(;) </li><li class="docBullet">VALUE can contain comma(,) separated multiple values </li><li class="docBullet">Accepted TAGS are MCC,TXN_CCY,CTRY</li><li class="docBullet">TXN_CCY=> transaction Currency DE49. (Three digit Numeric ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)</li> <li class="docBullet">MCC=> Merchant category code DE18.</li><li class="docBullet">CTRY=> Country (DE43_5). <ul><li>For Master card (Alpha Three country ISO codes. i.e. : Afghanistan → AFG, Australia → AUS) </li><li>For VISA (Alpha Two country ISO codes . i.e. : Afghanistan → AF, Australia → AU) </li><li>For Both (MC & VISA) :(Comma separated Alpha Three country ISO codes & Alpha Two country ISO codes i.e Afghanistan-> AFG,AF , Australia → AUS,AU )</li> </ul> </li></ul>

rule_idinteger required

Rule Id

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

rule_namestring

Rule Name

rule_typestring

Rule Type : <ul><li class="docBullet">Au = authorisation</li><li class="docBullet">Se = Settlement</li><li class="docBullet">Sc = Scheduled</li><li class="docBullet">Lo = Load</li><li class="docBullet">Un = Unload</li><li class="docBullet">Ot = Others</li><li class="docBullet">Da = Deactivated</li></ul>

severityinteger

Severity Level. It can be 0(lowest)-10(highest)

rule_descstring

Rule Description

suitable_for_estimateboolean
<ul><li class="docBullet">True = Rule is for limit check like (amount limit or transaction count limit)</li><li class="docBullet">False =Rule is not for limit check like (amount limit or transaction count limit)</li></ul>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "parameters": "MCC:6011,4444,1234,5543;TXN_CCY:826,400;CTRY:GBR,USA",
  "rule_id": 87,
  "rule_name": "Fraud Rule",
  "rule_type": "Au",
  "rule_desc": "Fraud Rule Description"
}

Response

Successful Response

bodyobject
headerInfo'success' | 'webserviceNotAvailable' | 'general' | 'TRANSIENT_ERROR' | 'databaseConnectionError' | 'dbConnectFailure' | 'dbExecuteTimeout' | 'databaseException' | 'authCodeFailure' | 'sendEmailFailure' | 'invalidAuthcode' | 'loginFailed' | 'INVALID_USER_NAME' | 'invalidPassword' | 'inactiveUser' | 'RESET_USER_PASSWORD' | 'FIRST_PASSWORD_CHANGE' | 'USER_EXISTS_ALREADY' | 'sessionInvalid' | 'sessionExpired' | 'sessionIdNotFound' | 'xApiKeyNotFound' | 'xApiKeyInvalid' | 'jsonValidator' | 'clientIdInvalid' | 'subClientIdInvalid' | 'invalidParentAccount' | 'ParentAccountNotFound' | 'invalidAccountId' | 'FAILED_TO_GET_CARD_LIST' | 'invalidApiCallIdentifier' | 'invalidToken' | 'modelValidationFailed' | 'booleanvalidationfailed' | 'timeWindowNotSupported' | 'permissionDeniedPws' | 'permissionDeniedPcjs' | 'configNotFound' | 'CONFIG_NOT_AVAILABLE_FOR_TOKEN' | 'TOKEN_DETAILS_NOT_FOUND' | 'dataNotFound' | 'accountNotFound' | 'accountMappingNotFound' | 'accountLimitNotFound' | 'RulesNotFound' | 'ccyInvalid' | 'amtCcyInvalid' | 'loadCcyInvalid' | 'clientProductNotUnique' | 'invalidManuId' | 'inValidManuIdClient' | 'invalidProductId' | 'cardRenewalFailed' | 'binNotFound' | 'cardImgNotFound' | 'tokenAccAssigned' | 'cardDeactivated' | 'accountNotProvided' | 'deliveryDetailFailed' | 'purchaserDetailFailed' | 'ptokAddFailed' | 'ptokDetailAddFailed' | 'FAILED_TO_CONVERT_VIRTUAL_TO_PHYSICAL' | 'cardConvertFailed' | 'batchIdError' | 'loadFailed' | 'weakCvv' | 'pvvNotSet' | 'weakpin' | 'Invalidepin' | 'invalidPinFormat' | 'accountUpdateFailed' | 'accountInsertFailed' | 'ParentAccountInsertFailed' | 'accountSetStatusFailed' | 'accountGetStatusFailed' | 'invalidEcno' | 'nullOrEmptyEcno' | 'createVirtualCardFailed' | 'createPhysicalCardFailed' | 'createCardImgFailedInPKS' | 'encryptFileFailed' | 'editCardStatusFailed' | 'sftpUploadFailed' | 'failedToGetToken' | 'setCardStatusFailed' | 'cardDetailNotFound' | 'tokenListNotFound' | 'ruleNotFound' | 'generatefileDataNotFound' | 'cardUnderAccount' | 'CARDLISTNOTFOUND' | 'cardUnderProduct' | 'cardUnderGroup' | 'MAKE_CARD_PRIMARY_FAILED' | 'panNotFound' | 'PAN_DOES_NOT_EXIST' | 'accountcardlink' | 'CARD_NOT_LINKED_TO_ACCOUNT' | 'cardhistoryNotFound' | 'accountHistoryNotFound' | 'integrityViolation' | 'updateCardDetailFailed' | 'updateTokFlagsFailed' | 'getPanNumberFailed' | 'smsCardHolderfailed' | 'emailCardHolderFailed' | 'enroll3DSFailed' | 'invalidFunctioncode' | 'mdesUpdateFailed' | 'pinUnblockFailed' | 'setPinFailed' | 'getPinFailed' | 'networkTypeError' | 'saveCardTestFailed' | 'EditTestCardFailed' | 'breakISOFailed' | 'builtISOFailed' | 'PKSSendFailed' | 'PKSReceiveFailed' | 'getMacFailed' | 'getArqcFailed' | 'getPinbFailed' | 'getTestCardFailed' | 'getTestSummaryFailed' | 'getTestMessageFailed' | 'getTestHierarchyFailed' | 'getTestListFailed' | 'getResponseFailed' | 'txnresultNotFound' | 'testDataNotFound' | 'saveTestFailed' | 'saveCardFailed' | 'invalidRuleID' | 'DEACTIVATED_RULE_UPDATE_FAILED' | 'loadAlertExists' | 'insertActionFailed' | 'ruleListNotFound' | 'groupruleLinkNotFound' | 'ruleHistoryNotFound' | 'ruleTimingLogNotFound' | 'ruleTriggerDetailNotFound' | 'ruleTemplateNotFound' | 'loadRuleNotFound' | 'InvalidGroupId' | 'InvalidProductId' | 'actionListNotFound' | 'alertactionListNotFound' | 'declineactionListNotFound' | 'dynamicactionListNotFound' | 'applyfeeactionListNotFound' | 'crdractionListNotFound' | 'incorrectRfcParam' | 'linkTagFailed' | 'unlinkTagFailed' | 'ruleTagAlreadyExists' | 'ruleTagDoesntExist' | 'deleteTagFailed' | 'deleteActionFailed' | 'invalidAction' | 'updateActionFailed' | 'insertRulesFailed' | 'updateRulesFailed' | 'deleteRulesFailed' | 'authUnblock' | 'EDIT_RULES_ACTION_PROCEDURE_CALL_FAILED' | 'DECISION_ENGINE_CREATE_RULE_FAILED' | 'DECISION_ENGINE_CREATE_TREE_FAILED' | 'clientsftpfailed' | 'updateRSAFailed' | 'createSubClientFailed' | 'updateSubClientFailed' | 'updateClientFailed' | 'errorInPKS' | 'createClientFailed' | 'emailAlreadyUsed' | 'addClientBin' | 'failedToAddEditClientBin' | 'clientListNotFound' | 'clientBinNotFound' | 'fastUrlNotFound' | 'sftpdetailNotFound' | 'subclientNotFound' | 'webNotassigned' | 'clientHierarchyNotFound' | 'reportDeliveryNotFound' | 'reportPreviewNotFound' | 'reportScheduleNotFound' | 'rsaPublicKeyNotFound' | 'merchantNotFound' | 'reasonCodeNotFound' | 'currencyCodeNotFound' | 'apiListNotFound' | 'vendorListNotFound' | 'instanceDetailNotFound' | 'exchangeRateDetailNotFound' | 'auditLogNotFound' | 'errorLogNotFound' | 'appLogNotFound' | 'stacktraceNotFound' | 'emailLogNotFound' | 'cardReportLogNotFound' | 'InsertFailed' | 'UpdateFailed' | 'DeleteFailed' | 'invalidGroupID' | 'updateGroupFailed' | 'createGroupFailed' | 'CREATE_TOKEN_GROUP_FAILED' | 'UPDATE_TOKEN_GROUP_FAILED' | 'TOKEN_GROUPS_NOT_FOUND' | 'RULE_FUNCTIONS_NOT_FOUND' | 'linkCardGroupFailed' | 'LINK_TOKEN_TO_TOKEN_GROUP_FAILED' | 'invalidGroupId' | 'GroupDetailNotFound' | 'linkCardGroupNotFound' | 'multiAccountFailed' | 'standInFailed' | 'createProductFailed' | 'insertCardStackFailed' | 'invalidImageId' | 'ImageNameNA' | 'editImageDataFailed' | 'saveImageFailed' | 'deleteProductFailed' | 'deleteGarbageProductFailed' | 'productNotEnabledFor3DS' | 'updateProductFailed' | 'productRuleNotFound' | 'productGroupNotFound' | 'virtualCardNotFound' | 'virtualCardPreviewNotFound' | 'productListNotFound' | 'dynamicAuthUnblockDataNotFound' | 'INVALID_SCA_LIMIT_FORMAT' | 'createManufactureFailed' | 'editManufactureFailed' | 'manufactureListNotFound' | 'payschedulerConnectionError' | 'deleteTaskFailed' | 'updateTaskFailed' | 'createTasKFailed' | 'createTasKFailedInPS' | 'jobDeprecated' | 'deactivateTaskFailed' | 'activateTaskFailed' | 'payschedulerErrorGettingLog' | 'executeTaskFailed' | 'invalidTaskId' | 'taskAlreadyExistForClient' | 'clientReportNotFound' | 'taskNotFound' | 'jobNotFound' | 'jobInstanceNotFound' | 'reportConfigNotFound' | 'jobLogNotFound' | 'retrieveRequestFailed' | 'feeRetrieveFailed' | 'invalidPartialAmount' | 'invalidReasonCode' | 'chargebackdataNotFound' | 'ISONotFound' | 'taskOwnerNotFound' | 'statementDetailNotFound' | 'txnNotFound' | 'feeDataNotFound' | 'retrievalDataNotFound' | 'txntimingDataNotFound' | 'fastRequestDataNotFound' | 'merchantdetailNotFound' | 'blockMerchantNotFound' | 'updateRightFailed' | 'insertUserGroupFailed' | 'linkRightFailed' | 'insertRightFailed' | 'deleteRightFailed' | 'updateScreenFailed' | 'updatePasswordFailed' | 'emailNotMatched' | 'updateUserFailed' | 'availableEmail' | 'EmailNotAvailable' | 'createUserFailed' | 'userGroupListNotFound' | 'userListNotFound' | 'userdetailNotFound' | 'userContactNotFound' | 'userNotFound' | 'rightNotAssigned' | 'userHistoryNotFound' | 'userAccessHistoryNotFound' | 'ConfigFileNotFound' | 'IncorrectConnectionString' | 'InvalidRequest' | 'CardAlreadyEnrolled' | 'NoSuchCardRange' | 'InternalError' | 'invalidCardData' | 'No3DSDetailFound' | 'FailedToDecryptPin' | 'FailedToSetPin' | 'FailedToEncrypt' | 'FailedToGetPanNumber' | 'FailedToGetPinNumber' | 'invalidCvv2' | 'FailedToDecryptCvv2' | 'FailedToGetCvv2Number' | 'RsaKeyNotFound' | 'SessionKeyAlreadyUsed' | 'FAILED_TO_DECRYPT_PAN' | 'PinNotMatching' | 'FailedToVerifyPin' | 'FAILED_TO_VERIFY_PIN_INVALID_PAN' | 'panNotAvailableInSystem' | 'FailedToDecryptSessionKey' | 'FailedToUpdateActionRequired' | 'FAILED_TO_GET_ECNO' | 'FailedToSaveIsoHierarchy' | 'FailedToSaveIsoDetails' | 'failedToGetPersoData' | 'failedToCalculateAVV' | 'failedToGeneratePVV' | 'DecodePvvToPinFailed' | 'failedToCalculateArqcArpc' | 'duplicateDataEntry' | 'cycleConfigFoundAlready' | 'duplicatepaymentEntry' | 'creditCycleAddedAlready' | 'productCycleAddedAlready' | 'chargeNotFound' | 'chargeHistoryNotFound' | 'interestNotFound' | 'interestHistoryNotFound' | 'merchantListNotFound' | 'mccGroupListNotFound' | 'mccCodeListNotFound' | 'graceperiodNotSet' | 'accountLimitNotSet' | 'accountLimitHistoryNotFound' | 'creditaccountLimitNotSet' | 'addChargeToAccountFailed' | 'addChargeToProductFailed' | 'addChargeToGroupFailed' | 'addInterestToProductFailed' | 'updateInterestToProductFailed' | 'addInterestToGroupFailed' | 'insertCreditGroupFailed' | 'accountGroupNotFound' | 'insertRewardFailed' | 'updateRewardFailed' | 'rewardListNotFound' | 'prodrewardListNotFound' | 'grouprewardListNotFound' | 'accountrewardListNotFound' | 'prodrewardHistoryListNotFound' | 'grouprewardHistoryListNotFound' | 'accountrewardHistoryListNotFound' | 'invalidRuleId' | 'balanceNotFound' | 'prodfeeConfigNotFound' | 'prodfeeConfigHistoryNotFound' | 'groupfeeConfigNotFound' | 'groupfeeConfigHistoryNotFound' | 'prodinterestConfigNotFound' | 'prodinterestConfigHistoryNotFound' | 'groupinterestConfigNotFound' | 'groupinterestConfigHistoyNotFound' | 'templateNotFound' | 'accounttemplateNotFound' | 'accountChargeListNotFound' | 'accountChargeListHistoryNotFound' | 'accountInterestListNotFound' | 'accountInterestHistoryNotFound' | 'InterestListNotFound' | 'InterestHistoryNotFound' | 'productChargeListNotFound' | 'creditbalanceDetailNotFound' | 'balanceDetailNotFound' | 'interestDetailNotFound' | 'creditStatementNotFound' | 'invalidBillingCycle' | 'creditCycleNotFound' | 'creditaccountCycleNotFound' | 'creditProductParamNotFound' | 'statementCycleNotFound' | 'insertChargeFailed' | 'insertCustomerFailed' | 'customerNotFound' | 'invalidInterestId' | 'insertInterestFailed' | 'linkaccountgroupFailed' | 'linkaccountgroupNotFound' | 'invalidCustomerId' | 'invalidCreditGroupId' | 'setPaymentDistributionFailed' | 'getPaymentDistributionFailed' | 'transactiondetailNotFound' | 'transactionHistoryNotFound' | 'customerAccountNotFound' | 'installmentEventNotFound' | 'installmentEntryNotFound' | 'installmentTemplateNotFound' | 'prodInstallmentConfigNotFound' | 'installmentTypeNotFound' | 'participantRoleTypeNotFound' | 'installmentCriteriaNotFound' | 'installmentCriteriaNotSet' | 'InvalidRid' | 'installmentReferenceNotSet' | 'installmentexecutionentryNotFound' | 'installmentstageNotFound' | 'contractStateNotFound' | 'contractStatusNotFound' | 'languageListNotFound' | 'clientContractNotFound' | 'installmenteligibletxnNotFound' | 'fee_section_already_found' | 'invalidprioritysection' | 'prioritysectionNotFound' | 'paymentDetailsDataNotFound' | 'guaranteelistNotFound' | 'invalidGuaranteeId' | 'addaccountguaranteeFailed' | 'accountguaranteeNotFound' | 'accountfeeDetailsNotFound' | 'miscellaneousfeeNotApplied' | 'manualfeeNotAppliedYet' | 'dateException' | 'effectivedateException' | 'postTxnCodeNotFound' | 'invalidExtTxnRefId' | 'defaultValue' | 'databaseinfoNotFound' | 'databasesizeInfoNotFound' | 'databasetableInfoNotFound' | 'dbconnectionInfoNotFound' | 'syshealthDataNotFound' | 'sandboxDataNotFound' | 'fastDataNotFound' | 'settlementNotFound' | 'settlementmessageNotFound' | 'regexDataNotFound' | 'mcInternalServerError' | 'claimExists' | 'firstCbRequested' | 'secondCbNotAllowed' | 'secondCbRequested' | 'cbApproved' | 'settlementMatchFailed' | 'cbCancelApproved' | 'cbCancelRejected' | 'cbCancelledAlready' | 'cbFirstPartyFraud' | 'mcChargebackNotFound' | 'mcDisputeCaseExists' | 'challengeProfileNotfound' | 'xCorrelationIdNotFound' | 'xIssuerIdNotFound' | 'xIssuerIdWrongSize' | 'xCorrelationIdTooLong' | 'operationFailed' | 'unknownCard' | 'cardSuspended' | 'invalidCVV2' | 'FpanProvisioningCountExceeded' | 'invalidFpan' | 'cardExpiryIssue' | 'tokenizationNotSupported' | 'fraudSuspected' | 'intTooLong' | 'UNSUPPORTED_TAV_DATA_FIELDS' | 'UNSUPPORTED_TAV_FORMAT' | 'UNSUPPORTED_SIGNING_ALGORITHM' | 'PROBLEM_WITH_TAV_SIGNATURE_SIGNING_FILE' | 'PROBLEM_WITH_TAV_SIGNATURE_SIGNING' | 'PROBLEM_WITH_CARD_DATA_ENCRYPTION_CERTIFICATE_FILE' | 'PROBLEM_WITH_CARD_DATA_ENCRYPTION' | 'PROBLEM_WITH_CARD_PASS_DATA_ENCRYPTION' | 'MEA_WALLET_CUSTOMER_SERVICE_INVALID_OBJECT' | 'MEA_WALLET_CUSTOMER_SERVICE_INVALID_FIELD_VALUE' | 'MEA_WALLET_CUSTOMER_SERVICE_MISSING_FIELD' | 'MEA_WALLET_CUSTOMER_SERVICE_BAD_REQUEST' | 'MEA_WALLET_CUSTOMER_SERVICE_INVALID_OPERATION' | 'MEA_WALLET_CUSTOMER_SERVICE_GATEWAY_TIMEOUT' | 'MEA_WALLET_CUSTOMER_SERVICE_TEMPORARY_UNAVAILABLE' | 'MEA_WALLET_CUSTOMER_SERVICE_NOT_IMPLEMENTED' | 'MEA_WALLET_CUSTOMER_SERVICE_UNAUTHORIZED' | 'MEA_WALLET_CRYPTO_IO_ERROR' | 'MADA_CUSTOMER_SERVICE_GENERAL_ERROR' | 'MADA_INVALID_TOKEN_UPDATE_REQUEST' | 'MADA_CARD_METADATA_PARTIAL_ERROR_IN_PTY' | 'MADA_CARD_METADATA_PARTIAL_ERROR_IN_TSP' | 'MADA_CARD_METADATA_UPDATE_FAILED' | 'MADA_CARD_METADATA_UPDATE_MISSING_CARD_METADATA_INFO' | 'MADA_CARD_METADATA_UPDATE_MISSING_PCID' | 'contactNotFound' | 'CUSTOMER_MISSES_PHONE_NUMBER_INFO' | 'INVALID_PASSCODE_DELIVERY_METHOD_TYPE' | 'CRYPTOGRAPHY_ERROR' | 'originalRequestPending' | 'INVALID_DATE_RANGE' | 'ALLOWABLE_DATE_DIFFERENCE_3DAYS_EXCEEDS' | 'VSE_ERROR_TOKEN_NOT_FOUND' | 'VSE_ERROR_INVALID_DATA' | 'VSE_ERROR_REQUIRED_DATA_MISSING' | 'VSE_ERROR_CRYPTOGRAPHY_ERROR' | 'VSE_INTERNAL_SYSTEM_ERROR' | 'VTS_FAILED_TO_CALL' | 'MEA_TOTP_KEY_HEX_ERROR' | 'MEA_CLIENT_CONFIG_NOT_FOUND' | 'MEA_INVALID_REASON_CODE' | 'MEA_FAILED_TO_ENCRYPT_ACCOUNT_INFO' | 'MEA_FAILED_TO_DELETE_TOKEN' | 'EMPTY_TUR_AND_ACCOUNT_ID' | 'EMPTY_PUBLIC_TOKEN' | 'MEA_CALL_RESPONSE_ERROR' | 'MEA_NOTIFY_CLIENT_ERROR' | 'BULK_CARD_INDIVIDUAL_CARD_DETAILS_SIZE_IS_DIFFERENT_THAN_TOTAL_CARD_AMOUNT' | 'BULK_CARD_EXPIRY_DATE_LESS_THAN_CURRENT_DATE' | 'BULK_CARD_NOT_ENOUGH_PAN_AVAILABLE_ON_STACK' | 'BULK_CARD_NOT_ENOUGH_PRIVATE_TOKEN_AVAILABLE_ON_STACK' | 'BULK_CARD_NOT_ENOUGH_PUBLIC_TOKEN_AVAILABLE_ON_STACK' | 'BULK_CARD_NOT_ENOUGH_CUSTOMER_AVAILABLE_ON_STACK' | 'UNSUPPORTED_NOTIFICATION_VERSION' | 'UNSUPPORTED_PERSO_FORMAT' | 'SAML_CREATE_AUTHN_REQUEST_ERROR' | 'SAML_TRANSFORMER_ERROR' | 'SAML_UNMARSHALL_ERROR' | 'SAML_VALIDATE_SIGNATURE_ERROR' | 'SAML_INVALID_EMAIL_DOMAIN_ERROR' | 'SAML_EMPTY_SAML_MESSAGE_ERROR' | 'SAML_CREATE_SESSION_ERROR' | 'SAML_VERIFY_SSO_LOGIN_ERROR' | 'SAML_GENERAL_MESSAGE_ERROR' | 'FAILED_UPDATING_CHIP_ACCOUNT' | 'DE_PAYMENTOLOGY_CLIENT_ID_MISSING' | 'DSL_PARSER_COMBINATOR_IS_MISSING' | 'DSL_PARSER_RULE_IS_MISSING' | 'DSL_PARSER_NODE_IS_MISSING' | 'DSL_UNABLE_TO_PARSE' | 'DE_VALIDATION_EXCEPTION' | 'DE_FEE_BASIS_INCORRECT' | 'VCAS_ERROR_TRANSACTION_EXPIRED' | 'VCAS_ERROR_STEP_UP_ID_NOT_FOUND' | 'VCAS_ERROR_STEP_UP_STATUS_INVALID' | 'VCAS_ERROR_STEP_UP_FIELD_MISMATCH' | 'AUTH0_CREATE_SESSION_ERROR' | 'AUTH0_FAILED_TO_GET_ACCESS_TO_THIS_APPLICATION' | 'AUTH0_FAILED_TO_LOGIN_ERROR' | 'SCA_LIMIT_NOT_FOUND' | 'SCA_INTERNAL_ERROR' | 'BAD_REQUEST'

Example response

{
  "header": {
    "error_desc": "success"
  }
}