{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/paymentapi/operation/getPositivePayRule/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/paymentapi/operation/getPositivePayRule/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Payment API\",\"version\":\"2.6.6\"},\"servers\":[{\"url\":\"https://sandbox-security-uat.finzly.io/auth/realms/BANKOS.UAT.SANDBOX.CUSTOMER/protocol/openid-connect/token\",\"description\":\"Authentication\",\"variables\":{\"tenant\":{\"description\":\"Tenant\",\"default\":\"sandbox\"}}}],\"security\":[{\"oAuth2\":[\"roles\"]}],\"tags\":[{\"name\":\"Payments\",\"description\":\"Payments APIs enables third-parties, banks, and bank's downstream partners to initiate and manage payments for their customers.\\n\\nThe single payment API support the payment origination for the various payment rails such as ACH, FedWire, Instant Payments based on the speed preference.\\n\\nFollowing use cases helps you to understand the current payment capabilities exposed via Finzly Connect APIs.\\n\\n1. Initiate Credit Payment\\n2. Initiate Debit Payment\\n3. Get Payment Details\\n4. Search Payments\\n5. Cancel a Payment\\n6. Return a Payment\\n7. Reverse a Payment\\n8. Transfer (Book) Payment\\n\"},{\"name\":\"Bulk Payment\",\"description\":\"This feature allows customers to upload bulk payments and process them seamlessly. Following payment, rails are supported.\\n  1. ACH - NACHA format\\n  2. Wire\\n  3. RTP\\n  4. FedNow.\\n\"},{\"name\":\"Bank\",\"description\":\"To fetch the bank info by routing number.\\n\"},{\"name\":\"Positive Pay\",\"description\":\"Positive Pay Rules APIs enable third-parties, bank's customers and downstream partners to define positive rules for ACH debits or Fedwire drawdown requests or RFP (Request For Pay) request.\\n\\nPositive Pay Exeption APIs enable users to approve or reject the exceptions identified by the positive pay rules engine.\\n\"}],\"paths\":{\"/v1/payments/customers/{customerUID}/files/{fileType}\":{\"post\":{\"tags\":[\"Bulk Payment\"],\"summary\":\"To upload the payment file.\",\"description\":\"This feature allows customers to upload bulk payments and process them seamlessly. Following payment, rails are supported. 1. ACH - NACHA format 2. Wire 3. RTP 4. FedNow\",\"operationId\":\"bulkUpload\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique Id.\"}},{\"name\":\"fileType\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"File type. Possible values are csv/fedwire/rtp/ach.\"}}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\"}},\"description\":\"Only csv and txt files formates are allowed.\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the uploaded file was processed successfully.\",\"example\":\"'payments.csv' uploaded successfully.\"}}},\"examples\":{\"fileUploaded\":{\"summary\":\"File uploaded successfully\",\"value\":{\"message\":\"'payments.csv' uploaded successfully.\"}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BulkPaymentResponse\"},\"examples\":{\"missingFile\":{\"summary\":\"Missing file part\",\"value\":{\"message\":\"Required part 'file' is not present.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BulkPaymentResponse\"},\"examples\":{\"missingFile\":{\"summary\":\"Unexpected error\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v1/files/search\":{\"post\":{\"tags\":[\"Bulk Payment\"],\"summary\":\"Search files\",\"description\":\"Search files based on file name or file number. One of the fields (fileName or fileNumber) is mandatory. File number must be numeric only.\",\"operationId\":\"searchFiles\",\"parameters\":[{\"name\":\"page\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":1,\"default\":1}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":10,\"default\":10}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\",\"description\":\"The name of the file to search for.\\nAt least one of **fileName** or **fileNumber** must be provided.\\nIf both are provided, the search will use both.\\nThis value is typically the filename as uploaded or processed in the system.\\n\",\"example\":\"FEDWIRE_CSV_TEST\"},\"fileNumber\":{\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Number of the file to search.\\nAt least one of **fileName** or **fileNumber** must be provided.\\nIf both are provided, the search will use both.\\n\",\"example\":\"1045\"}},\"description\":\"Request payload for searching files.\\nAt least one of **fileName** or **fileNumber** must be provided.\\nIf both are provided, the search will use both parameters.\\nThe **fileNumber** field accepts only numeric values.\\n\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"pagination\":{\"type\":\"object\",\"properties\":{\"pageReturned\":{\"type\":\"integer\",\"example\":1},\"pageSize\":{\"type\":\"integer\",\"example\":10},\"returnedRecords\":{\"type\":\"integer\",\"example\":10},\"totalRecords\":{\"type\":\"integer\",\"example\":100}}},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/FileSearchResponse\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"example\":\"FILENUMBER_NUMBER\"},\"message\":{\"type\":\"string\",\"example\":\"File number allow only numbers.\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"File number allow only numbers.\"},\"code\":{\"type\":\"string\",\"example\":\"FILENUMBER_NUMBER\"}}}}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Unexpected Error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}}}}},\"/v1/files/{fileNumber}/payments\":{\"get\":{\"tags\":[\"Bulk Payment\"],\"summary\":\"Get payments by file number\",\"description\":\"Retrieve payments associated with a specific file. Supports pagination with default values of page=1 and limit=10.\",\"operationId\":\"getFilePayments\",\"parameters\":[{\"name\":\"fileNumber\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"example\":\"9247\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":1,\"default\":1}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":10,\"default\":10}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved file payments\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"pagination\":{\"type\":\"object\",\"properties\":{\"pageReturned\":{\"type\":\"integer\",\"example\":1},\"pageSize\":{\"type\":\"integer\",\"example\":1000},\"returnedRecords\":{\"type\":\"integer\",\"example\":1},\"totalRecords\":{\"type\":\"integer\",\"example\":1000}}},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/FilePaymentResponse\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the type of failure.\"},\"message\":{\"type\":\"string\",\"description\":\"Human-readable error message describing the issue.\"},\"data\":{\"type\":\"object\",\"description\":\"Always null on error responses.\",\"nullable\":true},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code for identifying the issue.\"}}}}}},\"examples\":{\"fileNotFound\":{\"summary\":\"Bulk file not found\",\"value\":{\"code\":\"BulkFileNotFoundException\",\"message\":\"Bulk file not found for file number: 85111150\",\"errors\":[{\"message\":\"Bulk file not found for file number: 85111150\",\"code\":\"BulkFileNotFoundException\"}]}},\"unsupportedFileType\":{\"summary\":\"Unsupported file type\",\"value\":{\"code\":\"UnsupportedFileTypeException\",\"message\":\"Unsupported file type for file number: 85111150\",\"errors\":[{\"message\":\"Unsupported file type for file number: 85111150\",\"code\":\"UnsupportedFileTypeException\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Unexpected Error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v1/banks/{routingNumber}\":{\"get\":{\"tags\":[\"Bank\"],\"summary\":\"To fetch the bank information.\",\"description\":\"To fetch the bank details based on bank routing number.\\n⚠️ This endpoint is deprecated and will be removed in the future. Please switch to `/v1/banks`\\n\",\"operationId\":\"fetchBankInfo\",\"parameters\":[{\"name\":\"routingNumber\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[0-9]{9}$\",\"type\":\"string\",\"description\":\"Bank ABA routing number. Must be exactly 9 numeric digits.\\n\"},\"example\":\"021000021\"}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BankResponse\"}}}},\"400\":{\"description\":\"Bad request — routing number format invalid or not found in the system.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"example\":\"ROUTING_NUMBER_INVALID\"},\"message\":{\"type\":\"string\",\"example\":\"The routingNumber should be 9 digit.\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"example\":\"ROUTING_NUMBER_INVALID\"},\"message\":{\"type\":\"string\",\"example\":\"The routingNumber should be 9 digit.\"}}}}}},\"examples\":{\"validationError\":{\"summary\":\"Routing number format invalid\",\"value\":{\"code\":\"ROUTING_NUMBER_INVALID\",\"message\":\"The routingNumber should be 9 digit.\",\"errors\":[{\"code\":\"ROUTING_NUMBER_INVALID\",\"message\":\"The routingNumber should be 9 digit.\"}]}},\"notFound\":{\"summary\":\"Routing number not found\",\"value\":{\"code\":\"ROUTING_NUMBER_NOTFOUND\",\"message\":\"The provided routing number is either invalid or not configured in the system\",\"errors\":[{\"code\":\"ROUTING_NUMBER_NOTFOUND\",\"message\":\"The provided routing number is either invalid or not configured in the system\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}},\"deprecated\":true}},\"/v1/banks/search/{routingNumber}\":{\"get\":{\"tags\":[\"Bank\"],\"summary\":\"Search bank information by routing number prefix.\",\"description\":\"To search the bank details based on bank routing number.\",\"operationId\":\"searchBankInfo\",\"parameters\":[{\"name\":\"routingNumber\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Accepts partial routing number prefix (e.g., \\\"021\\\")\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BankSearchResponse\"}}}},\"400\":{\"description\":\"Bad request — routing number format invalid or not found in the system.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"example\":\"ROUTING_NUMBER_NOTFOUND\"},\"message\":{\"type\":\"string\",\"example\":\"The provided routing number is either invalid or not configured in the system.\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"example\":\"ROUTING_NUMBER_NOTFOUND\"},\"message\":{\"type\":\"string\",\"example\":\"The provided routing number is either invalid or not configured in the system.\"}}}}}},\"examples\":{\"notFound\":{\"summary\":\"Routing number not found\",\"value\":{\"code\":\"ROUTING_NUMBER_NOTFOUND\",\"message\":\"The provided routing number is either invalid or not configured in the system\",\"errors\":[{\"code\":\"ROUTING_NUMBER_NOTFOUND\",\"message\":\"The provided routing number is either invalid or not configured in the system\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v1/banks\":{\"get\":{\"tags\":[\"Bank\"],\"summary\":\"Fetch bank information by BIC, IBAN, or NID\",\"description\":\"Retrieve detailed bank information using one of three identifier\\ntypes: NID (9-digit routing number), BIC (SWIFT code), or IBAN.\\n\\nFormat rules per bankIdType:\\n  - NID:  Exactly 9 numeric digits. No all-zeros. (e.g., \\\"021000021\\\")\\n  - BIC:  8 or 11 alphanumeric characters (A-Z, 0-9). No all-zeros.\\n          (e.g., \\\"DEUTDEFF\\\" or \\\"DEUTDEFFXXX\\\")\\n  - IBAN: Up to 34 alphanumeric characters (A-Z, 0-9). No all-zeros.\\n          countryCode is REQUIRED when bankIdType is IBAN.\\n          First 2 characters of IBAN must match countryCode.\\n\",\"operationId\":\"getbank\",\"parameters\":[{\"name\":\"bankId\",\"in\":\"query\",\"description\":\"The bank identifier. Format depends on bankIdType:\\n- NID: Exactly 9 digits (0-9). No all-zeros.\\n- BIC: 8 or 11 alphanumeric chars (A-Z, 0-9). No all-zeros.\\n- IBAN: Up to 34 alphanumeric chars. First 2 chars must\\n        match countryCode. No all-zeros.\\n\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"maxLength\":34,\"type\":\"string\"}},{\"name\":\"bankIdType\",\"in\":\"query\",\"description\":\"The type of bank identifier. When set to \\\"IBAN\\\", countryCode is required.\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"enum\":[\"NID\",\"BIC\",\"IBAN\"]}},{\"name\":\"countryCode\",\"in\":\"query\",\"description\":\"Required only when bankIdType is \\\"IBAN\\\". The ISO 3166 country code.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successful response\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"institutionName\":{\"type\":\"string\",\"description\":\"Bank name.\",\"example\":\"1ST SOURCE BANK\"},\"streetAddress1\":{\"type\":\"string\",\"description\":\"Bank address1.\",\"example\":\"PO BOX 1602\"},\"streetAddress2\":{\"type\":\"string\",\"description\":\"Bank address2.\",\"nullable\":true,\"example\":\"PO\"},\"city\":{\"type\":\"string\",\"description\":\"Bank city.\",\"example\":\"SOUTH BEND\"},\"zipCode\":{\"type\":\"string\",\"description\":\"Bank zip code.\",\"example\":\"46634\"},\"countryName\":{\"type\":\"string\",\"description\":\"Bank country name.\",\"example\":\"USA\"},\"isoCountryCode\":{\"type\":\"string\",\"description\":\"Bank country code.\",\"example\":\"US\"},\"bic\":{\"type\":\"string\",\"description\":\"Bank bic.\",\"nullable\":true,\"example\":\"INGDDEFFXXX\"},\"branchBic\":{\"type\":\"string\",\"description\":\"Bank branch bic.\",\"nullable\":true,\"example\":\"XXX\"},\"nationalIdType\":{\"type\":\"string\",\"description\":\"Bank national identifier type.\",\"example\":\"ABA\"},\"nationalId\":{\"type\":\"string\",\"description\":\"Bank national identifier.\",\"example\":\"071212128\"},\"deliveryMethods\":{\"type\":\"array\",\"description\":\"List of delivery methods.\",\"example\":[\"ACH\",\"RTP\"],\"items\":{\"type\":\"string\"}}}}}}}}},\"400\":{\"description\":\"Bad request — missing/invalid parameters, validation failure,\\nor bank not found.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"code\":{\"type\":\"string\"}}}}}},\"examples\":{\"missingBankId\":{\"summary\":\"bankId is required\",\"value\":{\"errors\":[{\"message\":\"bankId is required.\",\"code\":\"BANK_BANKID_REQUIRED\"}]}},\"ibanMissingCountry\":{\"summary\":\"countryCode required for IBAN\",\"value\":{\"errors\":[{\"message\":\"countryCode is required for IBAN.\",\"code\":\"BANK_COUNTRYCODE_REQUIRED\"}]}},\"countrySizeMismatch\":{\"summary\":\"countryCode must be 2 characters\",\"value\":{\"errors\":[{\"message\":\"countryCode must be exactly 2 characters.\",\"code\":\"BANK_COUNTRYCODE_EXACT\"}]}},\"ibanCountryMismatch\":{\"summary\":\"IBAN and countryCode mismatch\",\"value\":{\"errors\":[{\"message\":\"IBAN first 2 characters must match countryCode.\",\"code\":\"BANK_BANKID_NOMATCH\"}]}},\"bankNotFound\":{\"summary\":\"Bank not found\",\"value\":{\"errors\":[{\"message\":\"No bank could be found with the provided Bank ID. Please check the Bank ID and try again.\\n\",\"code\":\"BANK_BANKID_NOTFOUND\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v2/positivepay/rules/search\":{\"post\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Search PositivePay Rules\",\"description\":\"Search positive pay rules\",\"operationId\":\"searchPositivePayRules\",\"parameters\":[{\"name\":\"page\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page index. And it a mandatory.\",\"example\":1}},{\"name\":\"records\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page size. And it a mandatory.\",\"example\":10}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchPositivePayRuleRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Message associated with the response, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PositivePayRule\"}},\"pagination\":{\"type\":\"object\",\"properties\":{\"totalRecords\":{\"type\":\"integer\",\"description\":\"Total number of records available.\",\"example\":96},\"pageReturned\":{\"type\":\"integer\",\"description\":\"Current page returned in the response.\",\"example\":1},\"pageSize\":{\"type\":\"integer\",\"description\":\"Number of records returned per page.\",\"example\":10}}}}},\"examples\":{\"positivePayRulesFound\":{\"summary\":\"Positive pay rules retrieved successfully\",\"value\":{\"status\":\"Success\",\"data\":[{\"paymentRuleType\":\"ACH\",\"customerName\":\"CORP1\",\"customerAccountNumber\":\"90897861\",\"beneBankId\":\"071212128\",\"beneName\":\"allow retry\",\"amount\":43452,\"currency\":\"USD\",\"amountType\":\"Maximum\",\"frequency\":\"ONE_TIME\",\"secCode\":\"ALL\",\"ruleUID\":897,\"status\":\"Active\",\"customerRoutingNumber\":\"071212128\",\"transactionIdNumber\":\"234324\",\"authType\":\"DEBIT\",\"customerAccountType\":\"Deposit\",\"customerAccountSubType\":\"Checking\",\"tranCode\":\"27\",\"authorizationUntil\":\"Until Cancelled\",\"numberOfPayments\":1,\"achCompanyID\":\"3435232\",\"effectiveDate\":\"04-16-2026\"}],\"pagination\":{\"totalRecords\":96,\"pageReturned\":1,\"pageSize\":10}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to search positive pay rules: <Reason>\"}}},\"examples\":{\"invalidPage\":{\"summary\":\"Invalid page number\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"Invalid page number. Page must be greater than 0.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"An unexpected error occurred while processing the request.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"An unexpected error occurred while processing the request.\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/positivepay/rules\":{\"post\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Create PositivePay Rule - V3\",\"description\":\"Create positive pay rule.\",\"operationId\":\"v3addPositiveRules\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3CreatePositivePayRule\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3CreatePositivePayRuleResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"code\",\"errors\",\"message\"],\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Top-level error code representing the primary validation or business failure.\",\"example\":\"PPR_CUSTNAME_REQUIRED\",\"deprecated\":true},\"message\":{\"type\":\"string\",\"description\":\"Top-level error message representing the primary validation or business failure.\",\"example\":\"Customer Name is required.\",\"deprecated\":true},\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Customer Name is required.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"PPR_CUSTNAME_REQUIRED\"}}}}}},\"examples\":{\"validationFailure\":{\"summary\":\"Multiple validation errors\",\"value\":{\"code\":\"PPR_CUSTNAME_REQUIRED\",\"message\":\"Customer Name is required.\",\"errors\":[{\"message\":\"Customer Name is required.\",\"code\":\"PPR_CUSTNAME_REQUIRED\"},{\"message\":\"Past effective date is not allowed.\",\"code\":\"PPR_EFFECTDATE_PAST\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\n\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Failed to complete the task, please try again later\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"PPR_API_ERROR\"}}}}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/positivepay/rules/{ruleUID}\":{\"patch\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Update PositivePay Rule - V3\",\"description\":\"Update positive pay rule.\",\"operationId\":\"v3UpdatePositiveRules\",\"parameters\":[{\"name\":\"ruleUID\",\"in\":\"path\",\"description\":\"Positive Pay Rule Unique ID\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"default\":\"11223\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3UpdatePositivePayRule\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"code\",\"errors\",\"message\"],\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Top-level error code representing the primary validation or business failure.\",\"example\":\"PPR_CUSTNAME_REQUIRED\",\"deprecated\":true},\"message\":{\"type\":\"string\",\"description\":\"Top-level error message representing the primary validation or business failure.\",\"example\":\"Customer Name is required.\",\"deprecated\":true},\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Customer Name is required.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"PPR_CUSTNAME_REQUIRED\"}}}}}},\"examples\":{\"validationFailure\":{\"summary\":\"Multiple validation errors\",\"value\":{\"code\":\"PPR_CUSTNAME_REQUIRED\",\"message\":\"Customer Name is required.\",\"errors\":[{\"message\":\"Customer Name is required.\",\"code\":\"PPR_CUSTNAME_REQUIRED\"},{\"message\":\"Past effective date is not allowed.\",\"code\":\"PPR_EFFECTDATE_PAST\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\n\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Failed to update positive pay: An unexpected error occured\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"PPR_API_ERROR\"}}}}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v2/positivepay/rules\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Update PositivePay Rule - V2\",\"description\":\"Update Positive Pay Rule.\\n- ⚠️ This endpoint is deprecated and will be removed.\\n- Please switch to **v3 PATCH**: `/v3/positivepay/rules/{ruleUID}`\\n\",\"operationId\":\"updateRules\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdatePositivePayRuleRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the result of the update operation.\",\"nullable\":true,\"example\":\"Positive rules updated successfully\"},\"ruleUID\":{\"type\":\"integer\",\"description\":\"Unique identifier of the updated positive pay rule.\",\"example\":869}}},\"examples\":{\"positivePayRuleUpdated\":{\"summary\":\"Positive pay rule updated successfully\",\"value\":{\"status\":\"Success\",\"message\":\"Positive rules updated successfully\",\"ruleUID\":869}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PP001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Failed to update a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id. Null on error.\",\"format\":\"int64\",\"nullable\":true}}},\"examples\":{\"missingRuleUID\":{\"summary\":\"Missing ruleUID\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"ruleUID is mandatory to update the rule.\"}},\"ruleNotFound\":{\"summary\":\"Rule not found\",\"value\":{\"status\":\"Failure\",\"code\":\"PP001\",\"message\":\"Fail to get rule details for 11223\"}},\"nonUsdCurrency\":{\"summary\":\"Non-USD currency\",\"value\":{\"status\":\"Failure\",\"code\":\"PP001\",\"message\":\"Positive pay rules is not supported for the international currency.\"}},\"updateFailed\":{\"summary\":\"Update failed\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"Failed to update the rule.\"}},\"validationError\":{\"summary\":\"Field validation error\",\"value\":{\"status\":\"Failure\",\"code\":\"PP001\",\"message\":\"customerAccountNumber is a mandatory field.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"An unexpected error occurred while processing the request.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"An unexpected error occurred while processing the request.\"}}}},\"503\":{\"description\":\"Service unavailable\"}},\"deprecated\":true},\"post\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Add PositivePay Rule - V2\",\"description\":\"Add positive pay rule.\\n\\n- ⚠️ This endpoint is deprecated and will be removed.\\n- Please switch to **v3 POST**: `/v3/positivepay/rules`\\n\",\"operationId\":\"addPositiveRules\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddPositivePayRule\"}}}},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the result of the update operation.\",\"nullable\":true,\"example\":\"Positive rules created successfully\"},\"ruleUID\":{\"type\":\"integer\",\"description\":\"Unique identifier of the updated positive pay rule.\",\"example\":869}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PP001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Failed to add a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":123456789}}},\"examples\":{\"validationError\":{\"summary\":\"Missing required field\",\"value\":{\"status\":\"Failure\",\"code\":\"PP001\",\"message\":\"paymentRuleType is a mandatory field.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Failed to complete the task,please try again later.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"Failed to complete the task,please try again later.\"}}}},\"503\":{\"description\":\"Service unavailable\"}},\"deprecated\":true}},\"/v2/positivepay/rules/{ruleUID}\":{\"get\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Get PositivePay Rule By RuleUID\",\"description\":\"Get Positive Pay Rule\",\"operationId\":\"getPositivePayRule\",\"parameters\":[{\"name\":\"ruleUID\",\"in\":\"path\",\"description\":\"Positive Pay Rule unique id\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"default\":\"11223\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Message associated with the response, if applicable.\",\"nullable\":true},\"data\":{\"$ref\":\"#/components/schemas/PositivePayRule\"}}},\"examples\":{\"positivePayRuleFound\":{\"summary\":\"Positive pay rule retrieved successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentRuleType\":\"ACH\",\"customerName\":\"apiCorp\",\"customerAccountNumber\":\"samezeroBalance12\",\"beneBankId\":\"071212128\",\"beneName\":\"ApiBene\",\"amount\":15,\"currency\":\"USD\",\"amountType\":\"Maximum\",\"frequency\":\"ON_GOING\",\"secCode\":\"ALL\",\"ruleUID\":689,\"status\":\"Active\",\"customerRoutingNumber\":\"071212128\",\"authType\":\"DEBIT\",\"customerAccountType\":\"Deposit\",\"customerAccountSubType\":\"Checking\",\"tranCode\":\"27\",\"authorizationUntil\":\"Until Cancelled\",\"achCompanyID\":\"1234567890\",\"effectiveDate\":\"02-24-2026\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to get positive rule: Rule (1223) details not found\"}}},\"examples\":{\"ruleNotFound\":{\"summary\":\"Rule not found\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"Failed to get positive rule: Rule (85111150) details not found\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"An unexpected error occurred while processing the request.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API900\",\"message\":\"An unexpected error occurred while processing the request.\"}}}},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetPositivePayRuleUIDResponse\"}}}}}},\"delete\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Delete PositivePay\",\"description\":\"Delete positive pay rule.\",\"operationId\":\"deleteRules\",\"parameters\":[{\"name\":\"ruleUID\",\"in\":\"path\",\"description\":\"Positive Pay Rule Unique Id\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"format\":\"int64\",\"example\":1}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the result of the delete operation.\",\"nullable\":true,\"example\":\"Positive rule deleted successfully!\"},\"ruleUID\":{\"type\":\"integer\",\"description\":\"Unique identifier of the deleted positive pay rule.\",\"example\":689}}},\"examples\":{\"positivePayRuleDeleted\":{\"summary\":\"Positive pay rule deleted successfully\",\"value\":{\"status\":\"Success\",\"message\":\"Positive rule deleted successfully!\",\"ruleUID\":689}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PP001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Fail to delete rule: The rule (11223) is already Expired.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":11223}}},\"examples\":{\"expiredRule\":{\"summary\":\"Rule already expired\",\"value\":{\"status\":\"Failure\",\"code\":\"PP001\",\"message\":\"Fail to delete rule: The rule (11223) is already Expired.\",\"ruleUID\":11223}},\"ruleNotFound\":{\"summary\":\"Rule not found\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"Fail to delete rule: The rule (11223) details not found in the system.\",\"ruleUID\":11223}},\"unauthorizedRule\":{\"summary\":\"Not authorized for rule\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"You are not authorized to access the positive pay rule.\",\"ruleUID\":11223}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Please try again later\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"Failed to complete the task, please try again later\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v2/positivepay/rules/{ruleUID}/activate\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Activate PositivePay Rule\",\"description\":\"Activate positive pay rule\",\"operationId\":\"activatePositivePayRule\",\"parameters\":[{\"name\":\"ruleUID\",\"in\":\"path\",\"description\":\"Positive Pay Rule Unique Id\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the result of the activated operation.\",\"nullable\":true,\"example\":\"Rule activated successfully.\"},\"ruleUID\":{\"type\":\"integer\",\"description\":\"Unique identifier of the activated positive pay rule.\",\"example\":677}}},\"examples\":{\"positivePayRuleSuspended\":{\"summary\":\"Positive pay rule activated successfully\",\"value\":{\"status\":\"Success\",\"message\":\"Rule activated successfully.\",\"ruleUID\":677}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Rule (11223) already in 'ACTIVE' status\"}}},\"examples\":{\"alreadyActive\":{\"summary\":\"Rule already active\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"Rule (11223) already in 'ACTIVE' status\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"An unexpected error occurred while processing the request.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API900\",\"message\":\"An unexpected error occurred while processing the request.\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v2/positivepay/rules/{ruleUID}/suspend\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Suspend PositivePay Rule\",\"description\":\"Suspend positive pay rule.\",\"operationId\":\"suspendPositivePayRule\",\"parameters\":[{\"name\":\"ruleUID\",\"in\":\"path\",\"description\":\"Positive Pay Rule Unique Id\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the result of the suspend operation.\",\"nullable\":true,\"example\":\"Rule suspended successfully.\"},\"ruleUID\":{\"type\":\"integer\",\"description\":\"Unique identifier of the suspended positive pay rule.\",\"example\":677}}},\"examples\":{\"positivePayRuleSuspended\":{\"summary\":\"Positive pay rule suspended successfully\",\"value\":{\"status\":\"Success\",\"message\":\"Rule suspended successfully.\",\"ruleUID\":677}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"Rule (11223) already in 'SUSPENDED' status\"}}},\"examples\":{\"alreadySuspended\":{\"summary\":\"Rule already suspended\",\"value\":{\"status\":\"Failure\",\"code\":\"POSITIVERULE001\",\"message\":\"Rule (11223) already in 'SUSPENDED' status\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating what failed and how to fix the issue.\",\"example\":\"An unexpected error occurred while processing the request.\"}}},\"example\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"An unexpected error occurred while processing the request.\"}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"suspend positive rule\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayRuleResponse\"}}}}}}},\"/v2/positivepay/exception/search\":{\"post\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Search PositivePay Exceptions\",\"description\":\"Return positive pay exceptions for a given criteria.\",\"operationId\":\"searchPositivePayExceptions\",\"parameters\":[{\"name\":\"page\",\"in\":\"query\",\"description\":\"1-based page index. Minimum value is 1.\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":1}},{\"name\":\"records\",\"in\":\"query\",\"description\":\"Page size. Must be between 1 and 100.\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"integer\",\"example\":10}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchPositivePayDecisionRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchPositivePayDecisionResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V2ErrorResponse\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V2ErrorResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v1/positivepay/payments/{paymentId}/decisions/{decisionType}\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Approve or Reject PositivePay Exception\",\"description\":\"Approve or Reject Positive Pay Exception of a payment.\\n- ⚠️ This endpoint is deprecated and will be removed.\\n- Please switch to the v2 decision-specific endpoints:\\n- **Approve** - `/v2/positivepay/exception/{paymentId}/approve`\\n- **Reject** - `/v2/positivepay/exception/{paymentId}/reject`\\n\",\"operationId\":\"approveorrejectexception\",\"parameters\":[{\"name\":\"paymentId\",\"in\":\"path\",\"description\":\"Payment unique identifier.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"decisionType\",\"in\":\"path\",\"description\":\"Allowed values are Approve or Reject.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK - Request processed successfully\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"paymentId\":{\"type\":\"string\",\"example\":\"376454\"},\"message\":{\"type\":\"string\",\"example\":\"Exception approved successfully.\"}}},\"examples\":{\"successResponse\":{\"summary\":\"Successful approval response\",\"value\":{\"paymentId\":\"376454\",\"message\":\"Exception approved successfully.\"}}}}}},\"400\":{\"description\":\"Bad Request - Invalid input or validation error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"Invalid decision type.\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"Invalid decision type.\"}}}}}},\"examples\":{\"invalidDecisionType\":{\"summary\":\"Invalid decision type error\",\"value\":{\"message\":\"Invalid decision type.\",\"errors\":[{\"message\":\"Invalid decision type.\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Approve or Reject Positive Pay Exception Response.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ApproveOrRejectPositivePayExceptionResponse\"}}}}},\"deprecated\":true}},\"/v2/positivepay/exception/{paymentId}/approve\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Approve PositivePay Exception\",\"description\":\"Approve Positive Pay Exceptions\",\"operationId\":\"approvePositivePayException\",\"parameters\":[{\"name\":\"paymentId\",\"in\":\"path\",\"description\":\"A unique identifier associated with the positive pay rule exception\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"acceptedAmount\",\"in\":\"query\",\"description\":\"**Optional Query Parameter for RFP (Request for Payment) Exceptions**\\n\\nAllows you to modify the payment amount when approving a positive pay exception\\nfor instant payment rails (FedNow, RTP).\\n\\n**When to use:**\\n- Only applicable for **FedNow** and **RTP** payment methods\\n- The original RFP must have `amountModificationAllowed` flag set to `true`\\n- Not applicable for ACH, FEDWIRE, or SWIFT payment methods\\n- Accepted amount values should be greater than zero\\n\\n**Usage:**\\n- **Without parameter**: Approves the exception with the original payment amount\\n- **With acceptedAmount**: Approves with a modified amount (if allowed)\\n\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"format\":\"decimal\",\"example\":150}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionSuccessResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionFailureResponse\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"search results matching criteria\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionResponse\"}}}}}}},\"/v2/positivepay/exception/{paymentId}/reject\":{\"put\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Reject Positive Pay Exception\",\"description\":\"Reject a pending Positive Pay exception. For RFP payments, a reject code of CUST is sent.\",\"operationId\":\"rejectExceptions\",\"parameters\":[{\"name\":\"paymentId\",\"in\":\"path\",\"description\":\"A unique identifier associated with the positive pay exception\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionSuccessResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionFailureResponse\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"search results matching criteria\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ActivatePositivePayExceptionResponse\"}}}}}}},\"/v1/positivepay/payments/decisions/{decisionType}\":{\"patch\":{\"tags\":[\"Positive Pay\"],\"summary\":\"Batch Approval or Rejection of Positive Pay Exceptions\",\"description\":\"Allows batch processing of Positive Pay exceptions by approving or rejecting them based on the specified decision type.\",\"operationId\":\"approveBatchExceptions\",\"parameters\":[{\"name\":\"decisionType\",\"in\":\"path\",\"description\":\"Specifies the action to be taken on the Positive Pay exceptions. Accepted values are `approve` or `reject`.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"enum\":[\"approve\",\"reject\"]}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ApproveAllPositivePayExceptionRequest\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"paymentId\":{\"type\":\"string\",\"description\":\"Payment ID.\",\"example\":\"113444\"},\"message\":{\"type\":\"string\",\"description\":\"Exception message.\",\"example\":\"Exception approved successfully.\"}}}}}}},\"400\":{\"description\":\"Bad Request - Invalid input or validation error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"Invalid decision type. Please use 'approve' or 'reject'.\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"Invalid decision type. Please use 'approve' or 'reject'.\"}}}}}},\"examples\":{\"invalidDecisionType\":{\"summary\":\"Invalid decision type error\",\"value\":{\"message\":\"Invalid decision type. Please use 'approve' or 'reject'.\",\"errors\":[{\"message\":\"Invalid decision type. Please use 'approve' or 'reject'.\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GenericForbiddenErrorResponse\"},\"examples\":{\"unauthorizedError\":{\"summary\":\"Unauthorized access example\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/search\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Search payments\",\"description\":\"Search payments based on various parameters. This operation retrieve limited payment data from the system\",\"operationId\":\"searchPayments\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PaymentSearch\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SearchPaymentData\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BaseResponse\"},\"examples\":{\"invalidPageSize\":{\"summary\":\"Invalid page size\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"Invalid page size: Limit should be greater than 0.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BaseResponse\"},\"examples\":{\"unexpectedError\":{\"summary\":\"Unexpected error\",\"value\":{\"status\":\"Failure\",\"code\":\"API900\",\"message\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/creditrequest\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Initiate a Credit Payment - v3\",\"description\":\"Initiate a domestic or international credit payment [one time or recurring]\\n⚠️ This endpoint is deprecated and will be removed on October 1, 2026. Please switch to v4: `/v4/payments/credit`\\n\",\"operationId\":\"createCreditPayment\",\"requestBody\":{\"description\":\"Credit Payment Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreditPaymentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The payment has been created successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Message associated with the response, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"377297\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id associated with the payment.\",\"example\":0},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returning the unique reference id provided by the originator system.\",\"example\":\"123e4567\"}}}}},\"examples\":{\"paymentCreated\":{\"summary\":\"Payment created successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"377297\",\"recurrenceId\":0,\"paymentStatus\":\"INITIATED\",\"externalReferenceId\":\"146Global@#-_\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the validation or business failure.\",\"example\":\"PAYMENT002\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the request failure.\",\"example\":\"DDA account not found in the core\"}}}}}},\"401\":{\"description\":\"Unauthorized\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Not Found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the internal server failure.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the server error.\",\"example\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}},\"deprecated\":true,\"servers\":[{\"url\":\"https://sandbox-digitalbanking-uat2.finzly.net\"}]}},\"/v4/payments/credit\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Initiate a Credit Payment - v4\",\"description\":\"Initiate a domestic or international credit payment (on-time or recurring). The v4 version of this API includes enhanced error handling, returning all relevant error messages and error codes to provide clearer insights into any issues encountered during processing.\\n\",\"operationId\":\"v4credit\",\"parameters\":[{\"name\":\"Idempotent-Key\",\"in\":\"header\",\"description\":\"Optional idempotency key to ensure the payment is processed only once.\",\"required\":false,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"example\":\"123e4567-e89b-12d3-a456-426614174000\"}}],\"requestBody\":{\"description\":\"Credit Payment Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreditPaymentInstruction\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"The payment has been created successfully\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"377298\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id associated with the payment.\",\"example\":0},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returning the unique reference id provided by the originator system.\",\"example\":\"123e4567\"}}}}},\"examples\":{\"paymentCreated\":{\"summary\":\"Payment created successfully\",\"value\":{\"data\":{\"paymentUID\":\"377298\",\"recurrenceId\":0,\"paymentStatus\":\"INITIATED\",\"externalReferenceId\":\"146Global@#-_\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the validation or business failure.\",\"example\":\"SENDER_DDAACC_NOTFOUND\",\"deprecated\":true},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the request failure.\",\"example\":\"DDA account not found in the core\",\"deprecated\":true},\"errors\":{\"type\":\"array\",\"description\":\"List of detailed validation or business errors.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"DDA account not found in the core\"},\"code\":{\"type\":\"string\",\"description\":\"Detailed error code.\",\"example\":\"SENDER_DDAACC_NOTFOUND\"}}}}}},\"examples\":{\"invalidRequest\":{\"summary\":\"Sender account not found\",\"value\":{\"code\":\"SENDER_DDAACC_NOTFOUND\",\"message\":\"DDA account not found in the core\",\"errors\":[{\"message\":\"DDA account not found in the core\",\"code\":\"SENDER_DDAACC_NOTFOUND\"}]}}}}}},\"401\":{\"description\":\"Unauthorized\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Not Found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}},\"servers\":[{\"url\":\"https://sandbox-digitalbanking-uat2.finzly.net\"}]}},\"/v3/payments/debitrequest\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Initiate a Debit Payment\",\"description\":\"Initiate a domestic or international debit payment [one time or recurring]\\n\",\"operationId\":\"createDebitPayment\",\"requestBody\":{\"description\":\"Debit Payment Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DebitPaymentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The payment has been created successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Message associated with the response, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"377297\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id associated with the payment.\",\"example\":0},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returning the unique reference id provided by the originator system.\",\"example\":\"123e4567_\"}}}}},\"examples\":{\"paymentCreated\":{\"summary\":\"Payment created successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"377297\",\"recurrenceId\":0,\"paymentStatus\":\"INITIATED\",\"externalReferenceId\":\"123e4567_\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the validation or business failure.\",\"example\":\"PAYMENT002\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the request failure.\",\"example\":\"DDA account not found in the core\"}}}}}},\"401\":{\"description\":\"Unauthorized\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Not Found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the internal server failure.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the server error.\",\"example\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/booktransfer\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Initiate a Book (Transfer) Payment\",\"description\":\"Initiate a transfer payment request\",\"operationId\":\"booktransfer\",\"requestBody\":{\"description\":\"Book Transfer [Transfer] Request Fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BookTransferRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The payment has been created successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the response, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Message associated with the response, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"377300\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id associated with the payment.\",\"example\":4066},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returning the unique reference id provided by the originator system.\",\"example\":\"67ea2382-dae7-4210-8f8c-3ac7677ff4\"}}}}},\"examples\":{\"paymentCreated\":{\"summary\":\"Payment created successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"377300\",\"recurrenceId\":4066,\"paymentStatus\":\"INITIATED\",\"externalReferenceId\":\"67ea2382-dae7-4210-8f8c-3ac7677ff4\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the validation or business failure.\",\"example\":\"PAYMENT001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the request failure.\",\"example\":\"Failed to create a book transfer payment: The Receiver Deposit account number does not exist in the system.\"}}}}}},\"401\":{\"description\":\"Unauthorized\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Not Found\"},\"405\":{\"description\":\"bad input parameter environment\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the internal server failure.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the server error.\",\"example\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/{paymentUID}\":{\"get\":{\"tags\":[\"Payments\"],\"summary\":\"Get Payment\",\"description\":\"Retrieve a payment data using a payment unique identifier. This operation retrieve detailed payment data from the system.\",\"operationId\":\"getPaymentByUID\",\"parameters\":[{\"name\":\"paymentUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Payment Unique Identifier\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates whether the API request was successful or failed.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Response code, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message, if applicable.\",\"nullable\":true},\"data\":{\"$ref\":\"#/components/schemas/GetPaymentData\"}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BaseResponse\"},\"examples\":{\"paymentNotFound\":{\"summary\":\"Payment not found\",\"value\":{\"status\":\"Failure\",\"code\":\"API901\",\"message\":\"Failed to get the payment: The 3581561111 does not exist in the system.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BaseResponse\"},\"examples\":{\"unexpectedError\":{\"summary\":\"Unexpected error\",\"value\":{\"status\":\"Failure\",\"code\":\"API900\",\"message\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/{paymentUID}/cancel\":{\"put\":{\"tags\":[\"Payments\"],\"summary\":\"Cancel Payment\",\"description\":\"Initiate a cancel payment request\",\"operationId\":\"cancelPayment\",\"parameters\":[{\"name\":\"paymentUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Unique payment Id\"}}],\"requestBody\":{\"description\":\"Cancel payment return notes.\",\"content\":{\"application/json\":{\"schema\":{\"properties\":{\"notes\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Reason notes for cancel payment.\",\"example\":\"Insufficient balance\"}}}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates whether the API request was successful or failed.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Response code, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"375540\"}}}}},\"examples\":{\"cancelPaymentSuccess\":{\"summary\":\"Payment cancelled successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"375540\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the validation or business failure.\",\"example\":\"PAYMENT002\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the request failure.\",\"example\":\"Unable to cancel the payment. The provided payment ID is invalid or does not exist in the system.\"}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates the status of the API response.\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the internal server failure.\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"description\":\"Error message describing the reason for the server error.\",\"example\":\"Failed to complete the task, please try again later\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/{paymentUID}/return\":{\"put\":{\"tags\":[\"Payments\"],\"summary\":\"Return a payment\",\"description\":\"Return a payment\",\"operationId\":\"returnPayment\",\"parameters\":[{\"name\":\"paymentUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Payment Unique Identifier. Return payment functionality is applicable only for incoming payments and payment status should be 'Processed'.\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReturnPaymentRequest\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates whether the API request was successful or failed.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Response code, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"375540\"}}}}},\"examples\":{\"returnPaymentSuccess\":{\"summary\":\"Payment returned successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"375540\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReturnPaymentResponse\"},\"example\":{\"status\":\"Failure\",\"code\":\"PAYMENT002\",\"message\":\"Unable to return the payment: Invalid return code for the payment type.\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReturnPaymentResponse\"},\"example\":{\"status\":\"Failure\",\"code\":\"API_FAILURE\",\"message\":\"Failed to complete the task, please try again later\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/payments/{paymentUID}/reverse\":{\"put\":{\"tags\":[\"Payments\"],\"summary\":\"Reverse a payment\",\"description\":\"This request is used to reverse a payment that has already been processed.\\n\\nThe required fields and their behavior depend on the type of payment being reversed\\n(such as ACH, Fedwire, FedNow, RTP).\\n\\nImportant business rules:\\n- Only outgoing (OUT) credit payments can be reversed.\\n- The payment must be in PROCESSED status.\\n- Debit payments are not eligible for reversal in FedNow, Fedwire, and RTP payment types.\\n- For FedNow and RTP payments, the request will be rejected when returnStatus == \\\"RETURN_REQUEST_SENT\\\".\\n- Reversal is not supported for SWIFT payment types.\\n\",\"operationId\":\"reversePayment\",\"parameters\":[{\"name\":\"paymentUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Payment Unique Identifier.\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReversePaymentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"The payment has been reversed successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Indicates whether the API request was successful or failed.\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Response code, if applicable.\",\"nullable\":true},\"message\":{\"type\":\"string\",\"description\":\"Response message, if applicable.\",\"nullable\":true},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"375540\"}}}}},\"examples\":{\"reversePaymentSuccess\":{\"summary\":\"Payment reversed successfully\",\"value\":{\"status\":\"Success\",\"data\":{\"paymentUID\":\"375540\"}}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReversePaymentResponse\"},\"example\":{\"status\":\"Failure\",\"code\":\"PAYMENT002\",\"message\":\"Unable to reverse the payment: The payment is not an ODFI initiated hence not eligible for the reversal.\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ReversePaymentResponse\"},\"example\":{\"status\":\"Failure\",\"code\":\"API_FAILURE\",\"message\":\"Failed to complete the task, please try again later\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v1/recurrences/{recurrenceId}\":{\"put\":{\"tags\":[\"Payments\"],\"summary\":\"Skip next recurring Payment\",\"description\":\"Initiate a skip recurring payment request.\",\"operationId\":\"skiprecurringpayment\",\"parameters\":[{\"name\":\"recurrenceId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"description\":\"Recurrence Unique Identifier.\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the recurring payment update result.\",\"example\":\"Your request has been successfully processed.\"},\"errors\":{\"type\":\"array\",\"description\":\"List of errors. Empty when the request is successful.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message.\",\"example\":\"Failed to skip recurring payment: Payment details not found in the system.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRING_PAYMENT_NOTFOUND\"}}}}}},\"examples\":{\"recurringPaymentUpdated\":{\"summary\":\"Recurring payment updated successfully\",\"value\":{\"message\":\"Your request has been successfully processed.\",\"errors\":[]}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing why the request failed.\",\"example\":\"Failed to skip recurring payment: Payment details not found in the system.\"},\"errors\":{\"type\":\"array\",\"description\":\"List of detailed errors.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"Failed to skip recurring payment: Payment details not found in the system.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRING_PAYMENT_NOTFOUND\"}}}}}},\"examples\":{\"recurringPaymentNotFound\":{\"summary\":\"Recurring payment not found\",\"value\":{\"message\":\"Failed to skip recurring payment: Payment details not found in the system.\",\"errors\":[{\"message\":\"Failed to skip recurring payment: Payment details not found in the system.\",\"code\":\"RECURRING_PAYMENT_NOTFOUND\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Unexpected Error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}},\"delete\":{\"tags\":[\"Payments\"],\"summary\":\"Cancel recurring series.\",\"description\":\"Cancel the entire series of recurring payments by recurrence ID.\",\"operationId\":\"cancelrecurringpayment\",\"parameters\":[{\"name\":\"recurrenceId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"description\":\"Recurrence Unique Identifier.\"}},{\"name\":\"cancelReason\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Cancellation reason\"}},{\"name\":\"cancellationSource\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Cancellation source\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the recurring payment cancellation result.\",\"example\":\"Cancellation request for recurring id: 4059 is success.\"},\"errors\":{\"type\":\"array\",\"description\":\"List of errors. Empty when the request is successful.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"Failed to cancel recurring series: Provide valid recurring id.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRING_PAYMENT_NOTFOUND\"}}}}}},\"examples\":{\"recurringPaymentCancelled\":{\"summary\":\"Recurring payment cancelled successfully\",\"value\":{\"message\":\"Cancellation request for recurring id: 4059 is success.\",\"errors\":[]}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing why the cancellation request failed.\",\"example\":\"Failed to cancel recurring series: Provide valid recurring id.\"},\"errors\":{\"type\":\"array\",\"description\":\"List of detailed errors.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"Failed to cancel recurring series: Provide valid recurring id.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRING_PAYMENT_NOTFOUND\"}}}}}},\"examples\":{\"invalidRecurringId\":{\"summary\":\"Invalid recurring id\",\"value\":{\"message\":\"Failed to cancel recurring series: Provide valid recurring id.\",\"errors\":[{\"message\":\"Failed to cancel recurring series: Provide valid recurring id.\",\"code\":\"RECURRING_PAYMENT_NOTFOUND\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Unexpected Error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}},\"patch\":{\"tags\":[\"Payments\"],\"summary\":\"Update existing recurring payment.\",\"description\":\"Update existing recurring payment.\",\"operationId\":\"updaterecurringpayment\",\"parameters\":[{\"name\":\"recurrenceId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"description\":\"Recurrence Unique Identifier.\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RecurringPaymentRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Response message indicating the recurring payment update result.\",\"example\":\"Recurrence Payment Updated Successfully\"},\"errors\":{\"type\":\"array\",\"description\":\"List of errors. Empty when the request is successful.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"The nextPaymentDate field is required when updating the frequency.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRENCE_NEXTPAYMENTDATE_REQUIRED\"}}}}}},\"examples\":{\"recurringPaymentUpdated\":{\"summary\":\"Recurring payment updated successfully\",\"value\":{\"message\":\"Recurrence Payment Updated Successfully\",\"errors\":[]}}}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing why the update request failed.\",\"example\":\"The nextPaymentDate field is required when updating the frequency.\"},\"errors\":{\"type\":\"array\",\"description\":\"List of detailed errors.\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Detailed error message.\",\"example\":\"The nextPaymentDate field is required when updating the frequency.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code associated with the failure.\",\"example\":\"RECURRENCE_NEXTPAYMENTDATE_REQUIRED\"}}}}}},\"examples\":{\"missingNextPaymentDate\":{\"summary\":\"nextPaymentDate is required\",\"value\":{\"message\":\"The nextPaymentDate field is required when updating the frequency.\",\"errors\":[{\"message\":\"The nextPaymentDate field is required when updating the frequency.\",\"code\":\"RECURRENCE_NEXTPAYMENTDATE_REQUIRED\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Accessing the resource you were trying to reach is forbidden\"},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"500\":{\"description\":\"Unexpected Error\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/api/gateway/v1/payments/waterfall\":{\"post\":{\"tags\":[\"Payments\"],\"summary\":\"Waterfall transfers\",\"description\":\"Initiates a batch of internal fund transfers arranged in a waterfall sequence.\\nEach payment in the batch is executed in priority order defined by its `paymentIndex`,\\nwhere funds flow from the debtor to the creditor specified in each payment. The waterfall design\\nallows funds to cascade through multiple accounts sequentially within the bank.\\n**Note:** This API is restricted to use by authorized financial institutions only.\\n\",\"operationId\":\"createwaterfalltransfers\",\"parameters\":[{\"name\":\"Idempotent-Key\",\"in\":\"header\",\"description\":\"The idempotency key ensures that a payment request is processed only once. It must be unique for each batch of payments to prevent duplicate processing.\\n\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"example\":\"123e4567-e89b-12d3-a456-426614174000\"}}],\"requestBody\":{\"description\":\"Waterfall transfers Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/WaterfallTransferRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Waterfall transfers processed successfully\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"waterfallId\"],\"type\":\"object\",\"properties\":{\"waterfallId\":{\"type\":\"string\",\"description\":\"Unique indentifier in Finzly system.\",\"format\":\"uuid\"}}}}}},\"400\":{\"description\":\"Bad Request\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of validation errors encountered in the request.\\n\\nThe request was invalid due to malformed syntax or failed validation rules.\\nThis may include missing required fields, incorrect data formats, or invalid account information within the payment batch.\\n\",\"items\":{\"required\":[\"code\",\"message\",\"paymentIndex\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Payment Notes exceed the maximum limit of 200 characters.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"WF_PAYMENT_NOTES_MAX\"},\"paymentIndex\":{\"type\":\"integer\",\"description\":\"Index of the payment object where the error occurred.\",\"example\":2}}}}}}}}},\"401\":{\"description\":\"Unauthorized\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of authentication/authorization errors encountered while processing the request.\\n\\nThe request lacks valid authentication credentials.\\nEnsure a valid access token or API key is included in the request headers.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing why the request was unauthorized.\",\"example\":\"Unable to process the request: no calling legal entity found for the given batch. Please contact your administrator.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code that identifies the origin of the error.\",\"example\":\"WF_CALLINGORG_UNAUTHORIZED\"}}}}}}}}},\"403\":{\"description\":\"Forbidden\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of authorization errors encountered while processing the request.\\n\\nThe client is authenticated but does not have the necessary permissions to perform this operation or access the requested resource.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing why the request was forbidden.\",\"example\":\"You are not authorized to process this request.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code that identifies the type of authorization error.\",\"example\":\"WF_ACCESS_DENIED\"}}}}}}}}},\"404\":{\"description\":\"Not Found – The requested resource could not be located. Verify the endpoint or resource identifier.\\n\"},\"405\":{\"description\":\"Method Not Allowed – HTTP method used is not supported by the requested resource.\\n\"},\"409\":{\"description\":\"Conflict\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of conflict errors encountered while processing the request.\\n\\nThe request could not be completed due to a conflict with the current state of the target resource.\\nThis often occurs when attempting to create a payment with an external reference ID, or idempotent key that already exists in the system.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message explaining why the conflict occurred.\",\"example\":\"A batch with this idempotent key already exists. Please use a different key or retrieve the existing batch.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code that identifies the type of conflict.\",\"example\":\"WF_IDEMPOTENT_KEY_CONFLICT\"}}}}}}}}},\"500\":{\"description\":\"Internal Server\",\"content\":{\"application/json\":{\"schema\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of internal errors encountered during processing.\\n\\nThe server encountered an unexpected condition that prevented it from fulfilling the request. This could be due to a system error, database failure, or other internal issues.\\n\",\"items\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Description of the internal error.\",\"example\":\"Unexpected error occurred while processing the request.\"},\"code\":{\"type\":\"string\",\"description\":\"Internal error code for tracking and debugging.\",\"example\":\"WF_ERROR\"}}}}}}}}},\"503\":{\"description\":\"Service Unavailable – The server is temporarily unable.\\n\"}},\"servers\":[{\"url\":\"https://sandbox-digitalbanking-uat2.finzly.net\"}]}},\"/v1/rfi/{paymentId}\":{\"get\":{\"tags\":[\"RFI\"],\"summary\":\"Get RFI History\",\"description\":\"Retrieve Request for Information history for a payment.\\nThe delivery method (RTP or FedNow) is automatically determined based on the paymentId.\\nValidates paymentId, ensures delivery method is RTP or FedNow and retrieves the RFI history from the payment service.\\nValidation rules:\\n- Payment ID is required and must be numeric\\n\",\"operationId\":\"getRfiHistory\",\"parameters\":[{\"name\":\"paymentId\",\"in\":\"path\",\"description\":\"Unique payment identifier. The delivery method (RTP or FedNow) is automatically determined from this payment.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved RFI history\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RfiHistorySuccessResponse\"}}}},\"400\":{\"description\":\"Bad Request - Invalid input parameters or validation errors\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RfiHistoryErrorResponse\"},\"examples\":{\"validationError\":{\"summary\":\"Validation error example\",\"value\":{\"errors\":[{\"code\":\"RFI_PAYMENTID_REQUIRED\",\"message\":\"Payment ID is required to process this Request for Information. Please provide a valid payment identifier.\"},{\"code\":\"RFI_PAYMENTID_INVALID\",\"message\":\"The payment ID format is invalid. Please provide a numeric payment ID and try again.\"},{\"code\":\"RFI_PAYMENT_NOTFOUND\",\"message\":\"The payment associated with the provided payment ID could not be found. Please verify the payment ID and try again.\"},{\"code\":\"RFI_PAYMENTDELIVERYMETHOD_INVALID\",\"message\":\"Request for Information is only available for RTP or FedNow payments. The payment with the provided ID has an unsupported delivery method.\"}]}}}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"You are not authorized to perform this operation.Please contact the administrator for support.\"},\"code\":{\"type\":\"string\",\"example\":\"RFI_ACCESS_DENIED\"}}},\"examples\":{\"unauthorizedError\":{\"summary\":\"Access denied example.\",\"value\":{\"code\":\"RFI_ACCESS_DENIED\",\"message\":\"You are not authorized to perform this operation. Please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"Method Not Allowed - The HTTP method is not allowed for this endpoint\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"},\"code\":{\"type\":\"string\",\"example\":\"RFI_INTERNAL_ERROR\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred while processing the RFI Request.\",\"code\":\"RFI_INTERNAL_ERROR\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}},\"post\":{\"tags\":[\"RFI\"],\"summary\":\"Send RFI\",\"description\":\"Send a Request for Information (RFI) for a payment or debit request.\\nThe delivery method (RTP or FedNow) is automatically determined based on the paymentId.\\nThe service validates the paymentId, confirms that the delivery method is either RTP or FedNow,\\nvalidates the request body, and then sends the RFI request to the payment service.\\nValidation rules:\\n- At least one of `MissingInformation` or `IncorrectInformation` must be provided.\\n- **InitiatingPartyName** is required\\n- Status reason codes must be from the allowed list as per guideline standards of each clearing.\\n- When code is **NARR**, additionalInfo is required\\n- The payment delivery method must be RTP or FedNow (automatically detected from the payment).\\n- Payment IO type must be **'IN'** (incoming) or **'OUT'** (outgoing)\\n- For incoming CREDIT payments: delivery method must be RTP or FedNow.\\n- For incoming DEBIT requests: delivery method must be RTP only.\\n- For outgoing CREDIT Payments: payment status must be one of the following: `PROCESSED, REVERSAL_ACCEPTED, REVERSAL_PARTIALLY_ACCEPTED, REVERSAL_REJECTED, RETURNED*`\\n- Outgoing DEBIT Requests are not allowed for RFI operations (same direction of RFI is not allowed)\\n- Incorrect information codes must match the payment’s delivery method (RTP or FedNow).\\n\",\"operationId\":\"sendRfi\",\"parameters\":[{\"name\":\"paymentId\",\"in\":\"path\",\"description\":\"Unique payment identifier. The delivery method (RTP or FedNow) is automatically determined from this payment.\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RfiSendRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RfiSendSuccessResponse\"}}}},\"400\":{\"description\":\"Bad Request - Invalid input parameters or validation errors\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/RfiSendErrorResponse\"},\"examples\":{\"validationError\":{\"summary\":\"Validation error example\",\"value\":{\"errors\":[{\"code\":\"RFI_MISSINGORINCORRECTINFO_REQUIRED\",\"message\":\"Please provide at least one of the following: missing information or incorrect information details to proceed with the Request for Information.\"},{\"code\":\"RFI_INITPARTYNAME_REQUIRED\",\"message\":\"Initiating party name is required to process the Request for Information. Please provide the name of the party initiating this request.\"},{\"code\":\"RFI_STATUSREASONCODE_REQUIRED\",\"message\":\"Status reason code is required. Please provide a valid reason code to proceed.\"},{\"code\":\"RFI_MISSINGINFOCODE_INVALID\",\"message\":\"The missing information code provided is not valid. Please use one of the following accepted codes: MS01, NARR.\"},{\"code\":\"RFI_INCORRECTINFOCODE_INVALID\",\"message\":\"The incorrect information code provided is not valid. Please use one of the following accepted codes: IN01, IN02, IN03, IN04, IN06, IN07, IN08, IN13, IN14, IN15, IN16, IN19, IN38, IN39, MM20, MM21, MM25, MM26, MM27, MM28, MM29, MM30, MM31, MM32, MM35, NARR.\"},{\"code\":\"RFI_INCORRECTINFOCODE_MISMATCH\",\"message\":\"The incorrect information code 'IN03' is not valid for RTP payments. Please use one of the following accepted codes for RTP: IN01, IN04, IN06, IN15, IN19, IN38, IN39, MM20, MM21, NARR.\"},{\"code\":\"RFI_ADDITIONALINFO_REQUIRED\",\"message\":\"Additional information is required when using reason code 'NARR'. Please provide the narrative details explaining the reason for this Request for Information.\"},{\"code\":\"RFI_PAYMENTDELIVERYMETHOD_INVALID\",\"message\":\"Request for Information is only available for RTP or FedNow payments. The payment with the provided ID has an unsupported delivery method.\"},{\"code\":\"RFI_PAYMENTIOTYPE_INVALID\",\"message\":\"Invalid payment IO type. Request for Information is only available for payments with IO type 'IN' (incoming) or 'OUT' (outgoing).\"},{\"code\":\"RFI_ENTRYTYPE_INVALID\",\"message\":\"Request for Information requires a valid entry type. Please ensure the payment has either 'CREDIT' or 'DEBIT' entry type.\"},{\"code\":\"RFI_OUTPAYMENTSTATUS_INVALID\",\"message\":\"The payment status is not valid for outgoing CREDIT Request for Information operations. Valid statuses are: PROCESSED, REVERSAL_ACCEPTED, REVERSAL_PARTIALLY_ACCEPTED, REVERSAL_REJECTED, or RETURNED.\"}]}}}}}},\"403\":{\"description\":\"Forbidden - User is not authorized to perform this operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"You are not authorized to perform this operation.Please contact the administrator for support.\"},\"code\":{\"type\":\"string\",\"example\":\"RFI_ACCESS_DENIED\"}}},\"examples\":{\"unauthorizedError\":{\"summary\":\"Access denied example.\",\"value\":{\"code\":\"RFI_ACCESS_DENIED\",\"message\":\"You are not authorized to perform this operation. Please contact the administrator for support.\"}}}}}},\"404\":{\"description\":\"The resource you were trying to reach is not found\"},\"405\":{\"description\":\"Method Not Allowed - The HTTP method is not allowed for this endpoint\"},\"500\":{\"description\":\"Internal Server Error - Unexpected error occurred while processing the request\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"example\":\"An unexpected error occurred.\"},\"code\":{\"type\":\"string\",\"example\":\"RFI_INTERNAL_ERROR\"}}},\"examples\":{\"internalServerError\":{\"summary\":\"Generic server error example\",\"value\":{\"message\":\"An unexpected error occurred while processing the RFI Request.\",\"code\":\"RFI_INTERNAL_ERROR\"}}}}}},\"503\":{\"description\":\"Service unavailable\"}}}}},\"components\":{\"schemas\":{\"Error\":{\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code assigned by the system\",\"example\":\"invalidMethod\"},\"description\":{\"type\":\"string\",\"description\":\"Error description to provide addtional details about the error code\",\"example\":\"Invalid HTTP method used\"}}},\"V4PaymentError\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\",\"example\":\"Invalid payment request.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the issue.\",\"example\":\"API400\"}}},\"SenderOrCreditAddress\":{\"properties\":{\"addressLine1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field.\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"City Name. This is an optional field needed for the domestic payment\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"State Name. This is an optional field needed for the domestic payment\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field needed for the domestic payment.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166\",\"example\":\"US\"}},\"description\":\"The address pertains to the sender or debtor.\\nIf any address fields are provided, required fields depend on the payment rail:\\n- Swift & Fedwire: addressLine1, city, countryCode\\n- ACH & Instant: addressLine1, city, state, postalCode, countryCode\\n\",\"anyOf\":[{\"title\":\"Swift/Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant\",\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"]}]},\"ReceiverOrDebtorAddress\":{\"properties\":{\"addressLine1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 1. This field is mandatory only for fedwire payment.\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field.\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"City Name. This field is mandatory only for fedwire payment.\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"State Name. This is an optional field needed for the domestic payment\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field needed for the domestic payment.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166. This field is mandatory only for fedwire payment.\",\"example\":\"US\"}},\"description\":\"The address pertains to the receiver or debtor. This field is required for fedwire payments and optional for other payment rails.\",\"anyOf\":[{\"title\":\"Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant/Swift\"}]},\"BankAddress\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"],\"properties\":{\"addressLine1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field.\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank City. This is an optional field.\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank State. This is an optional field.\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166.\",\"example\":\"US\"}},\"description\":\"The bank address information is required for banks located outside the United States. If any of the address fields are provided, it is mandatory to include addressLine1, city, state, postalCode, and countryCode.\"},\"Bank\":{\"properties\":{\"bankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"The bank unique identifier type. Use SWIFT for the international money transfer. Use NID to identify the country specific bank id such as IBAN mainly for european countries, CLABE for Mexico, ABA for USA  etc.\",\"example\":\"NID\"},\"bankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is needed when the bankIdType is set to 'NID'\",\"example\":\"072000326\"},\"swiftCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"SWIFT Code. This is needed when the bankIdType is set to 'SWIFT'\",\"example\":\"CHASUS33XXX\"},\"accountType\":{\"type\":\"string\",\"description\":\"An optional field that indicates the type of creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"IBAN\",\"enum\":[\"IBAN\",\"Others\"]},\"accountNumber\":{\"maxLength\":34,\"type\":\"string\",\"description\":\"A conditionally mandatory field. When an account type is specified, this field must be provided. Represents the creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"DE89370400440532013000\"},\"name\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name of the receiver bank. This field is conditionally mandatory. It must be provided when any receiver bank address details are present. For domestic [NID] and international [SWIFT] codes, if not provided and no address details are given, the Finzly system assigns the name based on directory lookup.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166. This field is optional only when the country code is already provided as part of the receiver bank address. If the receiver bank address does not include a country code, this field becomes mandatory.\",\"example\":\"US\"},\"address\":{\"$ref\":\"#/components/schemas/BankAddress\"}},\"description\":\"The bank or intermediary bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\"},\"IntermediaryBank\":{\"properties\":{\"bankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"The bank unique identifier type. Use SWIFT for the international money transfer. Use NID to identify the country specific bank id such as IBAN mainly for european countries, CLABE for Mexico, ABA for USA  etc.\",\"example\":\"NID\"},\"bankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is needed when the bankIdType is set to 'NID'\",\"example\":\"072000326\"},\"swiftCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"SWIFT Code. This is needed when the bankIdType is set to 'SWIFT'\",\"example\":\"CHASUS33XXX\"},\"name\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name of the bank. This is an optional for domestic [NID] and international [SWIFT] code. if not provided Finzly system will assign the name as per the directory lookup.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166. This is an optional field\",\"example\":\"US\"},\"address\":{\"$ref\":\"#/components/schemas/BankAddress\"}},\"description\":\"The bank or intermediary bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\"},\"Fee\":{\"properties\":{\"feeName\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Fee Name. This is an optional field. Defaults to \\\"Custom\\\" if not provided.\",\"example\":\"Custom\"},\"currency\":{\"type\":\"string\",\"description\":\"Fee Currency defaulted to USD if not provided.\",\"example\":\"USD\"},\"amount\":{\"type\":\"number\",\"description\":\"Fee to be charged for the payment transaction.\",\"example\":10.88}}},\"fedWireDetails\":{\"properties\":{\"businessFunctionCode\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Specifies the business function code applicable to the Fedwire payment. This is an optional field.\",\"example\":\"CTRC\"},\"comments\":{\"type\":\"string\",\"description\":\"Additional remarks or payment-related comments for the Fedwire transaction. This is an optional field.\",\"example\":\"Payment for invoice 12345.\"},\"originatorToBeneficiaryInformation\":{\"type\":\"string\",\"description\":\"originator to beneficiary information.\",\"example\":\"some notes for the beneficiary\"},\"imad\":{\"type\":\"string\",\"description\":\"It is a unique number given to each FedWire payment when using the Federal Reserve Bank Service and can be used to investigate and track wire transfers\",\"example\":\"20220627MMQCTR7B000012\"},\"omad\":{\"type\":\"string\",\"description\":\"The OMAD indicates a unique number assigned to each transfer providing delivery-related information\",\"example\":\"0328QMGFNP6400002503281343FT0120232023\"}}},\"routingNumber\":{\"properties\":{\"institutionName\":{\"type\":\"string\",\"description\":\"Bank Name. This is an optional field.\",\"example\":\"ABC Bank\"},\"nationalIdName\":{\"type\":\"string\",\"description\":\"nationalId name. This is an optional field..\",\"example\":\"ABA\"},\"nationalId\":{\"type\":\"string\",\"description\":\"bank routing number. This is not an optional field.\",\"example\":\"123656698\"},\"recordTypeCode\":{\"type\":\"string\",\"description\":\"record type code. This is an optional field.\",\"example\":\"SEND\"},\"routingAddress\":{\"$ref\":\"#/components/schemas/routingAddress\"},\"deliveryMethods\":{\"type\":\"array\",\"description\":\"List of delivery methods.\",\"example\":[\"ACH\",\"FedNow\"],\"items\":{\"type\":\"string\"}},\"fedwireRoutingInfo\":{\"$ref\":\"#/components/schemas/fedwireRoutingInfo\"},\"rtpRoutingInfo\":{\"$ref\":\"#/components/schemas/rtpRoutingInfo\"},\"fedNowRoutingInfo\":{\"$ref\":\"#/components/schemas/fedNowRoutingInfo\"}}},\"routingAddress\":{\"properties\":{\"addressLine1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field.\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank City. This is an optional field.\",\"example\":\"Charlotte\"},\"stateCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank State. This is an optional field.\",\"example\":\"North Carolina\"},\"zipCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166.\",\"example\":\"US\"},\"country\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Country name. This is an optional field.\",\"example\":\"USA\"}}},\"fedwireRoutingInfo\":{\"properties\":{\"fundsTransferStatus\":{\"type\":\"boolean\",\"description\":\"boolean value. This is an optional field.\",\"example\":false},\"fundsSettlementOnly\":{\"type\":\"boolean\",\"description\":\"boolean value. This is an optional field.\",\"example\":false},\"securityTransferStatus\":{\"type\":\"boolean\",\"description\":\"boolean value. This is an optional field.\",\"example\":false}}},\"rtpRoutingInfo\":{\"properties\":{\"participantId\":{\"type\":\"string\",\"description\":\"participant Id. This is an optional field.\"},\"services\":{\"type\":\"array\",\"description\":\"List of services.\",\"example\":[\"CRDT\",\"RFI\",\"ACK\"],\"items\":{\"type\":\"string\"}},\"receivingConnection\":{\"type\":\"string\",\"description\":\"receiving connection. This is an optional field.\"},\"signOnStatus\":{\"type\":\"string\",\"description\":\"signOn status. This is an optional field.\"},\"participantActivationDate\":{\"type\":\"string\",\"description\":\"participant activation date. This is an optional field.\"},\"status\":{\"type\":\"string\",\"description\":\"status. This is an optional field.\"},\"connectionStatus\":{\"type\":\"string\",\"description\":\"connection status. This is an optional field.\"}}},\"fedNowRoutingInfo\":{\"properties\":{\"services\":{\"type\":\"array\",\"description\":\"List of services.\",\"example\":[\"CRDT\",\"RFI\",\"ACK\"],\"items\":{\"type\":\"string\"}},\"status\":{\"type\":\"string\",\"description\":\"status. This is an optional field.\"},\"connectionStatus\":{\"type\":\"string\",\"description\":\"connection status. This is an optional field.\"}}},\"PaymentRecurrence\":{\"required\":[\"frequency\",\"payUntil\"],\"properties\":{\"frequency\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Frequency associated with the payment recurrence. The valid values are Daily, Weekly, BiWeekly, Monthly, Quarterly, SemiAnnually, Yearly.\",\"example\":\"Daily\"},\"payUntil\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"The end of payment recurrence. If it is set to Cancelled that means payment will be processing as per the frequency until it cancelled. If it is set to EndDate that means payment will be processing per the frequency until the defined EndDate. If it is set to NumberOfPayments that means payment will be processing per the frequency until the defined number of payments. \",\"example\":\"Cancelled\",\"enum\":[\"Cancelled\",\"EndDate\",\"NumberOfPayments\"]},\"endDate\":{\"type\":\"string\",\"description\":\"This is needed when the payUntil is set to EndDate. The valid date fromat is MM-dd-yyyy. EndDate should be greater than the payment date.\",\"example\":\"01-29-2023\"},\"numberOfPayments\":{\"maxLength\":1000,\"type\":\"integer\",\"description\":\"This is needed when the payUntil is set to NumberOfPayments\",\"example\":10}},\"description\":\"Set the payment recurrence based on the available options.\"},\"PaymentSearch\":{\"required\":[\"limit\",\"page\"],\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"Payment unique identifier.\",\"example\":\"1369308\"},\"fromDate\":{\"type\":\"string\",\"description\":\"From date. The valid date format is in [MM-dd-yyyy]. \",\"example\":\"03-25-2024\"},\"toDate\":{\"type\":\"string\",\"description\":\"To date. The valid date format is in [MM-dd-yyyy]\",\"example\":\"04-25-2024\"},\"currency\":{\"type\":\"string\",\"description\":\"Payment currency represents the sender's currency. The valid country currency code should be per ISO 4217 standard.\",\"example\":\"USD\"},\"minAmount\":{\"type\":\"number\",\"description\":\"Minimum payment amount.\",\"example\":100},\"maxAmount\":{\"type\":\"number\",\"description\":\"Maximum payment amount.\",\"example\":1000},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount.\",\"example\":120},\"forexContractNo\":{\"type\":\"string\",\"description\":\"FX contract number is present only for the internal payment\",\"example\":\"13896558\"},\"receiverAccountNo\":{\"type\":\"string\",\"description\":\"Receiver's bank account number for the withdrawal of funds.\",\"example\":\"2236569989\"},\"receiverName\":{\"type\":\"string\",\"description\":\"Name of the recevier linked to the payment.\",\"example\":\"xyz\"},\"senderName\":{\"type\":\"string\",\"description\":\"Name of the sender linked to the payment.\",\"example\":\"corp\"},\"senderAccountNo\":{\"type\":\"string\",\"description\":\"Sender's bank account number from which money will be withdrawn.\",\"example\":\"2288556932\"},\"sourceRefNo\":{\"type\":\"string\",\"description\":\"Payment source reference number\",\"example\":\"839489343\"},\"status\":{\"type\":\"string\",\"description\":\"Payment status, e.g. PROCESSED, TRANSMITTED_TO_FED, CANCELLED, FUTURE_DATED, PENDING_APPROVAL, PARTIALLY_APPROVED, APPROVED,etc...\",\"example\":\"PROCESSED\"},\"wireType\":{\"type\":\"string\",\"description\":\"Payment wire type e.g. OUTGOING_PAYMENT, INCOMING_PAYMENT\",\"example\":\"OUTGOING_PAYMENT\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Unique reference id from a system outside of finzly.\",\"example\":\"Payment101\"},\"senderAccountTokenId\":{\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the sender account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the sender to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.\",\"example\":\"1234567ABCD\"},\"receiverAccountTokenId\":{\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the receiver account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the receiver to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.\",\"example\":\"ABCD734989\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"Payment recurrence unique identifier\",\"example\":12898},\"customerUID\":{\"type\":\"number\",\"description\":\"Customer unique id\",\"example\":234234},\"description\":{\"type\":\"string\",\"description\":\"Payment note\",\"example\":\"Payment note\"},\"receiverId\":{\"type\":\"number\",\"description\":\"Payment receiver unique id\",\"example\":2899},\"senderAccountId\":{\"type\":\"string\",\"description\":\"Sender account unique id\",\"example\":\"57567567567\"},\"ultimateSenderName\":{\"type\":\"string\",\"description\":\"Name of the ultimate sender linked to the payment.\",\"example\":\"Ultimate Sender Name\"},\"ultimateSenderAccountNo\":{\"type\":\"string\",\"description\":\"Ultimate sender's bank account number from which money will be withdrawn.\",\"example\":\"9901020301\"},\"ultimateReceiverName\":{\"type\":\"string\",\"description\":\"Name of the ultimate receiver linked to the payment.\",\"example\":\"xyz\"},\"ultimateReceiverAccountNo\":{\"type\":\"string\",\"description\":\"Ultimate receiver bank account number to which money will be withdrawn.\",\"example\":\"89895656\"},\"mostRecent\":{\"type\":\"boolean\",\"description\":\"When set to true, the system returns the most recent payment while skipping any payments whose status configured in the exclusion property.\",\"example\":true},\"deliveryMethod\":{\"type\":\"string\",\"description\":\"Specifies the payment delivery channel or network through which the transaction is processed.\",\"example\":\"ACH\"},\"paymentType\":{\"type\":\"string\",\"description\":\"Specifies the payment type associated with the transaction.\",\"example\":\"REGULAR_ACH\"},\"page\":{\"type\":\"integer\",\"description\":\"What page of results should be returned? The minimum page size is 1.\",\"example\":1},\"limit\":{\"type\":\"integer\",\"description\":\"Number of records to be included in each page. The minimum limit is 1 and the maximum limit is configurable in the system. If it is not configured then the default max limit is 100.\",\"example\":10}},\"description\":\"Payment search parameters\"},\"Pagination\":{\"properties\":{\"totalRecords\":{\"type\":\"number\",\"description\":\"Total number of records exist in the system for a given filter\",\"format\":\"integer\",\"example\":100},\"returnedRecords\":{\"type\":\"number\",\"description\":\"Total number of records returned\",\"format\":\"integer\",\"example\":10},\"pageReturned\":{\"type\":\"number\",\"description\":\"Current number of page returned\",\"format\":\"integer\",\"example\":2},\"pageSize\":{\"type\":\"number\",\"description\":\"Total number of records in a given pages\",\"format\":\"integer\",\"example\":10}}},\"Groups\":{\"type\":\"object\",\"properties\":{\"condition\":{\"type\":\"string\",\"example\":\"OR\"},\"type\":{\"type\":\"string\"},\"groups\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Groups\"}},\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Fields\"}}}},\"Fields\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"example\":\"beneficiaryBankSWIFT\"},\"displayName\":{\"type\":\"string\",\"example\":\"Beneficiary Bank SWIFT\"},\"swiftCode\":{\"type\":\"string\"},\"swiftTag\":{\"type\":\"string\"},\"fieldLength\":{\"type\":\"integer\"}}},\"PaymentNoteOptionValueChildren\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"displayName\":{\"type\":\"string\",\"example\":\"Drivers Licence\"},\"swiftCode\":{\"type\":\"string\",\"example\":\"DVB001\"},\"group\":{\"type\":\"boolean\",\"example\":false},\"children\":{\"$ref\":\"#/components/schemas/PaymentNoteOptionValueChildren\"}}}}},\"AdditionalInfoCreditPayment\":{\"properties\":{\"channel\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"API\"},\"costCenter\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"Optional field used to identify the cost center associated with the payment.\\n\\nA cost center is a department or function within an organization—such as Accounting, Human Resources, or IT—that incurs costs but does not directly contribute to profit.\\n\\nThe provided cost center value must already exist in the system configuration. If it does not exist, the transaction will be rejected. Please ensure a valid cost center is used.\\n\",\"example\":\"12897\"},\"requestMethod\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"This is an optional field that specifies the customer payment request method from a given channel (e.g., WALK-IN, PHONE-IN). The maximum allowed length is 45 characters; values exceeding this limit may be truncated by the system.\",\"example\":\"WALK-IN\"},\"detailsOfCharges\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"who pays the payment charges. This is an optional field. For `speed` associated with Fedwire and SWIFT, the applicable values are `OUR`, `BEN`, and `SHA`.\",\"example\":\"OUR\"},\"secCode\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"An SEC code is a three letter code that describes how a payment was authorized by the consumer or business receiving an ACH transaction. This is an optional field needed only for the speed associated with the ACH payment rail.\",\"example\":\"CCD\"},\"transactionTypeCode\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"This is an optional field. This is a secondary secCode can be set when the sec code is set to IAT.\",\"example\":\"ANN\"},\"receiverIdentificationNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is an optional field. It represents the Receiver’s DFI Identification Number and is applicable when the secCode is set to IAT. The value will be truncated by the system based on the selected payment rail.\",\"example\":\"12334356\"},\"fxContractNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Unique identifier associated with the FX trade applicable for the international payment\",\"example\":\"111234\"},\"originatortoBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\",\"deprecated\":true},\"senderToReceiverNotes\":{\"maxLength\":105,\"type\":\"string\",\"description\":\"This is applicable for the fedwire payment specifies additional information for the Receiver. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6500} tag in three lines and each line will have 35 characters.\",\"example\":\"Sender To Reciever Notes\"},\"remittanceMethod\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"This is applicable for the RTP payment. This is an optional field\",\"example\":\"EMAL\",\"enum\":[\"EMAL\",\"URID\"]},\"paymentRemittanceNotes\":{\"type\":\"string\",\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\\n- Terminator handling for **ACH**:\\n  The system automatically appends a **tilde** (`~`) as the\\n  segment terminator at the end of the value if one is not\\n  already provided.\\n\\n  If you explicitly provide a terminator, the following are\\n  accepted:\\n    - Tilde: `~`\\n    - Backslash: `\\\\`\\n\\n  Example without terminator (system will auto-append `~`):\\n    `Invoice payment for order 12345`\\n\\n  Example with explicit terminator:\\n    `Invoice payment for order 12345~`\\n\\n- **Character limit rules for ACH:**\\n  \\n  - **Rule 1 — With terminator:**        \\n    The maximum allowed length is 80 characters including the terminator.\\n\\n  - **Rule 2 — Without terminator:**\\n    If no terminator is provided, the value must not exceed 79 characters.\\n    The system will auto-append ~, making the final stored length exactly 80 characters.\\n\"},\"localInstruments\":{\"type\":\"string\",\"description\":\"Local instrument code applicable only for RTP or FEDNOW payment. Deprecated for CTP fedwire payments.\",\"example\":\"COVS\",\"enum\":[\"COVS\",\"ANSI\",\"GXML\",\"IXML\",\"NARR\",\"S820\",\"SWIF\",\"UEDI\",\"RRMT\",\"PROP\",\"STANDARD\",\"ZELLE\",\"INTERMEDIARY\",\"FDNA\",\"RMTS\"]},\"referenceForBeneficiary\":{\"maxLength\":16,\"type\":\"string\",\"description\":\"This field is applicable for Fedwire payments, accepts an alphanumeric string, represents the beneficiary reference details, and is mapped to `EndToEndId` field.\"},\"unstructuredAddendaInfo\":{\"type\":\"object\",\"properties\":{\"addendaInformation\":{\"type\":\"string\"}},\"description\":\"This is applicable for the fedwire payment where the local instrument can be S820, GXML, ANSI, IXML, NARR, SWIF, UEDI\"},\"proprietaryCode\":{\"type\":\"string\",\"description\":\"Deprecated field, Previously this is applicable for the fedwire payment where the local instrument set to PROP\",\"deprecated\":true},\"operationNote\":{\"maxLength\":1000,\"type\":\"string\",\"description\":\"Operation Notes\"},\"benefitReceiver\":{\"$ref\":\"#/components/schemas/BenefitReceiver\"}}},\"V5BenefitReceiver\":{\"required\":[\"accountNumber\",\"federalBenefitType\",\"firstName\",\"lastName\",\"socialSecurityNumber\",\"subAccountType\"],\"type\":\"object\",\"properties\":{\"federalBenefitType\":{\"type\":\"string\",\"description\":\"Specifies the type of federal benefit the individual is receiving.\",\"example\":\"Social Security\",\"enum\":[\"Social Security\",\"Supplemental Social Security\",\"Veterans Compensation and Pension\",\"Veterans Education MBIB\",\"Veterans Education And Selected Reserve\",\"Veterans Life Insurance\",\"Veterans Vocational Rehabilitation and Employment Benefits\",\"Civil Service Retirement And Annuity\",\"Civil Service Survivor And Annuity\",\"Railroad Retirement Annuity\",\"Railroad Unemployment And Sickness\",\"Dependents Education Assistance Program\",\"Reserve Education Assistance Program\",\"Post 911 GI Bill\"]},\"accountNumber\":{\"maxLength\":17,\"type\":\"string\",\"description\":\"The bank account number where the benefit payment will be deposited. This should be a valid account number with the financial institution.\",\"example\":\"10000002\"},\"socialSecurityNumber\":{\"type\":\"string\",\"description\":\"The Social Security Number (SSN) of the benefit recipient. This is used to identify the individual within federal benefit systems.\",\"example\":\"555500559\"},\"representativePayee\":{\"type\":\"boolean\",\"description\":\"Indicates whether a representative payee is assigned to manage the recipient's benefits. If this field is not provided, it defaults to false.\",\"example\":false},\"firstName\":{\"type\":\"string\",\"description\":\"The legal first name of the benefit recipient as registered with the federal agency.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"The legal last name (surname) of the benefit recipient.\",\"example\":\"Doe\"},\"subAccountType\":{\"type\":\"string\",\"description\":\"Specifies the subtype of the recipient's bank account.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\"]}},\"description\":\"Contains detailed information about the individual receiving federal benefits.\\n**Required only when the SEC code is \\\"ENR\\\".**\\nOptional in all other cases.\\n\"},\"BenefitReceiver\":{\"required\":[\"accountNumber\",\"federalBenefitType\",\"firstName\",\"lastName\",\"socialSecurityNumber\",\"subAccountType\"],\"type\":\"object\",\"properties\":{\"federalBenefitType\":{\"type\":\"string\",\"description\":\"Specifies the type of federal benefit the individual is receiving.\",\"example\":\"Social Security\",\"enum\":[\"Social Security\",\"Supplemental Social Security\",\"Veterans Compensation and Pension\",\"Veterans Education MBIB\",\"Veterans Education And Selected Reserve\",\"Veterans Life Insurance\",\"Veterans Vocational Rehabilitation and Employment Benefits\",\"Civil Service Retirement And Annuity\",\"Civil Service Survivor And Annuity\",\"Railroad Retirement Annuity\",\"Railroad Unemployment And Sickness\",\"Dependents Education Assistance Program\",\"Reserve Education Assistance Program\",\"Post 911 GI Bill\"]},\"accountNumber\":{\"maxLength\":17,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"The bank account number where the benefit payment will be deposited. This should be a valid account number with the financial institution.\",\"example\":\"10000002\"},\"socialSecurityNumber\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[a-zA-Z0-9]*$\",\"type\":\"string\",\"description\":\"The Social Security Number (SSN) of the benefit recipient. This is used to identify the individual within federal benefit systems.\",\"example\":\"555500559\"},\"representativePayee\":{\"type\":\"boolean\",\"description\":\"Indicates whether a representative payee is assigned to manage the recipient's benefits. If this field is not provided, it defaults to false.\",\"example\":false},\"firstName\":{\"maxLength\":7,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"The legal first name of the benefit recipient as registered with the federal agency.\",\"example\":\"John\"},\"lastName\":{\"maxLength\":15,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"The legal last name (surname) of the benefit recipient.\",\"example\":\"Doe\"},\"subAccountType\":{\"type\":\"string\",\"description\":\"Specifies the subtype of the recipient's bank account.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\"]}},\"description\":\"Contains detailed information about the individual receiving federal benefits.\\n**Required only when the SEC code is \\\"ENR\\\".**\\nOptional in all other cases.\\n\"},\"AdditionalInfoDebitPayment\":{\"properties\":{\"channel\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"API\"},\"costCenter\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"This is an optional field. A cost center is a function within an organization that does not directly add to profit but still costs money to operate, such as the accounting, HR, or IT departments\",\"example\":\"12897\"},\"requestMethod\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"This is an optional field. Customer payment request method from a given channel for e.g. WALK-IN, PHONE-IN etc. \",\"example\":\"WALK-IN\"},\"detailsOfCharges\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"who pays the payment charges. This is an optional field. For `speed` associated with Fedwire, the applicable values are `OUR`, `BEN`, and `SHA`.\",\"example\":\"OUR\"},\"secCode\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"An SEC code is a three letter code that describes how a payment was authorized by the consumer or business receiving an ACH transaction. This is an optional field needed only for the speed associated with the ACH payment rail.\",\"example\":\"CCD\"},\"transactionTypeCode\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"This is an optional field. This is a secondary secCode can be set when the sec code is set to IAT.\",\"example\":\"ANN\"},\"receiverIdentificationNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is an optional field. It represents the Receiver’s DFI Identification Number and is applicable when the secCode is set to IAT. The value will be truncated by the system based on the selected payment rail.\",\"example\":\"12334356\"},\"fxContractNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Unique identifier associated with the FX trade applicable for the international payment\",\"example\":\"111234\"},\"originatortoBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\"},\"senderToReceiverNotes\":{\"maxLength\":210,\"type\":\"string\",\"description\":\"This is applicable for the fedwire payment specifies additional information for the Receiver. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6500} tag.\",\"example\":\"Sender To Reciever Notes\"},\"paymentRemittanceNotes\":{\"type\":\"string\",\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\\n- Terminator handling for **ACH**:\\n  The system automatically appends a **tilde** (`~`) as the\\n  segment terminator at the end of the value if one is not\\n  already provided.\\n\\n  If you explicitly provide a terminator, the following are\\n  accepted:\\n    - Tilde: `~`\\n    - Backslash: `\\\\`\\n\\n  Example without terminator (system will auto-append `~`):\\n    `Invoice payment for order 12345`\\n\\n  Example with explicit terminator:\\n    `Invoice payment for order 12345~`\\n\\n- **Character limit rules for ACH:**\\n  \\n  - **Rule 1 — With terminator:**        \\n    The maximum allowed length is 80 characters including the terminator.\\n\\n  - **Rule 2 — Without terminator:**\\n    If no terminator is provided, the value must not exceed 79 characters.\\n    The system will auto-append ~, making the final stored length exactly 80 characters.\\n\"},\"operationNote\":{\"maxLength\":1000,\"type\":\"string\",\"description\":\"Operation Notes\"},\"localInstruments\":{\"type\":\"string\",\"description\":\"Local instrument code applicable for RTP or FEDNOW payment.\\n\",\"example\":\"STANDARD\",\"enum\":[\"STANDARD\",\"ZELLE\",\"INTERMEDIARY\",\"FDNA\"]},\"requestedExecutionDate\":{\"type\":\"string\",\"description\":\"This field is required for RFP FEDNOW and RTP payments, and the valid date format is [MM-dd-yyyy]. If earlyPayment is set to 'False,' the debtor must instruct payment on the date specified in the request for payment. If earlyPayment is set to 'True,' the debtor has the option to instruct payment before the date indicated in the request for payment.\",\"example\":\"07-21-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Optional expiry date for RFP FedNow and RTP payments in the format MM-dd-yyyy.\\nIf not provided, the system automatically sets a default expiry:\\n• **RTP:** 30 days from the current date\\n• **FedNow:** 1 year from the current date\\nAfter the expiry date, the payer can no longer accept, pay, decline, or reject the request.\\n\",\"example\":\"07-21-2022\"},\"amountModificationAllowed\":{\"type\":\"boolean\",\"description\":\"This field is optional for RFP FEDNOW and RTP payments. When set to 'True,' the debtor has the option to instruct payment for an amount different than the one indicated in the request for payment (Instructed Amount). When set to 'False,' the debtor is required to instruct payment for the exact amount specified in the request for payment (Instructed Amount).\",\"example\":true},\"earlyPayment\":{\"type\":\"boolean\",\"description\":\"This field is optional for RFP FEDNOW and RTP payments. When set to 'True,' the debtor is allowed to instruct payment before the date indicated in the request for payment (Requested Execution Date). When set to 'False,' the debtor is required to instruct payment on the date indicated in the request for payment (Requested Execution Date).\",\"example\":true},\"guaranteedPayment\":{\"type\":\"boolean\",\"description\":\"This field is optional for RFP FEDNOW and RTP payments. When set to 'True,' the creditor requests payment guarantees from the debtor when scheduling the payment. When set to 'False,' the creditor does not request payment guarantees from the debtor when scheduling the payment.\",\"example\":true}}},\"BookTransferSender\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Transfer payment sender bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the sender information are not needed.\",\"example\":\"123452334\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank account number from where the money will be withdrawn. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"123452334\"},\"accountType\":{\"type\":\"string\",\"description\":\"This field is optional but required if accountUID is not provided.\",\"example\":\"Deposit\",\"enum\":[\"GL\",\"Loan\",\"Deposit\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"When the account number is tokenized this field is required.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountName\":{\"type\":\"string\",\"description\":\"Name of the account. This is an optional field.\",\"example\":\"Payroll Account\"},\"currency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"This is an optional field it will be defaulted to USD.\",\"example\":\"USD\"},\"routingNumber\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Optional field, only required when the account number is tokenized.\",\"example\":\"022300173\"}}},\"BookTransferReceiver\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Transfer payment sender bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the receiver information are not needed.\",\"example\":\"022300173\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank account number from where the money will be withdrawn. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"123452334\"},\"accountType\":{\"type\":\"string\",\"description\":\"This field is optional but required if accountUID is not provided.\",\"example\":\"Deposit\",\"enum\":[\"GL\",\"Loan\",\"Deposit\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"When the account number is tokenized this field is required.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountName\":{\"type\":\"string\",\"description\":\"Name of the account. This is an optional field.\",\"example\":\"Payroll Account\"},\"currency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"This is an optional field it will be defaulted to USD.\",\"example\":\"USD\"},\"routingNumber\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Optional field, only required when the account number is tokenized.\",\"example\":\"022300173\"}}},\"PaymentSender\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Sender bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the sender information are not needed.\",\"example\":\"1021\"},\"achCompanyID\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH origination/company id is a 10-digit identifier used for ACH payment processing, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”). This is an optional field, it is required when the accountUID is not provided and payment speed associated with the ACH payment rail.\",\"example\":\"122334789\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender bank account number from where the money will be withdrawn. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"123452334\"},\"accountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided and for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"name\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Sender name associated with the payment. This is an optional field, it is required when the accountUID is not provided. For the speed associated with the fedwire payment rail, this will be mapped to {5000} tag.\",\"example\":\"Sender Name\"},\"entityType\":{\"type\":\"string\",\"description\":\"Type of the entity. It is required when the accountUID is empty and accountType is Deposit. The valid values are Consumer or Corporate.\",\"example\":\"Consumer\",\"enum\":[\"Consumer\",\"Corporate\",\"Processing Org\"]},\"address\":{\"$ref\":\"#/components/schemas/SenderOrCreditAddress\"},\"bankIdType\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided. The unique identifier type to identifiy the bank details. You have two options either provide NID or SWIFT. A SWIFT code — sometimes also called a BIC number — is a standard format for Business Identifier Codes (BIC). It is an 8 to 11-character code that identifies banks globally. An NID number (a.k.a ABA/routing number) it is 9-digit numeric characters used by banks to identify specific financial institutions within the United States.\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"bankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is an optional field required only if the sender account does not exists in the CRM system. This signifies the NID (ABA/Routing numner) or SWIFT code as per the bankIdType. For the speed associated with the fedwire payment rail, this will be mapped to {3100} tag.\",\"example\":\"101206101\"},\"phone\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Phone number associated with the sender. This is an optional field.\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Email associated with the sender. This is an optional field.\",\"example\":\"email@domain.com\"},\"swiftTag\":{\"type\":\"string\",\"description\":\"Deprecated filed, Previously this is applicable for the CTP fedwire payment where the local instrument set to COVS\",\"deprecated\":true},\"swiftNote\":{\"type\":\"string\",\"description\":\"Deprecated field, Previously this is applicable for the CTP fedwire payment where the local instrument set to COVS\",\"deprecated\":true},\"correspondentBankId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"This is an optional field. This is used to provide the \\\"routing number\\\" for the receiver correspondent bank in order to process the international Fedwire payment [where the receiver bank country is outside of the USA]. If the \\\"correspondentBankId\\\" is blank for the international Fedwire payment, then the Finzly system uses the internal configuration to get the correspondent bank details based on the country and currency setup.\",\"example\":\"026009593\"}},\"description\":\"Payment sender and account details from which the money will be deducted.\"},\"PaymentReceiver\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Receiver bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the receiver information are not needed.\",\"example\":\"209219\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver bank account number to which money will be deposited. This is the country specific bank account number such as ABA for USA, CLABE for Mexico,IBAN mainly for european countries  etc. This is required if accountUID is not provided.\",\"example\":\"123422434\"},\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is required for the speed associated with the ACH payment rails.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided and for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Receiver currency. The valid currency code should be per ISO 4217 standard.\",\"example\":\"USD\"},\"name\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver name associated with the payment. This is an optional field, it is required when the accountUID is not provided. For the speed associated with the fedwire payment rail, this will be mapped to {4200} tag.\",\"example\":\"Receiver name\"},\"address\":{\"$ref\":\"#/components/schemas/ReceiverOrDebtorAddress\"},\"phone\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Phone number associated with the receiver. This is an optional field.\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Email associated with the receiver. This is an optional field.\",\"example\":\"email@domain.com\"},\"bank\":{\"$ref\":\"#/components/schemas/Bank\"},\"intermediaryBank\":{\"$ref\":\"#/components/schemas/IntermediaryBank\"},\"swiftTag\":{\"type\":\"string\",\"description\":\"Deprecated field, Previously Beneficiary customer swift tag is applicable for the CTP fedwire payment where the local instrument set to COVS.\",\"deprecated\":true},\"swiftNote\":{\"type\":\"string\",\"description\":\"Deprecated field, Previously Beneficiary customer swift note.This is applicable for the CTP fedwire payment where the local instrument set to COVS\",\"deprecated\":true}},\"description\":\"Contains the payment receiver’s personal and account details, where the funds will be deposited.\\n\\nThis field is **required for all payment types except ENR (Automated Enrollment Entry)**.\\n\"},\"PaymentCreditor\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Creditor bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the sender information are not needed.\",\"example\":\"1021\"},\"achCompanyID\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH company/origination id is a 10-digit identifier used by bank and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"122334789\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Bank account number to which the money will be deposited\",\"example\":\"123452334\"},\"accountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided and for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"name\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Creditor name associated with the payment. This is an optional field, it is required when the accountUID is not provided. For the speed associated with the fedwire payment rail, this will be mapped to {5000} tag.\",\"example\":\"Creditor name\"},\"entityType\":{\"type\":\"string\",\"description\":\"Type of the entity. It is required when the accountUID is empty and accountType is Deposit. The valid values are Consumer or Corporate.\",\"example\":\"Consumer\",\"enum\":[\"Consumer\",\"Corporate\"]},\"address\":{\"$ref\":\"#/components/schemas/SenderOrCreditAddress\"},\"bankIdType\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided. The unique identifier type to identifiy the bank details. You have two options either provide NID or SWIFT. A SWIFT code — sometimes also called a BIC number — is a standard format for Business Identifier Codes (BIC). It is an 8 to 11-character code that identifies banks globally. An NID number (a.k.a ABA/routing number) it is 9-digit numeric characters used by banks to identify specific financial institutions within the United States.\",\"example\":\"NID\"},\"bankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is an optional field required only if the sender account does not exists in the CRM system. This signifies the NID (ABA/Routing numner) or SWIFT code as per the bankIdType. For the speed associated with the fedwire payment rail, this will be mapped to {3100} tag.\",\"example\":\"101206101 or FBOLUS6LXXX\"},\"phone\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Phone number associated with the creditor\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Email associated with the creditor\",\"example\":\"email@domain.com\"}},\"description\":\"Payment creditor and account details to which the money will be deposited.\"},\"PaymentDebtor\":{\"properties\":{\"accountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Debtor bank account unique identifier exist in the Finzly-CRM system. This is an optional field, if this is provided then rest of the debtor information are not needed.\",\"example\":\"1021\"},\"accountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver bank account number to which money will be deposited. This is the country specific bank account number such as IBAN mainly for european countries, CLABE for Mexico, ABA for USA etc.\",\"example\":\"123422434\"},\"accountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is required when the accountUID is not provided.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is required when the accountUID is not provided and for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Debtor currency. The valid currency code should be per ISO 4217 standard.\",\"example\":\"USD\"},\"name\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Debtor name for the account. This is an optional field, it is required when the accountUID is not provided. For the speed associated with the fedwire payment rail, this will be mapped to {4200} tag.\",\"example\":\"XYZ Name\"},\"address\":{\"$ref\":\"#/components/schemas/ReceiverOrDebtorAddress\"},\"phone\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Phone number associated with the debtor. This is an optional field.\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Email associated with the debtor. This is an optional field.\",\"example\":\"email@domain.com\"},\"bank\":{\"$ref\":\"#/components/schemas/Bank\"},\"intermediaryBank\":{\"$ref\":\"#/components/schemas/Bank\"}},\"description\":\"Payment debtor and account details from which the money will be deducted.\"},\"SearchPositivePayDecisionRequest\":{\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"A unique identifier associated with the payment\",\"example\":\"112233\"},\"customerUID\":{\"type\":\"string\",\"description\":\"Customer unique identifier associated with the customer in the Finzly's CRM system\",\"example\":\"112233\"},\"customerName\":{\"type\":\"string\",\"description\":\"Customer name associated with the payment positive rule\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"decisionDateFrom\":{\"type\":\"string\",\"description\":\"Decision date in mm-dd-yyyy format\",\"example\":\"11-01-2024\"},\"decisionDateTo\":{\"type\":\"string\",\"description\":\"Decision date in mm-dd-yyyy format\",\"example\":\"12-01-2024\"},\"amountFrom\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":100},\"amountTo\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":200},\"status\":{\"type\":\"string\",\"description\":\"Specifies the Positive Pay decision status to filter the search results.\\n\\n- If the `status` value is provided, the API will return results matching the exact decision status supplied.\\n- If the `status` value is not provided or is empty, the API will automatically apply the default filter with the following decision statuses:\\n  - AUTO_MATCHED\\n  - APPROVED\\n  - DEFAULT_DECISION\\n  - REJECTED\\n\",\"example\":\"APPROVED\"},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule\",\"example\":\"CCD\"},\"debitDateFrom\":{\"type\":\"string\",\"description\":\"Debit date in mm-dd-yyyy format\",\"example\":\"11-01-2024\"},\"debitDateTo\":{\"type\":\"string\",\"description\":\"Debit date in mm-dd-yyyy format\",\"example\":\"12-01-2024\"},\"paymentDateFrom\":{\"type\":\"string\",\"description\":\"Payment date in mm-dd-yyyy format\",\"example\":\"11-01-2024\"},\"paymentDateTo\":{\"type\":\"string\",\"description\":\"Payment date in mm-dd-yyyy format\",\"example\":\"11-01-2024\"}}},\"SearchPositivePayDecisionResponse\":{\"type\":\"object\",\"properties\":{\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"positivePayExceptions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PositivePayExceptionDecision\"}}}},\"PositivePayExceptionDecision\":{\"properties\":{\"exceptionUID\":{\"type\":\"string\",\"description\":\"Unique identifier associated with positive pay exception\",\"example\":\"00fbe99f-98fb-4e50-aed3-8f903a32d9e2\"},\"paymentUID\":{\"type\":\"string\",\"description\":\"Unique identifier associated with payment\",\"example\":\"259894\"},\"paymentRuleType\":{\"type\":\"string\",\"description\":\"Payment type associated with the rule such as ACH for Positive Pay, FEDWIRE for Drawdown, RFP for Request for Pay etc.\",\"example\":\"ACH\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment Amounnt\",\"format\":\"int64\",\"example\":10},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"2030405060\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"type\":\"string\",\"description\":\"A beneficiary bank name, which is associated with the benificiary account.\",\"example\":\"Bank Name\"},\"exceptionReason\":{\"type\":\"string\",\"description\":\"Reason for the positive pay exception\",\"example\":\"Amount Mismatch\"},\"exceptionDateTime\":{\"type\":\"string\",\"description\":\"Decision date and time in (EST)\",\"example\":\"01-17-2024\"},\"expiryDateTime\":{\"type\":\"string\",\"description\":\"Positive Pay Rule Exception expiry date time in (EST)\",\"example\":\"01-17-2024\"},\"positivePayDecisionStatus\":{\"type\":\"string\",\"description\":\"Decision status\",\"example\":\"APPROVED\"},\"secCode\":{\"type\":\"string\",\"example\":\"CCD\"},\"approvedBy\":{\"type\":\"string\",\"description\":\"User who approved the exception\",\"example\":\"user001\"},\"approvedDate\":{\"type\":\"string\",\"description\":\"Approval date and time in (EST)\",\"example\":\"01-17-2024\"}}},\"ActivatePositivePayExceptionResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success or Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"PPD001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to activate or suspend a positive pay exception: <Failure Reason>.\"},\"data\":{\"type\":\"string\",\"description\":\"Payment Unique identifier.\",\"example\":\"123456789\"}}},\"ApproveOrRejectPositivePayExceptionResponse\":{\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to Approve or Reject a positive pay exception: <Failure Reason>.\"}}},\"ActivatePositivePayExceptionSuccessResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Exception approved successfully\"},\"data\":{\"type\":\"string\",\"description\":\"Payment Unique identifier.\",\"example\":\"123456789\"}}},\"ActivatePositivePayExceptionFailureResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"PPD001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"The exception has expired and cannot be processed.\"}}},\"SearchPositivePayRuleRequest\":{\"properties\":{\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"customerName\":{\"type\":\"string\",\"description\":\"Short name of the customer who created the positive rule\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Customer bank account number on which the positive rule is defined.\",\"example\":\"12387878\"},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"11-01-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiration date in mm-dd-yyyy format\",\"example\":\"11-01-2022\"},\"status\":{\"type\":\"string\",\"description\":\"Current state of the rule whether Active or Expired etc.\",\"example\":\"Active\"},\"paymentRuleType\":{\"type\":\"string\",\"description\":\"Payment type associated with the rule such as ACH for Positive Pay, FEDWIRE for Drawdown, INSTANT for Request for Pay etc.\",\"example\":\"ACH\"},\"companyAccountNumber\":{\"type\":\"string\",\"description\":\"A company bank account number.\",\"example\":\"1122334\"},\"companyName\":{\"type\":\"string\",\"description\":\"A company is an entity that will receive the payment.\",\"example\":\"Autobell\"},\"companyBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank.\",\"example\":\"071212128\"},\"customerRoutingNumber\":{\"type\":\"string\",\"description\":\"Receiver bank routing number.\",\"example\":\"071212128\"},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency.\",\"example\":\"Onetime\",\"enum\":[\"Onetime\",\"Ongoing\",\"Daily\",\"Weekly\",\"Bi-weekly\",\"Monthly\",\"Quarterly\",\"Semi-annual\",\"Annual\"]},\"transactionIdNumber\":{\"type\":\"string\",\"description\":\"Transaction identification number used in ACH rule matching.\",\"example\":\"TXN12345\"},\"tranCode\":{\"type\":\"string\",\"description\":\"Trancode.\",\"example\":\"27\"}}},\"SearchPositivePayRuleResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success or Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to get positive rules: <Reason>\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PositivePayRule\"}}}},\"GetPositivePayRuleUIDResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success or Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to get positive rule: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/PositivePayRule\"}}},\"UpdatePositivePayRuleResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success or Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to update a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":123456789}}},\"PostPositivePayRuleResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success or Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to add a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":123456789}}},\"DeletePositivePayRuleResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success or Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to delete a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":123456789}}},\"ActivatePositivePayRuleResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"This will return Success/Failed\",\"example\":\"Success or Failure\"},\"code\":{\"type\":\"string\",\"description\":\"This will indicate the error code in case of API error\",\"example\":\"POSITIVERULE001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to activate or suspend a positive rule: <Failure Reason>.\"},\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique id\",\"format\":\"int64\",\"example\":123456789}}},\"UpdatePositivePayRuleRequest\":{\"required\":[\"ruleUID\"],\"type\":\"object\",\"properties\":{\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique reference id. This is mandatory to identify the rule to update.\",\"format\":\"int64\",\"example\":123456789},\"customerName\":{\"type\":\"string\",\"description\":\"Customer name associated with the payment positive rule.\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Bank Account Number.\",\"example\":\"12387878\"},\"achCompanyID\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha to identify the entity collecting payments or sending money via ACH.\",\"example\":\"1234567899\"},\"beneBankId\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank.\",\"example\":\"12345678\"},\"beneName\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Beneficiary name - the person or entity that will receive the payment.\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Beneficiary bank name.\",\"example\":\"Bank Name\"},\"beneAccountNumber\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Beneficiary bank account number.\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount. Must be greater than 0 and less than or equal to 100,000,000.\",\"example\":10},\"currency\":{\"type\":\"string\",\"description\":\"Currency Code. Only USD is supported.\",\"example\":\"USD\",\"default\":\"USD\"},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency.\",\"example\":\"ON_GOING\",\"enum\":[\"ON_GOING\",\"ONE_TIME\",\"DAILY\",\"WEEKLY\",\"BI_WEEKLY\",\"MONTHLY\",\"QUARTERLY\",\"SEMI_ANNUAL\",\"ANNUAL\"]},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule. Optional field.\",\"example\":\"CCD\"},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format. Must not be before current date.\",\"example\":\"01-11-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format. Must be after effective date.\",\"example\":\"08-11-2022\"}}},\"PositivePayRule\":{\"required\":[\"ruleUID\"],\"type\":\"object\",\"properties\":{\"ruleUID\":{\"type\":\"number\",\"description\":\"Positive rule unique reference id\",\"format\":\"int64\",\"example\":123456789},\"paymentRuleType\":{\"type\":\"string\",\"description\":\"Payment type associated with the rule such as ACH for Positive Pay, FEDWIRE for Drawdown, INSTANT for Request for Pay etc.\",\"example\":\"ACH\"},\"customerName\":{\"type\":\"string\",\"description\":\"Customer name associated with the payment positive rule\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"customerAccountType\":{\"type\":\"string\",\"description\":\"Receiver account type.\",\"example\":\"Deposit\"},\"customerAccountSubType\":{\"type\":\"string\",\"description\":\"Receiver account sub type.\",\"example\":\"Checking\"},\"tranCode\":{\"type\":\"string\",\"description\":\"Trancode.\",\"example\":\"27\"},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"122334789\"},\"authType\":{\"type\":\"string\",\"description\":\"Authorization type.\",\"example\":\"DEBIT\",\"enum\":[\"DEBIT\",\"CREDIT\"]},\"status\":{\"type\":\"string\",\"description\":\"Current status of the positive pay rule.\",\"example\":\"Active\",\"enum\":[\"Active\",\"Suspended\",\"Expired\"]},\"customerRoutingNumber\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Customer bank routing number associated with the rule.\",\"example\":\"071212128\"},\"entryDescription\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH entry description. Compared to NACHA Batch Header Company Entry Description.\",\"example\":\"PAYROLL\"},\"discretionaryData\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Company discretionary data for ACH rule matching. Compared to NACHA Batch Header Company Discretionary Data.\",\"example\":\"DISC_DATA\"},\"transactionIdNumber\":{\"maxLength\":15,\"type\":\"string\",\"description\":\"Transaction identification number used in ACH rule matching. Represents Identification Number or Check Number depending on SEC Code.\",\"example\":\"TXN12345\"},\"authorizationUntil\":{\"type\":\"string\",\"description\":\"ACH authorization until setting. Determines when the rule expires.\",\"example\":\"Until Cancelled\",\"enum\":[\"Until Cancelled\",\"Certain Date\",\"Certain number of payments\"]},\"numberOfPayments\":{\"type\":\"number\",\"description\":\"Number of payments the rule remains active for. Applicable when authorizationUntil is 'Certain number of payments'. Valid range 1 to 9999.\",\"example\":10},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"type\":\"string\",\"description\":\"Beneficiary bank name\",\"example\":\"Bank Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10.36},\"currency\":{\"type\":\"string\",\"description\":\"Currency Code\",\"example\":\"USD\",\"default\":\"USD\"},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"Exact or Maximum\"},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency\",\"example\":\"ON_GOING\",\"enum\":[\"ON_GOING\",\"ONE_TIME\",\"DAILY\",\"WEEKLY\",\"BI_WEEKLY\",\"MONTHLY\",\"QUARTERLY\",\"SEMI_ANNUAL\",\"ANNUAL\"]},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule\",\"example\":\"CCD\"},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"11-18-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"11-18-2022\"}}},\"AddPositivePayRule\":{\"required\":[\"amount\",\"amountType\",\"customerAccountNumber\",\"effectiveDate\",\"frequency\",\"paymentRuleType\"],\"type\":\"object\",\"properties\":{\"paymentRuleType\":{\"type\":\"string\",\"description\":\"Payment type associated with the rule such as ACH for Positive Pay, FEDWIRE for Drawdown, INSTANT for Request for Pay etc.\",\"example\":\"ACH, FEDWIRE, INSTANT\"},\"customerName\":{\"type\":\"string\",\"description\":\"Customer name associated with the payment positive rule\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"1234567899\"},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"type\":\"string\",\"description\":\"Beneficiary bank name\",\"example\":\"Bank Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"currency\":{\"type\":\"string\",\"description\":\"Currency Code\",\"example\":\"USD\"},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"Exact or Maximum\"},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency\",\"example\":\"ON_GOING\",\"enum\":[\"ON_GOING\",\"ONE_TIME\",\"DAILY\",\"WEEKLY\",\"BI_WEEKLY\",\"MONTHLY\",\"QUARTERLY\",\"SEMI_ANNUAL\",\"ANNUAL\"]},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule. It is an optional field. If secCode is not provided in the request then the default value i.e 'ALL' will be applicable.\",\"example\":\"CCD\"},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"11-01-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format\",\"example\":\"11-01-2022\"}}},\"ApproveAllPositivePayExceptionRequest\":{\"required\":[\"ids\"],\"properties\":{\"ids\":{\"type\":\"array\",\"description\":\"List of unique identifiers associated with the payment requires decision.\",\"example\":[\"112233\",\"132311\"],\"items\":{\"type\":\"string\"}}}},\"CreditPaymentRequest\":{\"required\":[\"externalReferenceId\",\"paymentAmount\",\"paymentCurrency\",\"sender\",\"speed\"],\"properties\":{\"externalReferenceId\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"**externalReferenceId** is a reference ID assigned by the originator system\\nfor tracking and reconciliation.\\n\\nThis value is not required to be unique and may be reused across multiple\\ncredit and debit payment requests. The API does not enforce uniqueness.\\n\\n**externalReferenceId** does not provide idempotency. Clients must use the\\n`Idempotent-Key` request header to prevent duplicate processing.\\n\",\"example\":\"123e4567-e89b-12d3-a456-4266141740\"},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount. The payment amount is validated as per the limits set by the payment rails or by the bank for the customer.\\nFor the Fedwire payment, this will be mapped to the {2000} tag.\\n\\n❗ **Zero (`0`) is only allowed for ENR (Automated Enrollment Entry) payments.**\\nFor all other payment types, the amount must be **greater than zero**.\\n\\nPayment rail limits per transaction:\\n  - RTP: up to $1,000,000\\n  - FedNow: up to $500,000\\n  - Fedwire: up to $9,999,999,999.99\\n  - Same Day ACH: up to $1,000,000\\n\",\"format\":\"double\",\"example\":175},\"paymentCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Receiver payment currency code. The valid country currency code should be per ISO 4217 standard.\",\"example\":\"USD\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"Format: String with valid format as: MM-DD-YYYY\\n\\nThis is an optional field and signifies the date on which the Finzly system will settle the payment. If the paymentDate is not provided by the API user BankOS will derive it for the earliest available settlement date (not prior to the current business date), based on the configuration.\\n\\nACH Payments are typically settled two days after the current date.\\n\\nPayment requests via API can be submitted using the following example guidelines:\\n\\n**Examples:**\\n\\n1. For Payment speed = Express (Wires), if the payment is submitted/created today* before cut-off, it will be sent to beneficiary today itself.\\n2. For Payment speed = Instant (FedNow, RTP), if the payment is submitted/created today before, it will be sent to beneficiary today itself.\\n3. For Payment speed = Economy Plus, if the payment is submitted/created today before cut-off, it will be sent to beneficiary today itself.\\n4. For Payment speed = Economy and if submitted/created for today before cut-off time, then the transaction shall have effective entry date of two days or one day after submission (T+2 or T+1) depending on your bank’s configuration. For Payment speed = Economy and if submitted on (12th Aug) for delivery date (on 16th Aug) before cut-off time, then the transaction shall be sent to beneficiary on 14th Aug assuming the configuration is two days prior to paymentDate.\\n\\n* today being business day\\n\",\"example\":\"05-08-2024\"},\"speed\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Speed associated with the payment based on the delivery time and fee. The Speed names and associated payment rail can be configured or defined by the bank/financial institutions. The supported payment rails in FinzlyOS are ACH, Fedwire, SWIFT, RTP or FedNow. The following are the standard speed names and payment rails configured by default Economy - [ACH-REGULAR], Economy Plus [ACH-SAMEDAY], Express [FEDWIRE], Instant [FEDNOW or RTP], ON [SWIFT], TN [SWIFT], SPOT [SWIFT].\",\"example\":\"Economy\"},\"paymentNotes\":{\"maxLength\":215,\"minLength\":1,\"type\":\"string\",\"description\":\"Payment notes provided by the payment originator. These notes will be truncated to the maximum allowed length. The notes are passed to the payment network as per the specification such as for ACH upto 10 chars, Fedwire upto 140 chars [Tag 6400 - Beneficiary information], SWIFT upto 140 chars [Tag 70], RTP/FedNow upto 140 chars [ISO 20022 - RmtInf Tag]. The value will be truncated if it exceeds the data length limit. \\n`paymentNotes` is required for ACH and SWIFT payments.\\n\",\"example\":\"Notes\"},\"sender\":{\"$ref\":\"#/components/schemas/PaymentSender\"},\"ultimateSender\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate sender. Required when any `address` field is supplied.\",\"example\":\"ACME Holdings Inc.\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate sender. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"9901020301\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate sender address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"119 N. MAIN ST\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate sender city. Required when `name` is provided on `ultimateSender`.\",\"example\":\"FAYETTE\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender state/region.\",\"example\":\"MO\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"65248\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateSender`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate sender.\\n\\nConditional rules:\\n  If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\n  Required when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that ultimately originated the funds being moved, when different from `sender`. Used to convey an ultimate originator for third-party-originated payments (for example, a corporate sending on behalf of its end customer).\\n\\nThis object is entirely optional. When omitted, the server treats the payment as not having a distinct ultimate sender. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"receiver\":{\"$ref\":\"#/components/schemas/PaymentReceiver\"},\"ultimateReceiver\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate receiver. Required when any `address` field is supplied.\",\"example\":\"Globex End Customer LLC\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate receiver. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"89895656\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate receiver address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"101 SR\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate receiver city. Required when `name` is provided on `ultimateReceiver`.\",\"example\":\"TAMPA\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver state/region.\",\"example\":\"FL\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"33601\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateReceiver`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate receiver.\\n\\nConditional rules:\\n If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that ultimately benefits from the payment, when different from `receiver`. Used to convey an ultimate beneficiary when the immediate beneficiary is an intermediary (for example, a payment processor receiving on behalf of a merchant).\\n\\nThis object is entirely optional. When omitted, the server treats the payment as not having a distinct ultimate receiver. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"fee\":{\"$ref\":\"#/components/schemas/Fee\"},\"recurrence\":{\"$ref\":\"#/components/schemas/PaymentRecurrence\"},\"additionalInfo\":{\"$ref\":\"#/components/schemas/AdditionalInfoCreditPayment\"}}},\"BookTransferRequest\":{\"required\":[\"externalReferenceId\",\"paymentAmount\",\"paymentDate\",\"receiverAccount\",\"senderAccount\"],\"properties\":{\"externalReferenceId\":{\"maxLength\":200,\"type\":\"string\",\"description\":\"Unique reference id from a system outside of finzly. The external reference id can be used by the finzly for the request tracing (if needed).\",\"example\":\"Payment101\"},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount in USD you want to transfer.\",\"example\":100},\"paymentDate\":{\"type\":\"string\",\"description\":\"Payment date in mm-dd-yyyy format. This can be same date of Payment request or a future date.  In case of a Recurring Payments, this shall be the date on which the 1st Standing Order will be executed.   User may need to provide this as future date in case of a need to start the standing order in a future date.\",\"example\":\"07-21-2022\"},\"paymentNotes\":{\"maxLength\":250,\"minLength\":1,\"type\":\"string\",\"description\":\"Payment notes provided by the payment originator.\",\"example\":\"Payment Notes\"},\"channel\":{\"type\":\"string\",\"description\":\"The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"API\"},\"senderAccount\":{\"$ref\":\"#/components/schemas/BookTransferSender\"},\"receiverAccount\":{\"$ref\":\"#/components/schemas/BookTransferReceiver\"},\"additionalInfo\":{\"$ref\":\"#/components/schemas/BookTransferAdditionalInfo\"},\"recurrence\":{\"$ref\":\"#/components/schemas/PaymentRecurrence\"}}},\"BookTransferAdditionalInfo\":{\"properties\":{\"senderAccountTokenId\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the sender account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the sender to ensure the transaction is processed correctly and securely. Only alphanumeric characters and colons are allowed.\",\"example\":\"1234567ABCD\"},\"receiverAccountTokenId\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the receiver account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the receiver to ensure the transaction is processed correctly and securely. Only alphanumeric characters and colons are allowed.\",\"example\":\"ABCD734989\"}}},\"BookTransferResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"BOOKTRF001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to create a book transfer payment: <Reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"example\":\"1359899\"},\"paymentStatus\":{\"type\":\"string\",\"example\":\"PROCESSED\"},\"externalReferenceId\":{\"type\":\"string\",\"example\":\"87878745a78r787\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id which is associated with the payment.\",\"example\":5599}}}}},\"PaymentResponse\":{\"properties\":{\"status\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PAYMENT001\"},\"message\":{\"maxLength\":250,\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to create a payment: <Reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"12930\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returing the unique reference id provided by the originator system.\",\"example\":\"123e4567\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id which is associated with the payment.\",\"example\":5599}}}}},\"DebitPaymentRequest\":{\"required\":[\"creditor\",\"debtor\",\"externalReferenceId\",\"paymentAmount\",\"paymentCurrency\",\"speed\"],\"properties\":{\"externalReferenceId\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"**externalReferenceId** is a reference ID assigned by the originator system\\nfor tracking and reconciliation.\\n\\nThis value is not required to be unique and may be reused across multiple\\ncredit and debit payment requests. The API does not enforce uniqueness.\\n\\n**externalReferenceId** does not provide idempotency. Clients must use the\\n`Idempotent-Key` request header to prevent duplicate processing.\\n\",\"example\":\"123e4567-e89b-12d3-a456-4266141740\"},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount. The payment amount are validated as per the limit set by the payment rails or by the bank for the customer. For the Fedwire payment this will be mapped to {2000} tag.The payment rail limit per transaction are RTP upto 1M$, FedNow upto $500K, Fedwire upto $9,999,999,999.99, Same Day ACH upto 1M$.\",\"format\":\"double\",\"example\":123},\"paymentCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Sender payment currency code. The valid country currency code should be per ISO 4217 standard.\",\"example\":\"USD\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"This is an optional field. It signifies the payment date on which the Finzly system will pick up the payment to process. The payment date will be default to the current date if it is empty. The valid date format is in [MM-dd-yyyy]. User can set the payment date as current date or future date however, for the payment sets to the current date, the Finzly system may change the date based upon the bank/FI configuration for-instance, If the payment SPEED associated with the ACH [SAMEDAY/REGULAR], FEDWIRE and the last submission cutoff time is passed then the payment date will be set to the next business date, or the payment request will be rejected [as per the bank chosen behavior].\",\"example\":\"07-21-2022\"},\"speed\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Speed associated with the payment based on the delivery time and fee. The Speed names and associated payment rail can be configured or defined by the bank/financial institutions. The supported payment rails in FinzlyOS are ACH, Fedwire, RTP or FedNow. The following are the standard speed names and payment rails configured by default Economy - [ACH-REGULAR], Economy Plus [ACH-SAMEDAY], Express [FEDWIRE], Instant [FEDNOW or RTP].\",\"example\":\"Economy\"},\"paymentNotes\":{\"maxLength\":215,\"minLength\":1,\"type\":\"string\",\"description\":\"Payment notes provided by the payment originator. These notes will be truncated to the maximum allowed length. The notes are passed to the payment network as per the specification such as for ACH upto 10 chars, Fedwire upto 35 chars [Tag 6400 - Beneficiary information], SWIFT upto 140 chars [Tag 70], RTP/FedNow upto 140 chars [ISO 20022 - RmtInf Tag]. The value will be truncated if it exceeds the data length limit.\",\"example\":\"Notes\"},\"creditor\":{\"$ref\":\"#/components/schemas/PaymentCreditor\"},\"ultimateCreditor\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate creditor. Required when any `address` field is supplied.\",\"example\":\"ACME Holdings Inc.\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate creditor. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"9901020301\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate creditor address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"119 N. MAIN ST\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate creditor address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate creditor address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate creditor city. Required when `name` is provided on `ultimateCreditor`.\",\"example\":\"FAYETTE\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate creditor state/region.\",\"example\":\"MO\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"65248\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateCreditor`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate creditor.\\n\\nConditional rules:\\n  If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that ultimately originates the collection, when different from `creditor`. Used to convey an ultimate originator for third-party-originated debit requests (for example, a corporate collecting on behalf of its end customer).\\n\\nThis object is entirely optional. When omitted, the server treats the debit as not having a distinct ultimate creditor. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"debtor\":{\"$ref\":\"#/components/schemas/PaymentDebtor\"},\"ultimateDebtor\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate debtor. Required when any `address` field is supplied.\",\"example\":\"Globex End Customer LLC\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate debtor. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"89895656\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate debtor address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"101 SR\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate debtor address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate debtor address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate debtor city. Required when `name` is provided on `ultimateDebtor`.\",\"example\":\"TAMPA\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate debtor state/region.\",\"example\":\"FL\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"33601\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateDebtor`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate debtor.\\n\\nConditional rules:\\n  If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that is ultimately debited, when different from `debtor`. Used to convey the ultimate account holder whose funds are being pulled when the immediate debtor is an intermediary.\\n\\nThis object is entirely optional. When omitted, the server treats the debit as not having a distinct ultimate debtor. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"fee\":{\"$ref\":\"#/components/schemas/Fee\"},\"recurrence\":{\"$ref\":\"#/components/schemas/PaymentRecurrence\"},\"additionalInfo\":{\"$ref\":\"#/components/schemas/AdditionalInfoDebitPayment\"}}},\"CancelPaymentResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Failure code associated with the error.\",\"example\":\"PAYMENT001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to cancel a payment: <Reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\"}}}}},\"ReturnPaymentRequest\":{\"properties\":{\"achReturnCode\":{\"type\":\"string\",\"description\":\"Deprecated, If the payment type is ACH then the achReturnCode is mandatory and valid ACH return code such as R01,R02 etc.\",\"example\":\"R01\"},\"returnCode\":{\"type\":\"string\",\"description\":\"If the payment type is FEDWIRE, then 'returnCode' is mandatory. For ACH payments, use 'returnCode' instead of 'achReturnCode'. All validations for ACH and FEDWIRE return codes are now handled through this field.\",\"example\":\"CUST\",\"enum\":[\"AC01\",\"AC03\",\"AC04\",\"AC06\",\"AC14\",\"DUPL\",\"AM06\",\"AM09\",\"BE05\",\"BE06\",\"CUST\",\"FOCR\",\"FR01\",\"MS02\",\"MS03\",\"NARR\",\"RR01\",\"RR02\",\"RR03\",\"RR04\",\"RUTA\",\"UPAY\"]},\"returnNotes\":{\"type\":\"string\",\"description\":\"If the payment type is FEDWIRE, `returnNotes` is required.\\nIf the payment type is RTP and `returnNotes` is not provided,\\nit defaults to `Customer Initiated`.\\n\",\"example\":\"Invalid payment request.\"},\"returnType\":{\"type\":\"string\",\"description\":\"Applicable only for RTP payments. This field is mandatory for RTP.\\nAllowed values are `IPAY`, `PECR`, and `RJCR`.\\n\",\"example\":\"IPAY\"},\"settlementAmount\":{\"type\":\"number\",\"description\":\"Applicable only for RTP payments. This field is required when `returnType` is `PECR`.\\n\",\"format\":\"bigdecimal\",\"example\":4500.88},\"rejectReasonCode\":{\"type\":\"string\",\"description\":\"Applicable only for RTP payments. This field is required when `returnType` is `RJCR`. Allowed values are `AC04`, `AM04`, `ARDT`, `CUST`, `LEGL`, `NOAS`, and `NOOR`.\\n\",\"example\":\"AM04\"}}},\"ReturnPaymentResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Failure\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"If the status is Success then the code will be null otherwise code associated with an error.\",\"example\":\"PAYMENT003\"},\"message\":{\"type\":\"string\",\"description\":\"If the status is Success then the code will be null otherwise error message corresponding to an error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to return a payment: <Reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"Payment unique identifier.\",\"example\":\"1235\"}},\"description\":\"If the status is Failure then data will be null\"}}},\"ReversePaymentRequest\":{\"type\":\"object\",\"properties\":{\"reversalNotes\":{\"type\":\"string\",\"description\":\"A brief explanation for why the payment is being reversed.\\n\\nHow this field is used:\\n- ACH payments:\\n  This field is not used and will be ignored.\\n\\n- Fedwire, FedNow and RTP payments:\\n  This field is optional. If not provided, the system will automatically use\\n  \\\"Customer Initiated\\\" as the reason.\\n\",\"example\":\"Duplicate payment - please recall funds\"},\"reversalCode\":{\"type\":\"string\",\"description\":\"A standardized reason code that explains why the payment is being reversed.\\n\\nWhen this field is required:\\n- Required for Fedwire, FedNow, and RTP payments.\\n- Not used for ACH.\\n\\nThe value must be one of the following codes:\\n\\n- AC03 : Invalid account number\\n- AGNT : Requested by bank/agent\\n- AM09 : Incorrect amount\\n- CUST : Requested by customer\\n- CUTA : Unable to apply funds\\n- DUPL : Duplicate payment\\n- FRAD : Suspected fraud\\n- NARR : General explanation\\n- TECH : Technical issue\\n- UPAY : Overpayment\\n\\nIf an invalid code is provided, the request will be rejected.\\n\",\"example\":\"CUST\",\"enum\":[\"AC03\",\"AGNT\",\"AM09\",\"CUST\",\"CUTA\",\"DUPL\",\"FRAD\",\"NARR\",\"TECH\",\"UPAY\"]},\"initiatingParty\":{\"type\":\"string\",\"description\":\"The name of the system initiating the reversal request.\\n\\nThis field applies only to FedNow payments:\\n- If not provided, the system will automatically set it to \\\"API\\\".\\n\\nFor all other payment types (ACH, Fedwire, RTP), this field is ignored.\\n\",\"example\":\"API Customer\"}}},\"ReversePaymentResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"If the status is Success then the code will be null otherwise code associated with an error.\",\"example\":\"PAYMENT004\"},\"message\":{\"type\":\"string\",\"description\":\"If the status is Success then the code will be null otherwise error message corresponding to an error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to reverse a payment: <Reason>\"},\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"Payment unique identifier.\",\"example\":\"1235\"}},\"description\":\"If the status is Failure then data will be null\"}}},\"GetPaymentResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PAYMENT001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"Failed to retrieve a payment: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/GetPaymentData\"}}},\"BulkPaymentResponse\":{\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error/success message indicating the issue in API call along with the reason or you will get success message with HTTP status code.\",\"example\":\"<message>\"}}},\"FileSearchResponse\":{\"type\":\"object\",\"properties\":{\"fileNumber\":{\"type\":\"integer\",\"example\":1000},\"fileName\":{\"type\":\"string\",\"example\":\"RETURNS_Deceased LE_Return01.txt\"},\"fileType\":{\"type\":\"string\",\"example\":\"NACHA\"},\"fileStatus\":{\"type\":\"string\",\"example\":\"FAILED\"},\"counterParty\":{\"type\":\"string\",\"example\":\"PaymentsQA6\"},\"counterPartyId\":{\"type\":\"integer\",\"example\":204},\"ftpUser\":{\"type\":\"string\",\"example\":\"banka-Ftp_Cust\"},\"channel\":{\"type\":\"string\",\"example\":\"FTP\"},\"offsetType\":{\"type\":\"string\",\"example\":\"BATCH_LEVEL\"},\"accountName\":{\"type\":\"string\",\"example\":\"CNL\"},\"accountType\":{\"type\":\"string\",\"example\":\"CUSTOMER\"},\"transactionType\":{\"type\":\"string\",\"example\":\"Return\"},\"offsetAccountNumber\":{\"type\":\"string\",\"example\":\"113337\"},\"offsetRoutingNumber\":{\"type\":\"string\",\"example\":\"101206101\"},\"validPayments\":{\"type\":\"integer\",\"example\":1},\"errorPayments\":{\"type\":\"integer\",\"example\":0},\"totalDebits\":{\"type\":\"number\",\"format\":\"double\",\"example\":1.02},\"totalCredits\":{\"type\":\"number\",\"format\":\"double\",\"example\":0},\"paymentDate\":{\"type\":\"string\",\"format\":\"date\",\"example\":\"2024-02-12\"},\"memoPostDate\":{\"type\":\"string\",\"format\":\"date\",\"example\":\"2025-08-20\"},\"creditMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_APPLICABLE\"},\"debitMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_APPLICABLE\"},\"reverseCreditMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_APPLICABLE\"},\"reverseDebitMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_APPLICABLE\"},\"memoPostFailureReason\":{\"type\":\"string\",\"nullable\":true,\"example\":\"Insufficient balance $1,000.00 for account number 112266\"},\"memoPostRetryCount\":{\"type\":\"integer\",\"nullable\":true,\"example\":0},\"notificationRefNumber\":{\"type\":\"string\",\"nullable\":true},\"authenticationRetryCounter\":{\"type\":\"integer\",\"nullable\":true,\"example\":0},\"customerAccountingStatus\":{\"type\":\"string\",\"example\":\"NOTAPPLICABLE\"},\"customerAccountingDate\":{\"type\":\"string\",\"format\":\"date\",\"nullable\":true,\"example\":\"2025-02-12\"},\"glAccountingStatus\":{\"type\":\"string\",\"example\":\"NOTAPPLICABLE\"},\"glAccountingDate\":{\"type\":\"string\",\"format\":\"date\",\"example\":\"2025-02-12\"},\"fedSettlementId\":{\"type\":\"string\",\"nullable\":true},\"comments\":{\"type\":\"string\",\"example\":\"TEST\"},\"rejectReason\":{\"type\":\"string\",\"nullable\":true,\"example\":\"N/A\"},\"batches\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"example\":\"d4a8a978-9213-488e-b1fd-ef5db864dcfa\"},\"batchNumber\":{\"type\":\"string\",\"example\":\"2372101\"},\"serviceClassCode\":{\"type\":\"string\",\"example\":\"200\"},\"originatingDfiIdentification\":{\"type\":\"string\",\"example\":\"21127263\"},\"status\":{\"type\":\"string\",\"example\":\"VALIDATED\"},\"offsetAccountNumber\":{\"type\":\"string\",\"example\":\"113335\"},\"offsetRoutingNumber\":{\"type\":\"string\",\"example\":\"101206101\"},\"creditMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_POSTED\"},\"debitMemoPostStatus\":{\"type\":\"string\",\"example\":\"NOT_POSTED\"},\"companyName\":{\"type\":\"string\",\"example\":\"ABVidhya DSP TEST 2\"},\"companyId\":{\"type\":\"string\",\"example\":\"1023400009\"},\"secCode\":{\"type\":\"string\",\"example\":\"CTX\"},\"entryHash\":{\"type\":\"integer\",\"example\":0},\"effectiveEntryDate\":{\"type\":\"string\",\"format\":\"date\",\"example\":\"2024-02-12\"},\"currency\":{\"type\":\"string\",\"example\":\"USD\"},\"entryAddendaCount\":{\"type\":\"integer\",\"example\":1},\"totalCreditAmount\":{\"type\":\"number\",\"format\":\"double\",\"example\":0},\"totalDebitAmount\":{\"type\":\"number\",\"format\":\"double\",\"example\":80.98},\"glOffset\":{\"type\":\"boolean\",\"example\":false}}}},\"approvedBy\":{\"type\":\"string\",\"example\":\"admin@finzly.com\"},\"approvedDateTime\":{\"type\":\"string\",\"example\":\"2024-02-12T10:56:39\"},\"lastUpdatedBy\":{\"type\":\"string\",\"example\":\"admin@finzly.com\"},\"lastUpdatedTime\":{\"type\":\"string\",\"example\":\"2024-02-12T10:56:39\"},\"createdBy\":{\"type\":\"string\",\"example\":\"System\"},\"creationDateTime\":{\"type\":\"string\",\"example\":\"2024-02-12T10:56:39\"}}},\"FilePaymentResponse\":{\"type\":\"object\",\"properties\":{\"paymentId\":{\"type\":\"integer\",\"example\":4617266},\"fileNumber\":{\"type\":\"string\",\"example\":\"9247\"},\"paymentStatus\":{\"type\":\"string\",\"example\":\"VALIDATION_FAILED\"},\"amount\":{\"type\":\"number\",\"format\":\"double\",\"example\":36.17},\"deliveryMethod\":{\"type\":\"string\",\"example\":\"FEDWIRE\"},\"paymentDate\":{\"type\":\"string\",\"format\":\"date\",\"example\":\"2025-08-15\"},\"currency\":{\"type\":\"string\",\"example\":\"USD\"},\"paymentNotes\":{\"type\":\"string\",\"nullable\":true,\"example\":\"Testing\"},\"entryType\":{\"type\":\"string\",\"example\":\"CREDIT\"},\"senderName\":{\"type\":\"string\",\"example\":\"Automation Corporate Entity\"},\"senderAccountNumber\":{\"type\":\"string\",\"example\":\"99010200112\"},\"senderBankId\":{\"type\":\"string\",\"example\":\"101206101\"},\"senderAddress1\":{\"type\":\"string\",\"example\":\"2815 Coliseum Centre Dr\"},\"senderAddress2\":{\"type\":\"string\",\"nullable\":true,\"example\":\"Coliseum\"},\"receiverName\":{\"type\":\"string\",\"example\":\"Yellow Production s.r.o.\"},\"receiverAccountNumber\":{\"type\":\"string\",\"example\":\"CZ8080400000002331104858\"},\"receiverBankId\":{\"type\":\"string\",\"example\":\"211272630\"},\"receiverAddress1\":{\"type\":\"string\",\"example\":\"Kubisova 919-19\"},\"receiverAddress2\":{\"type\":\"string\",\"nullable\":true,\"example\":\"Kubisova\"},\"creationDateTime\":{\"type\":\"string\",\"format\":\"dateTime\",\"example\":\"2025-08-15T18:07:44\"},\"paymentType\":{\"type\":\"string\",\"example\":\"WIRE\"},\"cancellationOriginationSource\":{\"type\":\"string\",\"example\":\"API\"},\"cancellationReason\":{\"type\":\"string\",\"example\":\"Insufficient balance\"}}},\"BankResponse\":{\"properties\":{\"routingNumber\":{\"$ref\":\"#/components/schemas/routingNumber\"}}},\"BankSearchResponse\":{\"properties\":{\"routingNumber\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/routingNumber\"}}}},\"PaymentSearchResponse\":{\"properties\":{\"status\":{\"type\":\"string\",\"description\":\"Status of the API request either it will be a success or a failure\",\"example\":\"Success\",\"enum\":[\"Success\",\"Failure\"]},\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"PAYMENT001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call along with the reason.\",\"example\":\"<Reason>\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SearchPaymentData\"}}}},\"BaseResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"example\":\"API900\"},\"message\":{\"type\":\"string\",\"example\":\"Invalid page size: Limit should be greater than 0.\"}}},\"RecurrenceData\":{\"properties\":{\"paymentRecurrenceId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Recurrence unique identifier\",\"example\":\"12898\"},\"paymentOccurrenceId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"paymentOccurrenceId has been deprecated. Please use paymentRecurrenceId instead, as this field will eventually be removed from the system.\",\"example\":\"12898\",\"deprecated\":true},\"endAmount\":{\"maxLength\":35,\"type\":\"number\",\"description\":\"Recurrence payment amount\",\"example\":10.12},\"frequency\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Frequency associated with the payment recurrence. The valid values are Daily, Weekly, BiWeekly, Monthly, Quarterly, SemiAnnually, Yearly.\",\"example\":\"Daily\"},\"payUntil\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"The end of payment recurrence. If it is set to Cancelled that means payment will be processing as per the frequency until it cancelled. If it is set to EndDate that means payment will be processing per the frequency until the defined EndDate. If it is set to NumberOfPayments that means payment will be processing per the frequency until the defined number of payments. \",\"example\":\"Cancelled\",\"enum\":[\"Cancelled\",\"EndDate\",\"NumberOfPayments\"]},\"startDate\":{\"type\":\"string\",\"description\":\"Start Date for the recurrence.\",\"example\":\"2023-06-23\"},\"endDate\":{\"type\":\"string\",\"description\":\"End Date for the recurrence.\",\"example\":\"2023-07-23\"},\"endNumberPayments\":{\"maxLength\":11,\"type\":\"integer\",\"description\":\"Recurrence NumberOfPayments\",\"example\":10},\"status\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Recurrence status\",\"example\":\"Active\"},\"nextPaymentDate\":{\"type\":\"string\",\"description\":\"Next scheduled payment date.\",\"example\":\"2023-07-23\"},\"lastPaymentReference\":{\"type\":\"number\",\"description\":\"Last payment id.\",\"example\":5757}},\"description\":\"Set the payment recurrence based on the available options.\"},\"SearchPaymentData\":{\"properties\":{\"paymentUID\":{\"type\":\"integer\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":110289},\"externalReferenceId\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Unique reference id set by the originator system.\",\"example\":\"pymtref10012\"},\"sourceReferenceId\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Source reference id signifies the bulk file id for the payment originated via FTP.\",\"example\":\"10011\"},\"counterParty\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Legal entity name exist in the Finzly-CRM system and associated with the payment.\",\"example\":\"ABC Shipping\"},\"counterPartyId\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Legal entity [CustomerUID] exist in the Finzly-CRM system and associated with the payment.\",\"example\":\"10920\"},\"customerType\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"Customer type associated with the payment.\",\"example\":\"Corporate\"},\"businessUnit\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Processing org name assigned to the payment.\",\"example\":\"Bank Name\"},\"businessUnitId\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Processing org id assigned to the payment.\",\"example\":\"189\"},\"channel\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"API\"},\"costCenter\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The cost center associated with the payment. A cost center is also known as a cost pool or expense center\",\"example\":\"562687\"},\"book\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The book associated with the payment. The book is needed to assign proper GL accounts.\",\"example\":\"ACH\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"The payment date when the payment is processed\",\"example\":\"2024-04-25\"},\"senderAccountUID\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Sender account unique identifier defined in the Finzly-CRM system and associated with the payment.\",\"example\":\"3248\"},\"senderAmount\":{\"type\":\"number\",\"description\":\"The sender payment amount.\",\"example\":10.67},\"senderCurrency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"Sender currency in ISO Currency Code format\",\"example\":\"USD\"},\"receiverAmount\":{\"type\":\"number\",\"description\":\"The receiver payment amount.\",\"example\":10.67},\"receiverCurrency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"Receiver currency in ISO Currency Code format\",\"example\":\"USD\"},\"deliveryMethod\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"One of the payment network delivery methods that includes ACH, FEDWIRE, RTP, FEDNOW, SWIFT\",\"example\":\"ACH\"},\"paymentType\":{\"type\":\"string\",\"description\":\"Specifies the payment type associated with the transaction.\",\"example\":\"REGULAR_ACH\"},\"deliveryDate\":{\"type\":\"string\",\"description\":\"The delivery date when the payment is processed.\",\"example\":\"2024-04-25\"},\"paymentNotes\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Notes associated with the payment.\",\"example\":\"Payment for the invoice ABC123\"},\"deliveryAgentType\":{\"type\":\"string\",\"description\":\"Debit account type. The possible values are Deposit, GL, Loan.\",\"example\":\"Deposit\"},\"wireType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Wire type associated with the payment request.\",\"example\":\"OUTGOING_PAYMENT\"},\"senderName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name of the sender linked to the payment.\",\"example\":\"Sender Name\"},\"senderAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender bank account number associated with the payment.\",\"example\":\"8982618\"},\"senderAccountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Sender bank account name\",\"example\":\"DDA Account\"},\"senderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender address 1\",\"example\":\"2815 Coliseum Centre Dr\"},\"senderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender address 2\",\"example\":\"2815 Coliseum Centre Dr\"},\"senderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender city\",\"example\":\"Charlotte\"},\"senderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender State\",\"example\":\"Charlotte\"},\"senderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Zip Code\",\"example\":\"121254\"},\"senderCountryCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Country Code\",\"example\":\"US\"},\"senderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"senderEmail\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender email\",\"example\":\"lename@gmail.com\"},\"senderAccountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Account Type\",\"example\":\"Deposit\"},\"senderAccountSubType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Account sub type\",\"example\":\"Checking\"},\"senderBankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank ID type such as BY NID, BY SWIFT.\",\"example\":\"BY NID\"},\"senderBankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank ID value per the senderBankIdType\",\"example\":\"101206101\"},\"senderBankName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Sender Bank Name\"},\"senderBankAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Address 1\",\"example\":\"9019 STATE ROUTE 7\"},\"senderBankAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Address 2\"},\"senderBankCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank City\",\"example\":\"LEE'S SUMMIT\"},\"senderBankState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank State\",\"example\":\"MO\"},\"senderBankZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Zip/Postal code\",\"example\":\"64064\"},\"senderBankCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"senderAccountTokenId\":{\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the sender account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the sender to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.\",\"example\":\"1234567ABCD\"},\"intermediarySender\":{\"type\":\"boolean\",\"description\":\"Is Intermediary Sender\",\"example\":false},\"intermediarySenderName\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Name\",\"example\":\"Finzly bank\"},\"intermediarySenderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Address 1\",\"example\":\"119 N. MAIN ST\"},\"intermediarySenderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Address 2\",\"example\":\"119 N. MAIN ST\"},\"intermediarySenderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank City\",\"example\":\"FAYETTE\"},\"intermediarySenderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank State\",\"example\":\"MO\"},\"intermediarySenderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Zip/Postal code\",\"example\":\"65248\"},\"intermediarySenderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"intermediarySenderId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank ID\",\"example\":\"101902735\"},\"intermediarySenderIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank ID Type\",\"example\":\"NID\"},\"ultimateSenderName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Ultimate Sender Name\",\"example\":\"Ultimate Sender Name\"},\"ultimateSenderAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Account Number\",\"example\":\"9901020301\"},\"ultimateSenderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Address 1\",\"example\":\"119 N. MAIN ST\"},\"ultimateSenderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Address 2\",\"example\":\"119 N. MAIN ST\"},\"ultimateSenderTaxId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender ACH Company ID\",\"example\":\"656565\"},\"ultimateSenderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender City\",\"example\":\"FAYETTE\"},\"ultimateSenderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender State\",\"example\":\"MO\"},\"ultimateSenderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Zip/Postal code\",\"example\":\"653598\"},\"ultimateSenderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"fboAccountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"FBO account name\",\"example\":\"Bank account name\"},\"fboAccountNumber\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"FBO account number\",\"example\":\"25896565\"},\"fboAccountType\":{\"maxLength\":30,\"type\":\"string\",\"description\":\"FBO account type e.g. Saving, Deposit, Loan\",\"example\":\"saving\"},\"receiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Receiver name\",\"example\":\"xyz\"},\"receiverAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account number\",\"example\":\"2565656\"},\"receiverAccountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account type\",\"example\":\"Deposit\"},\"receiverAccountSubType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account sub type\",\"example\":\"Checking\"},\"receiverType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Type\"},\"receiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Address 1\",\"example\":\"PO BOX 27025\"},\"receiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Address 2\",\"example\":\"PO BOX 27025\"},\"receiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver City\",\"example\":\"RICHMOND\"},\"receiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver State\",\"example\":\"VA\"},\"receiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Zip/Postal Code\",\"example\":\"235963\"},\"receiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Country\",\"example\":\"UNITED STATES OF AMERICA\"},\"receiverPhoneNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Phone number\",\"example\":\"789565689\"},\"receiverEmail\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Email\",\"example\":\"abc@gmail.com\"},\"receiverBankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank ID Type such as BY NID, BY SWIFT\",\"example\":\"BY NID\"},\"receiverBankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank ID value\",\"example\":\"2359430\"},\"receiverBankName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Receiver Bank Name\",\"example\":\"BANK OF AMERICA N.A\"},\"receiverBankAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Address 1\",\"example\":\"PO BOX 27025\"},\"receiverBankAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Address 2\",\"example\":\"PO BOX 27025\"},\"receiverBankCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank City\",\"example\":\"RICHMOND\"},\"receiverBankState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank State\",\"example\":\"VA\"},\"receiverBankZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Zip/Postal Code\",\"example\":\"126565\"},\"receiverBankCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"receiverAccountTokenId\":{\"type\":\"string\",\"description\":\"A token Id in the context of Payment transaction processing typically refers to a unique identifier associated with the receiver account. This token id may be sent in the payment transaction for the purposes of tracking, authenticating, authorizing or reconciling the payment from the receiver to ensure the transaction is processed correctly and securely. Only alphanumeric characters are allowed.\",\"example\":\"ABCD734989\"},\"intermediaryReceiver\":{\"type\":\"boolean\",\"description\":\"Is Intermediary Receiver\",\"example\":false},\"intermediaryReceiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Name\",\"example\":\"TAMPA STATE BANK\"},\"intermediaryReceiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Address 1\",\"example\":\"326 MAIN\"},\"intermediaryReceiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Address 2\",\"example\":\"326 MAIN\"},\"intermediaryReceiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank City\",\"example\":\"TAMPA\"},\"intermediaryReceiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank State\",\"example\":\"KS\"},\"intermediaryReceiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Zip/Postal Code\",\"example\":\"254455\"},\"intermediaryReceiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"intermediaryReceiverIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank ID Type\",\"example\":\"BY NID\"},\"intermediaryReceiverId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank ID value\",\"example\":\"101110572\"},\"ultimateReceiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Ultimate Receiver Name\",\"example\":\"xyz\"},\"ultimateReceiverAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Account Number\",\"example\":\"89895656\"},\"ultimateReceiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Address 1\",\"example\":\"sr no. 101\"},\"ultimateReceiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Address 2\",\"example\":\"sr no. 1\"},\"ultimateReceiverTaxId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver ACH Company ID\",\"example\":\"21545\"},\"ultimateReceiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Ultimate City\",\"example\":\"TAMPA\"},\"ultimateReceiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver State\",\"example\":\"KS\"},\"ultimateReceiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Zip/Postal Code\",\"example\":\"265989\"},\"ultimateReceiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"quoteId\":{\"maxLength\":200,\"type\":\"string\",\"description\":\"FX quote associated with the SWIFT payment.\",\"example\":\"248a3f96-7bb0-47a5-84b7-348f02930225\"},\"forexContract\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"FX contract number is present only for the internal payment\",\"example\":\"9898989\"},\"createdBy\":{\"type\":\"string\",\"description\":\"Payment Created By\",\"example\":\"System\"},\"creationDateTime\":{\"type\":\"string\",\"description\":\"Payment Creation Date Time\",\"example\":\"2023-06-23T14:56:59\"},\"entryType\":{\"type\":\"string\",\"description\":\"Payment type\",\"example\":\"CREDIT\"},\"status\":{\"type\":\"string\",\"description\":\"Payment status\",\"example\":\"PROCESSED\"},\"memoPostStatus\":{\"type\":\"string\",\"description\":\"Status of the memo posting process for the payment\",\"example\":\"FAILURE\"},\"memoPostFailureReason\":{\"type\":\"string\",\"description\":\"Reason for memo posting failure.\",\"example\":\"Insufficient balance $1,000.00 for account number 112266.\"},\"recurrence\":{\"$ref\":\"#/components/schemas/RecurrenceData\"},\"benefitReceiver\":{\"$ref\":\"#/components/schemas/BenefitReceiverReasponse\"}},\"description\":\"Search payments based on various parameters. This provides limited payment data in comparison with GetPayment response.\"},\"GetPaymentData\":{\"properties\":{\"paymentUID\":{\"type\":\"integer\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":110289},\"externalReferenceId\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Unique reference id set by the originator system.\",\"example\":\"pymtref10012\"},\"sourceReferenceId\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Source reference id signifies the bulk file id for the payment originated via FTP.\",\"example\":\"10011\"},\"counterParty\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Legal entity name exist in the Finzly-CRM system and associated with the payment.\",\"example\":\"ABCShipping\"},\"counterPartyId\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Legal entity [CustomerUID] exist in the Finzly-CRM system and associated with the payment.\",\"example\":\"10920\"},\"customerType\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"Customer type associated with the payment.\",\"example\":\"Corporate\"},\"businessUnit\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Processing org name assigned to the payment.\",\"example\":\"BankA\"},\"businessUnitId\":{\"maxLength\":11,\"type\":\"string\",\"description\":\"Processing org id assigned to the payment.\",\"example\":\"189\"},\"channel\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The channel name set by the payment origination system such as API, TELLER etc. This is an optional field and defaulted to API if it is not provided. The channel names should be defined in the Finzly system before it can be used in the API.\",\"example\":\"API\"},\"costCenter\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The cost center associated with the payment. A cost center is also known as a cost pool or expense center\",\"example\":\"Global\"},\"book\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"The book associated with the payment. The book is needed to assign proper GL accounts.\",\"example\":\"ACH\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"The payment date when the payment is processed\",\"example\":\"2024-04-26\"},\"senderAmount\":{\"type\":\"number\",\"description\":\"The sender payment amount (paid amount).\",\"example\":100},\"senderCurrency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"Sender currency in ISO Currency Code format.\",\"example\":\"USD\"},\"receiverAmount\":{\"type\":\"number\",\"description\":\"Thereceiver payment amount (received ammount).\",\"example\":100},\"receiverCurrency\":{\"maxLength\":3,\"type\":\"string\",\"description\":\"Receiver currency in ISO Currency Code format.\",\"example\":\"USD\"},\"deliveryMethod\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"One of the payment network delivery methods that includes ACH, FEDWIRE, RTP, FEDNOW, SWIFT\",\"example\":\"ACH\"},\"deliveryDate\":{\"type\":\"string\",\"description\":\"The delivery date when the payment is processed.\",\"example\":\"2024-04-25\"},\"paymentNotes\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Notes associated with the payment.\",\"example\":\"Payment for the invoice ABC123\"},\"deliveryAgentType\":{\"type\":\"string\",\"description\":\"Debit account type. The possible values are Deposit, GL, MCA.\",\"example\":\"DepositA\"},\"wireType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Wire type associated with the payment request.\",\"example\":\"OUTGOING_PAYMENT\"},\"senderName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Sender name associated with the payment. Which is nothing but the legal entity name\",\"example\":\"FinzlyCorp\"},\"senderAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender bank account number associated with the payment.\",\"example\":\"8982618\"},\"senderAccountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Sender bank account name\",\"example\":\"DDA Account\"},\"senderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender address 1\",\"example\":\"1211 My Street\"},\"senderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender address 2\",\"example\":\"Suite 210\"},\"senderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender city\",\"example\":\"Charlotte\"},\"senderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender State\",\"example\":\"North Carolina\"},\"senderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Zip Code\",\"example\":\"28269\"},\"senderCountryCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Country Code\",\"example\":\"US\"},\"senderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"senderAccountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Account Type\",\"example\":\"Deposit\"},\"senderAccountSubType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Account sub type\",\"example\":\"Checking\"},\"senderBankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank ID type such as NID, SWIFT.\",\"example\":\"NID\"},\"senderBankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank ID value per the senderBankIdType\",\"example\":\"101019615\"},\"senderBankName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Sender Bank Name\",\"example\":\"LEAD BANK\"},\"senderBankAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Address 1\",\"example\":\"1801 MAIN ST\"},\"senderBankAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Address 2\"},\"senderBankCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank City\",\"example\":\"Charlotte\"},\"senderBankState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank State\",\"example\":\"North Carolina\"},\"senderBankZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Zip/Postal code\",\"example\":\"28269\"},\"senderBankCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"senderAccountUID\":{\"type\":\"string\",\"description\":\"Sender account unique id\",\"example\":\"464564564\"},\"senderEmail\":{\"type\":\"string\",\"description\":\"Sender email id\",\"example\":\"test@gmail.com\"},\"intermediarySender\":{\"type\":\"boolean\",\"description\":\"Is intermediary sender\",\"example\":false},\"intermediarySenderName\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Name\",\"example\":\"Bank Of America\"},\"intermediarySenderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Address 1\",\"example\":\"1801 MAIN ST\"},\"intermediarySenderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Address 2\"},\"intermediarySenderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank City\",\"example\":\"KANSAS CITY\"},\"intermediarySenderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank State\",\"example\":\"MO\"},\"intermediarySenderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Zip/Postal code\",\"example\":\"64108\"},\"intermediarySenderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"intermediarySenderId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank ID\",\"example\":\"101019615\"},\"intermediarySenderIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Sender Intermediary Bank ID Type. e.g. NID/SWIFT\",\"example\":\"NID\"},\"ultimateSenderName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Ultimate Sender Name\",\"example\":\"test 112266\"},\"ultimateSenderAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Account Number\",\"example\":\"9901020301\"},\"ultimateSenderAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Address 1\",\"example\":\"119 N. MAIN ST\"},\"ultimateSenderAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Address 2\",\"example\":\"119 N. MAIN ST\"},\"ultimateSenderTaxId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender ACH Company ID\",\"example\":\"98989898\"},\"ultimateSenderCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender City\",\"example\":\"Charlotte\"},\"ultimateSenderState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender State\",\"example\":\"North Carolina\"},\"ultimateSenderZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Zip/Postal code\",\"example\":\"28269\"},\"ultimateSenderCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Sender Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"fboAccountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"FBO account name\"},\"fboAccountNumber\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"FBO account number which is associated with Finzly-CRM\",\"example\":\"85989823\"},\"fboAccountType\":{\"maxLength\":30,\"type\":\"string\",\"description\":\"FBO account type.\",\"example\":\"Deposit\"},\"receiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Receiver name, the receiver information may ot may not be present in the finzly system.\",\"example\":\"Pravin Ramchandra Gurav\"},\"receiverAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account number\",\"example\":\"15115\"},\"receiverAccountType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account type\",\"example\":\"Deposit\"},\"receiverAccountSubType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver account type\",\"example\":\"Saving\"},\"receiverType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Type\"},\"receiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Address 1\",\"example\":\"111 My Street\"},\"receiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Address 2\",\"example\":\"111 My Street\"},\"receiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver City\",\"example\":\"Charlotte\"},\"receiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver State\",\"example\":\"North Carolina\"},\"receiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Zip/Postal Code\",\"example\":\"28269\"},\"receiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Country\",\"example\":\"UNITED STATES OF AMERICA\"},\"receiverPhoneNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Phone number\",\"example\":\"9896565998\"},\"receiverEmail\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Email\",\"example\":\"xyz@gmail.com\"},\"receiverBankIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank ID Type such as NID, SWIFT\",\"example\":\"NID\"},\"receiverBankId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank ID value\",\"example\":\"071212128\"},\"receiverBankName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Receiver Bank Name\",\"example\":\"ABC Bank\"},\"receiverBankAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Address 1\",\"example\":\"11 My Street\"},\"receiverBankAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Address 2\",\"example\":\"11 My Street\"},\"receiverBankCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank City\",\"example\":\"Charlotte\"},\"receiverBankState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank State\",\"example\":\"North Carolina\"},\"receiverBankZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Zip/Postal Code\",\"example\":\"28269\"},\"receiverBankCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"intermediaryReceiver\":{\"type\":\"boolean\",\"description\":\"Is intermediary receiver\",\"example\":false},\"intermediaryReceiverIdType\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank ID Type\",\"example\":\"NID\"},\"intermediaryReceiverId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank ID value\",\"example\":\"071212128\"},\"intermediaryReceiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Name\",\"example\":\"ABC Bank\"},\"intermediaryReceiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Address 1\",\"example\":\"111 My Street\"},\"intermediaryReceiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Address 2\",\"example\":\"Suite 210\"},\"intermediaryReceiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank City\",\"example\":\"Charlotte\"},\"intermediaryReceiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank State\",\"example\":\"North Carolina\"},\"intermediaryReceiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Zip/Postal Code\",\"example\":\"28269\"},\"intermediaryReceiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Intermediary Receiver Bank Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"ultimateReceiverName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Ultimate Receiver Name\",\"example\":\"ABC\"},\"ultimateReceiverAccountNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Account Number\",\"example\":\"343532\"},\"ultimateReceiverAddress1\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Address 1\",\"example\":\"11 My Street\"},\"ultimateReceiverAddress2\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Address 2\",\"example\":\"11 My Street\"},\"ultimateReceiverTaxId\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver ACH Company ID which is associated with the finzly-CRM.\",\"example\":\"238956\"},\"ultimateReceiverCity\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Receiver Ultimate City\",\"example\":\"Charlotte\"},\"ultimateReceiverState\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver State\",\"example\":\"North Carolina\"},\"ultimateReceiverZip\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Zip/Postal Code\",\"example\":\"238956\"},\"ultimateReceiverCountry\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Ultimate Receiver Country Name\",\"example\":\"UNITED STATES OF AMERICA\"},\"quoteId\":{\"maxLength\":200,\"type\":\"string\",\"description\":\"FX quote associated with the SWIFT payment.\",\"example\":\"9f75ad52-7c2a-4b95-bb83-74d5e2b61b69\"},\"forexContract\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"FX Contract Number\",\"example\":\"1325\"},\"entryType\":{\"type\":\"string\",\"description\":\"Entry type will be CREDIT or DEBIT.\",\"example\":\"CREDIT\"},\"memoPostStatus\":{\"type\":\"string\",\"description\":\"Status of the memo posting process for the payment\",\"example\":\"FAILURE\"},\"memoPostFailureReason\":{\"type\":\"string\",\"description\":\"Reason for memo posting failure.\",\"example\":\"Insufficient balance $1,000.00 for account number 112266.\"},\"cancellationOriginationSource\":{\"type\":\"string\",\"description\":\"Indicates the source system from which the payment cancellation was initiated.\",\"example\":\"BANKOS\"},\"cancellationReason\":{\"type\":\"string\",\"description\":\"Specifies the reason provided for cancelling the payment.\",\"example\":\"Insufficient Amount\"},\"fee\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Fee\"}},\"recurrence\":{\"$ref\":\"#/components/schemas/RecurrenceData\"},\"fedWireDetails\":{\"$ref\":\"#/components/schemas/fedWireDetails\"},\"benefitReceiver\":{\"$ref\":\"#/components/schemas/BenefitReceiverReasponse\"},\"status\":{\"type\":\"string\",\"example\":\"FUTURE_DATED\"},\"createdBy\":{\"type\":\"string\",\"description\":\"Payment Created By\",\"example\":\"System\"},\"creationDateTime\":{\"type\":\"string\",\"description\":\"Payment Creation Date Time\",\"example\":\"2023-06-23T14:56:59\"}}},\"BenefitReceiverReasponse\":{\"type\":\"object\",\"properties\":{\"federalBenefitType\":{\"type\":\"string\",\"description\":\"Specifies the type of federal benefit the individual is receiving.\",\"example\":\"Social Security\",\"enum\":[\"Social Security\",\"Supplemental Social Security\",\"Veterans Compensation and Pension\",\"Veterans Education MBIB\",\"Veterans Education And Selected Reserve\",\"Veterans Life Insurance\",\"Veterans Vocational Rehabilitation and Employment Benefits\",\"Civil Service Retirement And Annuity\",\"Civil Service Survivor And Annuity\",\"Railroad Retirement Annuity\",\"Railroad Unemployment And Sickness\",\"Dependents Education Assistance Program\",\"Reserve Education Assistance Program\",\"Post 911 GI Bill\"]},\"accountNumber\":{\"maxLength\":17,\"type\":\"string\",\"description\":\"The bank account number where the benefit payment will be deposited. This should be a valid account number with the financial institution.\",\"example\":\"10000002\"},\"socialSecurityNumber\":{\"maxLength\":9,\"minLength\":9,\"type\":\"string\",\"description\":\"The Social Security Number (SSN) of the benefit recipient. This is used to identify the individual within federal benefit systems.\",\"example\":\"555500559\"},\"representativePayee\":{\"type\":\"boolean\",\"description\":\"Indicates whether a representative payee is assigned to manage the recipient's benefits. If this field is not provided, it defaults to false.\",\"example\":false},\"firstName\":{\"maxLength\":7,\"type\":\"string\",\"description\":\"The legal first name of the benefit recipient as registered with the federal agency.\",\"example\":\"John\"},\"lastName\":{\"maxLength\":15,\"type\":\"string\",\"description\":\"The legal last name (surname) of the benefit recipient.\",\"example\":\"Doe\"},\"subAccountType\":{\"type\":\"string\",\"description\":\"Specifies the subtype of the recipient's bank account.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\"]}},\"description\":\"Contains detailed information about the individual receiving federal benefits.\"},\"RecurringPaymentRequest\":{\"type\":\"object\",\"properties\":{\"endDate\":{\"type\":\"string\",\"description\":\"Recurring End Date date in MM-dd-yyyy format. End Date should not be less than the current date.The \\\"Pay Until\\\" field should correspond to \\\"EndDate\\\" when updating the noOfPayments.\",\"example\":\"05-08-2024\"},\"numberOfPayments\":{\"type\":\"number\",\"description\":\"The number of payment should be at least 1. The \\\"Pay Until\\\" field should correspond to \\\"numberOfPayments\\\" when updating the numberOfPayments.\",\"example\":10},\"frequency\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Frequency associated with the payment recurrence. The valid values are Daily, Weekly, BiWeekly, Monthly, Quarterly, SemiAnnually, Yearly.\",\"example\":\"Daily\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount. The payment amount are validated as per the limit set by the payment rails or by the bank for the customer. For the Fedwire payment this will be mapped to {2000} tag.The payment rail limit per transaction are RTP upto 1M$, FedNow upto $500K, Fedwire upto $9,999,999,999.99, Same Day ACH upto 1M$.\",\"format\":\"double\",\"example\":175},\"nextPaymentDate\":{\"type\":\"string\",\"description\":\"Format: String with valid format as: MM-DD-YYYY.\\nRequired ONLY when updating frequency; otherwise, it is ignored.\\n\",\"example\":\"05-08-2024\"}}},\"RecurringPaymentResponse\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\"},\"default\":[]}}},\"RecurringPaymentFailureResponse\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code for identifying the issue.\"}}}}}},\"CreditPaymentInstruction\":{\"required\":[\"externalReferenceId\",\"paymentAmount\",\"paymentCurrency\",\"sender\",\"speed\"],\"properties\":{\"externalReferenceId\":{\"maxLength\":50,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"**externalReferenceId** is a reference ID assigned by the originator system\\nfor tracking and reconciliation.\\n\\nThis value is not required to be unique and may be reused across multiple\\ncredit and debit payment requests. The API does not enforce uniqueness.\\n\\n**externalReferenceId** does not provide idempotency. Clients must use the\\n`Idempotent-Key` request header to prevent duplicate processing.\\n\",\"example\":\"123e4567-e89b-12d3-a456-4266141740\"},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount. The payment amount is validated as per the limits set by the payment rails or by the bank for the customer.\\nFor the Fedwire payment, this will be mapped to the {2000} tag.\\n\\n❗ **Zero (`0`) is only allowed for ENR (Automated Enrollment Entry) payments.**\\nFor all other payment types, the amount must be **greater than zero**.\\n\\n  - The drawdown feature is currently not supported via OpenAPI. Therefore, when using FX Trade-based payments,\\nthe `paymentAmount` must exactly match the FX Trade amount.\\n\\nPayment rail limits per transaction:\\n  - RTP: up to $1,000,000\\n  - FedNow: up to $500,000\\n  - Fedwire: up to $9,999,999,999.99\\n  - Same Day ACH: up to $1,000,000\\n\",\"format\":\"double\",\"example\":175},\"paymentCurrency\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Payment currency code as per ISO 4217 (e.g., USD, EUR). The currency must exist in the system.\\n\\n- For international payments, non-USD payment currency must match the receiver currency.\\n- Payment currency must match either sender or receiver currency.\\n- For FX trades, payment currency must match the trade currency.\\n\",\"example\":\"USD\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"Format: String with valid format as: MM-DD-YYYY\\n\\nThis is an optional field and signifies the date on which the Finzly system will settle the payment. If the paymentDate is not provided by the API user BankOS will derive it for the earliest available settlement date (not prior to the current business date), based on the configuration.\\n\\nACH Payments are typically settled two days after the current date.\\n\\n*SWIFT systems do not allow users to initiate payments on holidays or weekends.*\\n\\nPayment requests via API can be submitted using the following example guidelines:\\n\\n**Examples:**\\n\\n1. For Payment speed = Express (Wires), if the payment is submitted/created today* before cut-off, it will be sent to beneficiary today itself.\\n2. For Payment speed = Instant (FedNow, RTP), if the payment is submitted/created today before, it will be sent to beneficiary today itself.\\n3. For Payment speed = Economy Plus, if the payment is submitted/created today before cut-off, it will be sent to beneficiary today itself.\\n4. For Payment speed = Economy and if submitted/created for today before cut-off time, then the transaction shall have effective entry date of two days or one day after submission (T+2 or T+1) depending on your bank’s configuration. For Payment speed = Economy and if submitted on (12th Aug) for delivery date (on 16th Aug) before cut-off time, then the transaction shall be sent to beneficiary on 14th Aug assuming the configuration is two days prior to paymentDate.\\n\\n* today being business day\\n\",\"example\":\"05-08-2024\"},\"speed\":{\"maxLength\":20,\"pattern\":\"^[a-zA-Z]+( [a-zA-Z]+)*$\",\"type\":\"string\",\"description\":\"Specifies the delivery speed of the payment, which determines how quickly the funds will be delivered and the associated fee.\\nValid values are predefined and mapped to specific payment rails, as configured by the bank or financial institution.\\n\\n**Supported Speed Names and Rails (default configuration in FinzlyOS):**\\n- Economy: ACH (Regular)\\n- Economy Plus: ACH (Same Day)\\n- Express: Fedwire\\n- Instant: FedNow or RTP\\n- ON, TN, SPOT: SWIFT\\n\\n**Validation Rules:**\\n- If the provided speed value is not recognized or not configured for the given currency/payment type, the payment cannot proceed.\\n- If the speed value is missing, invalid, or not supported for the contact or currency pair, payment initiation will fail.\\n\",\"example\":\"Economy\"},\"paymentNotes\":{\"maxLength\":215,\"minLength\":1,\"type\":\"string\",\"description\":\"Notes added by the payment originator. These notes will be truncated to the maximum allowed length and passed to the payment network according to rail-specific limits :\\n\\n- ACH: up to 10 characters\\n- Fedwire: up to 140 characters (Tag 6400 - Beneficiary Info)\\n- SWIFT: up to 140 characters (Tag 70)\\n- RTP/FedNow: up to 140 characters (ISO 20022 - RmtInf tag)\\n\\n`paymentNotes` is required for **ACH** and **SWIFT** payments.\\n\",\"example\":\"Notes\"},\"sender\":{\"type\":\"object\",\"description\":\"Payment sender and account details from which the money will be deducted.\",\"anyOf\":[{\"title\":\"Sender not in CRM\",\"required\":[\"accountNumber\",\"accountType\",\"address\",\"bankId\",\"bankIdType\",\"entityType\",\"name\"],\"properties\":{\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Sender's account number for debiting funds. Must be alphanumeric and exist in the system. GL account must be valid if provided.\\n\",\"example\":\"123452334\"},\"accountType\":{\"maxLength\":35,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies the type of the account associated with the transaction.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"pattern\":\"^[a-zA-Z]+( [a-zA-Z]+)*$\",\"type\":\"string\",\"description\":\"This is an optional field, it is **required** for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Sender name associated with the payment.\\n\\n- For the speed associated with the fedwire payment rail, this will be mapped to {5000} tag.\\n\",\"example\":\"Sender Name\"},\"phone\":{\"maxLength\":10,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Phone number associated with the sender. This is an optional field.\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"pattern\":\"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$\",\"type\":\"string\",\"description\":\"Email associated with the sender. This is an optional field.\",\"example\":\"email@domain.com\"},\"entityType\":{\"type\":\"string\",\"description\":\"Specifies the type of the sender entity involved in the transaction. Processing Org only applicable for GL accounts.\",\"example\":\"Consumer\",\"enum\":[\"Consumer\",\"Corporate\",\"Processing Org\"]},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 1. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -**\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -**\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"City Name. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -** \",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"State name. This field is **mandatory** for ACH, RTP, and FEDNOW payments. This field is **optional** for Domestic Wire and International Wire payments. Must be a string of up to 35 characters and may contain letters, numbers, and the following special characters: . ( ) / ' + = : ? _ # @ % , & -\\n\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"number\",\"description\":\"Country specific postal/zip code. Must be a numeric value up to 35 characters.\",\"example\":28269},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed. \",\"example\":\"US.\"}},\"description\":\"\\\"Address fields are conditionally required based on the payment rail. If any address field is provided, all mandatory fields must be included.\\\"\\n- Swift & Fedwire: addressLine1, city, countryCode\\n- ACH & Instant: addressLine1, city, state, postalCode, countryCode\\n\",\"anyOf\":[{\"title\":\"Swift/Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant\",\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"]}]},\"bankIdType\":{\"maxLength\":10,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies the type of bank identifier used to reference the sender’s bank details.\\n\\nYou must provide one of the following values:\\n- **NID**: A 9-digit ABA/routing number used to identify financial institutions within the United States.\\n- **BIC** (also known as SWIFT code): A standard 8 to 11-character alphanumeric code used to identify banks globally.\\n\\nEnsure the selected value is valid for the country involved in the transaction, as certain bank ID types may not be supported in all countries.\\n\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"bankId\":{\"maxLength\":35,\"pattern\":\"^[a-zA-Z0-9]+$\",\"type\":\"string\",\"description\":\"This field represents the sender's bank identifier, which can be either a NID (ABA/Routing number) or a SWIFT code, depending on the bankIdType.\\n\\n- For NID (ABA/Routing number), the value must be exactly 9 digits and cannot consist entirely of zeros.\\n- For SWIFT codes, the value must be between 8 and 11 characters.\\n- The bank ID must be valid and pre-configured in the CRM system. If it does not exist, the system will reject it.\\n- For payments using the Fedwire rail, this bankId is mapped to the {3100} tag in the payment message format.\\n\",\"example\":\"101206101\"},\"correspondentBankId\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"This is an optional field used to specify the 9-digit routing number for the receiver's correspondent bank.\\n\\nIt is primarily applicable for **international Fedwire payments**, where the receiver bank's country is outside the United States.\\n\\nIf this field is left blank for an international Fedwire payment, the Finzly system will automatically retrieve the correspondent bank details from its internal configuration, based on the receiver’s country and currency setup.\\n\",\"example\":\"026009593\"},\"achCompanyID\":{\"maxLength\":10,\"pattern\":\"^[a-zA-Z0-9]+$\",\"type\":\"string\",\"description\":\"ACH origination/company id is a 10-digit identifier used for ACH payment processing, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”). **This is an optional field, it is required only when payment speed associated with the ACH payment rail.**\",\"example\":\"122334789\"}},\"description\":\"Use this option when the sender is not registered in the Finzly's CRM system.\"},{\"title\":\"Sender in CRM\",\"required\":[\"accountUID\"],\"properties\":{\"accountUID\":{\"pattern\":\"^[0-9]+$\",\"type\":\"number\",\"description\":\"The sender's bank account unique identifier exists in the Finzly-CRM system. \",\"example\":64564}},\"description\":\"Use this option when the sender is already registered in the Finzly's CRM system.\"}]},\"ultimateSender\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate sender. Required when any `address` field is supplied.\",\"example\":\"ACME Holdings Inc.\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate sender. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"9901020301\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate sender address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"119 N. MAIN ST\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate sender city. Required when `name` is provided on `ultimateSender`.\",\"example\":\"FAYETTE\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate sender state/region.\",\"example\":\"MO\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"65248\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateSender`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate sender.\\n\\nConditional rules:\\n  If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that ultimately originated the funds being moved, when different from `sender`. Used to convey an ultimate originator for third-party-originated payments (for example, a corporate sending on behalf of its end customer).\\n\\nThis object is entirely optional. When omitted, the server treats the payment as not having a distinct ultimate sender. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"receiver\":{\"type\":\"object\",\"description\":\"Contains the payment receiver’s personal and account details, where the funds will be deposited.\\n\\nThis field is **required for all payment types except ENR payment (Automated Enrollment Entry)**.\\n\",\"anyOf\":[{\"title\":\"Beneficiary not in CRM\",\"required\":[\"accountCurrency\",\"accountNumber\",\"bank\",\"name\"],\"properties\":{\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Receiver bank account number to which money will be deposited. This is the country specific bank account number such as ABA for USA, CLABE for Mexico,IBAN mainly for european countries  etc. This is required if beneficiaryId is not provided.\",\"example\":\"123422434\"},\"accountType\":{\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is **required** for the speed associated with the ACH payment rails.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"pattern\":\"^[a-zA-Z]+( [a-zA-Z]+)*$\",\"type\":\"string\",\"description\":\"This is an optional field, it is **required** for the speed associated with the ACH payment rails (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountCurrency\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Receiver’s account currency in ISO 4217 format (e.g., USD, EUR). Must exist in the system.\\n\\n- For international payments, currency must be non-USD (USD not supported yet).\\n- Currency must be valid and configured in the system.\\n\",\"example\":\"USD\"},\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Receiver name associated with the payment. This is an optional field, For the speed associated with the fedwire payment rail, this will be mapped to {4200} tag.\",\"example\":\"Receiver name\"},\"phone\":{\"maxLength\":10,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Optional phone number of the receiver. Must be numeric and up to 10 digits.\",\"example\":\"18001236754\"},\"email\":{\"maxLength\":100,\"pattern\":\"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$\",\"type\":\"string\",\"description\":\"Optional email address of the receiver. Must be a valid format (e.g., user@example.com).\\nUsed for communication or notification purposes, if supported by the payment rail.\\n\",\"example\":\"email@domain.com\"},\"swiftTag\":{\"maxLength\":5,\"type\":\"string\",\"description\":\"**Deprecated.** Swift tag for the beneficiary customer.\\nPreviously required for CTP Fedwire payments when the local instrument was set to `COVS`.\\n\",\"deprecated\":true},\"swiftNote\":{\"maxLength\":250,\"type\":\"string\",\"description\":\"**Deprecated.** Swift note for the beneficiary customer.\\nPreviously required for CTP Fedwire payments when the local instrument was set to `COVS`.\\n\",\"deprecated\":true},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 1. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -**.*Required for Fedwire payments.*\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -**\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"City Name. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -**. *Required for Fedwire payments.* \",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"State Name. This is an optional field needed for the domestic payment. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. ( ) / ' + = : ? _ # @ % , & -** \",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"number\",\"description\":\"Country specific postal/zip code. This is an optional field needed for the domestic payment.\",\"example\":28269},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed. *Required for Fedwire payments.* \",\"example\":\"US\"}},\"description\":\"\\\"The address pertains to the receiver or debtor. This field is required for fedwire payments and optional for other payment rails.\\\"\\n\",\"anyOf\":[{\"title\":\"Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant/Swift\"}]},\"bank\":{\"required\":[\"bankIdType\"],\"type\":\"object\",\"properties\":{\"bankIdType\":{\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies the type of identifier used to locate the receiver's bank.\\n\\n- `NID`: Used for country-specific identifiers such as ABA (USA), IBAN (Europe), CLABE (Mexico), etc. Supported only for receivers in the US.\\n- `SWIFT`: Used for international money transfers.\\n\\nThe selected value must be valid for the receiver's country. Unsupported combinations will be rejected.\\n\",\"example\":\"NID\",\"enum\":[\"NID\",\"SWIFT\"]},\"bankId\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Receiver's bank identifier. **Required** when `bankIdType` is `NID`.\\n\\n- Must be exactly 9 digits and cannot be all zeros.\\n- Must exist in the system and be valid for the selected payment speed (e.g., RTP).\\n\",\"example\":\"072000326\"},\"accountType\":{\"type\":\"string\",\"description\":\"An optional field that indicates the type of creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"IBAN\",\"enum\":[\"IBAN\",\"Others\"]},\"accountNumber\":{\"maxLength\":34,\"type\":\"string\",\"description\":\"A conditionally mandatory field. When an account type is specified, this field must be provided. Represents the creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"DE89370400440532013000\"},\"swiftCode\":{\"maxLength\":11,\"pattern\":\"^[a-zA-Z0-9]+$\",\"type\":\"string\",\"description\":\"Receiver's SWIFT/BIC code. **Required** when `bankIdType` is `SWIFT`.\\n\\n- Must be 8 and 11 alphanumeric characters.\\n- Cannot consist entirely of zeros.\\n- Must be a valid and registered SWIFT code in the system.\\n\",\"example\":\"CHASUS33XXX\"},\"name\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} .,&@%#/'\\\"*!~=^_{}\\\\[\\\\];$|()+?:-]+$\",\"type\":\"string\",\"description\":\"Name of the receiver bank. This field is conditionally mandatory. It must be provided when any receiver bank address details are present. For domestic [NID] and international [SWIFT] codes, if not provided and no address details are given, the Finzly system assigns the name based on directory lookup.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country code of the receiver, following ISO 3166 format (e.g., US, GB, IN).\\n\\n- This field is optional only when the\\n  country code is already provided as part of the receiver bank address.\\n  If the receiver bank address does not include a country code, this field\\n  becomes mandatory.\\n\\n- If both are provided, the values must match.\\n- Must be valid and configured in the system.\\n\",\"example\":\"US\"},\"address\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"],\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 1. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. , ' & @ % # / -** \",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. , ' & @ % # / -** \",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"City Name. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. , ' & @ % # / -** \",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"State Name. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: **. , ' & @ % # / -** \",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country code per ISO 3166. Must match the top-level countryCode field in the bank object. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed.\",\"example\":\"US\"}},\"description\":\"The bank address information is required for banks located outside the United States. If any of the address fields are provided, it is mandatory to include addressLine1, city, state, postalCode, and countryCode.\"}},\"description\":\"The bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\",\"oneOf\":[{\"title\":\"Bank Identifier: NID\",\"required\":[\"bankId\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"NID\"]}},\"description\":\"Requires 'bankId' when bankIdType is 'NID'.\"},{\"title\":\"Bank Identifier: SWIFT\",\"required\":[\"swiftCode\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"SWIFT\"]}},\"description\":\"Requires 'swiftCode' when bankIdType is 'SWIFT'.\"}]},\"intermediaryBank\":{\"required\":[\"bankIdType\"],\"type\":\"object\",\"properties\":{\"bankIdType\":{\"maxLength\":35,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"The bank unique identifier type. Use SWIFT for the international money transfer. Use NID to identify the country specific bank id such as IBAN mainly for european countries, CLABE for Mexico, ABA for USA  etc.\",\"example\":\"NID\",\"enum\":[\"NID\",\"SWIFT\"]},\"bankId\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Specifies the bank identifier used when the `bankIdType` is set to **NID** (ABA/Routing number).\\n\\n- Must be a 9-digit numeric value.\\n- This field is **required** only when `bankIdType` is **NID**.\\n- The value must reference a bank that is already registered and pre-configured in the system.\\n\\nIf the provided bank ID does not exist in the system, or if it represents an invalid intermediary bank,\\nthe transaction will not be processed.\\n\",\"example\":\"072000326\"},\"swiftCode\":{\"maxLength\":11,\"pattern\":\"^[a-zA-Z0-9]+$\",\"type\":\"string\",\"description\":\"Specifies the SWIFT code (also known as BIC) of the beneficiary’s intermediary bank.\\n\\n- Required only when `bankIdType` is set to **SWIFT**.\\n- Must be an alphanumeric value without special characters or spaces.\\n- A SWIFT code typically consists of **8 to 11 characters** and uniquely identifies banks worldwide.\\n\\nEnsure the provided SWIFT code is valid and already configured in the system.\\nIf the code does not exist, the system will not be able to route the payment and the transaction will not be processed.\\n\",\"example\":\"CHASUS33XXX\"},\"name\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} .,&@%#/'\\\"*!~=^_{}\\\\[\\\\];$|()+?:-]+$\",\"type\":\"string\",\"description\":\"Name of the bank. This is an optional for domestic [NID] and international [SWIFT] code. If not provided Finzly system will assign the name as per the directory lookup.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country code as defined by the **ISO 3166** standard.\\n\\n- Must consist of exactly two alphabetic characters (e.g., `US`, `GB`, `IN`).\\n- If the `address` object is provided, this value must exactly match `address.countryCode`.\\n- This field is **optional** if `address.countryCode` is already provided; otherwise, it is **required**.\\n\",\"example\":\"US\"},\"address\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"],\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 1. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: ** . ( ) / ' + = : ? _ # @ % , & - ** \",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Bank address line 2. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: ** . ( ) / ' + = : ? _ # @ % , & - ** \",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"City Name. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: ** . ( ) / ' + = : ? _ # @ % , & - ** \",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"State Name. This is an optional field. Must be a string of up to 35 characters, containing only letters, numbers, and the following special characters: ** . ( ) / ' + = : ? _ # @ % , & - ** \",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country specific postal/zip code. This is an optional field.\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed. \",\"example\":\"US\"}},\"description\":\"The bank address information is required for banks located outside the United States. If any of the address fields are provided, it is mandatory to include addressLine1, city, state, postalCode, and countryCode.\"}},\"description\":\"The bank or intermediary bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\",\"oneOf\":[{\"title\":\"Bank Identifier: NID\",\"required\":[\"bankId\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"NID\"]}},\"description\":\"Requires 'bankId' when bankIdType is 'NID'.\"},{\"title\":\"Bank Identifier: SWIFT\",\"required\":[\"swiftCode\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"SWIFT\"]}},\"description\":\"Requires 'swiftCode' when bankIdType is 'SWIFT'.\"}]}},\"description\":\"Use this option when the receiver is not registered in the Finzly's CRM system.\"},{\"title\":\"Beneficiary in CRM\",\"required\":[\"beneficiaryId\"],\"properties\":{\"beneficiaryId\":{\"pattern\":\"^[0-9]+$\",\"type\":\"number\",\"description\":\"Unique identifier of the receiver in Finzly CRM system. Optional — if provided, other receiver details are not required.\\n\\n  - Must refer to an active contact, deleted or invalid records will cause an error.\\n  - Either `beneficiaryId` or `accountNumber` must be provided.\\n\",\"example\":209219}},\"description\":\"Use this option when the receiver is already registered in the Finzly's CRM system.\"}]},\"ultimateReceiver\":{\"type\":\"object\",\"properties\":{\"name\":{\"maxLength\":140,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Full legal name of the ultimate receiver. Required when any `address` field is supplied.\",\"example\":\"Globex End Customer LLC\"},\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\\\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Account number of the ultimate receiver. Alphanumeric up to 35 characters; the same punctuation set as `accountNumber` elsewhere in this API is allowed.\",\"example\":\"89895656\"},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate receiver address line 1. Up to 35 characters. Letters, digits, spaces, and the following special characters are allowed: ~ ! @ # $ % & ( ) { } | ^ [ ] / _ - + = ? \\\\ ; : \\\" ' < > . , ` *\",\"example\":\"101 SR\"},\"addressLine2\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver address line 2.\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver address line 3.\",\"example\":\"Building B\"},\"city\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Ultimate receiver city. Required when `name` is provided on `ultimateReceiver`.\",\"example\":\"TAMPA\"},\"state\":{\"maxLength\":35,\"pattern\":\"^[\\\\p{L}\\\\p{N} ~!@#$%&(){}|^\\\\[\\\\]/_\\\\-+=?\\\\\\\\;:\\\"'<>.,`*]+$\",\"type\":\"string\",\"description\":\"Optional ultimate receiver state/region.\",\"example\":\"FL\"},\"postalCode\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9 -]*$\",\"type\":\"string\",\"description\":\"Country-specific postal/ZIP code. Up to 35 alphanumeric characters (spaces and hyphens allowed).\",\"example\":\"33601\"},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"ISO 3166 alpha-2 country code. Required when `name` is provided on `ultimateReceiver`.\",\"example\":\"US\"}},\"description\":\"Address of the ultimate receiver.\\n\\nConditional rules:\\n  If any address field such as `city` or\\n`countryCode` is provided, `name` becomes mandatory. Conversely, if `name`\\nis provided, both `city` and `countryCode` become mandatory.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"}},\"description\":\"Optional. Party that ultimately benefits from the payment, when different from `receiver`. Used to convey an ultimate beneficiary when the immediate beneficiary is an intermediary (for example, a payment processor receiving on behalf of a merchant).\\n\\nThis object is entirely optional. When omitted, the server treats the payment as not having a distinct ultimate receiver. When present, the following conditional rules apply:\\n- If `name` is provided, `address.city` and `address.countryCode` are required.\\n- If any `address` city or countryCode field is provided, `name` is required.\\nRequired when `addressLine1` is provided. If `addressLine1` is specified,\\n`city`, `state`, `postalCode`, and `country` must also be provided.\\n\"},\"fee\":{\"required\":[\"amount\"],\"type\":\"object\",\"properties\":{\"feeName\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Optional name of the fee.\\nDefaults to **\\\"Custom\\\"** if not provided.\\n\",\"example\":\"Custom\"},\"amount\":{\"type\":\"number\",\"description\":\"The amount of the fee to be charged.\\n- The amount must be greater than zero.\\n- Negative values are not allowed.\\n- The maximum allowed fee amount is 10,000,000.\\n\",\"example\":10.88}},\"description\":\"Fee details to be charged for the payment transaction.\\n\\n- This field is **optional**.\\n- Fee currency is fixed to **USD**.\\n\"},\"recurrence\":{\"required\":[\"frequency\",\"payUntil\"],\"type\":\"object\",\"properties\":{\"frequency\":{\"type\":\"string\",\"description\":\"Specifies how often the payment should occur.\",\"example\":\"Daily\",\"enum\":[\"Daily\",\"Weekly\",\"BiWeekly\",\"Monthly\",\"Quarterly\",\"SemiAnnually\",\"Yearly\"]},\"payUntil\":{\"type\":\"string\",\"description\":\"Specifies when the recurring payment should stop.\\n\\nAccepted values:\\n- **Cancelled**: Recurrence continues until manually stopped.\\n- **EndDate**: Recurrence ends on a specified date.\\n- **NumberOfPayments**: Recurrence ends after a specific number of payments.\\n\",\"example\":\"Cancelled\",\"enum\":[\"Cancelled\",\"EndDate\",\"NumberOfPayments\"]},\"endDate\":{\"type\":\"string\",\"description\":\"Specifies the end date for the recurring payment.\\n- Required when `payUntil` is **EndDate**.\\n- Format must be **MM-dd-yyyy**.\\n- The end date must be greater than the initial payment date.\\n\",\"example\":\"01-29-2023\"},\"numberOfPayments\":{\"maximum\":9999,\"type\":\"integer\",\"description\":\"Specifies the number of times the payment should recur.\\n\\n- Required when `payUntil` is **NumberOfPayments**.\\n- Must be between **1** and **9999**.\\n\",\"example\":10}},\"description\":\"Defines the recurrence pattern for the payment.\\nUse this object to configure how frequently the payment should repeat and when it should stop.\\n\\nFields such as `endDate` or `numberOfPayments` are conditionally required depending on the `payUntil` value.\\n\",\"oneOf\":[{\"title\":\"Recurring Until End Date\",\"required\":[\"endDate\"],\"properties\":{\"payUntil\":{\"type\":\"string\",\"enum\":[\"EndDate\"]}},\"description\":\"Requires 'endDate' when 'payUntil' is set to 'EndDate'.\"},{\"title\":\"Recurring for a Number of Payments\",\"required\":[\"numberOfPayments\"],\"properties\":{\"payUntil\":{\"type\":\"string\",\"enum\":[\"NumberOfPayments\"]}},\"description\":\"Requires 'numberOfPayments' when 'payUntil' is set to 'NumberOfPayments'.\"}]},\"additionalInfo\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"channel\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Specifies the name of the channel through which the payment is initiated.\\n\\n- This field is **optional**. If not provided, it defaults to **API**.\\n- Common examples include: `API`, `TELLER`, etc.\\n- The channel name must be pre-defined and registered within the Finzly system before it can be used in an API request.\\n\",\"example\":\"API\"},\"costCenter\":{\"maxLength\":25,\"pattern\":\"^[a-zA-Z0-9 .,'\\\\{\\\\}\\\\[\\\\]\\\\(\\\\)]+$\",\"type\":\"string\",\"description\":\"Optional field used to identify the cost center associated with the payment.\\n\\nA cost center is a department or function within an organization—such as Accounting, Human Resources, or IT—that incurs costs but does not directly contribute to profit.\\n\\nThe provided cost center value must already exist in the system configuration.\\nIf it does not exist, the transaction will be rejected. Please ensure a valid cost center is used.\\n\",\"example\":\"12897\"},\"requestMethod\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"This is an optional field. Customer payment request method from a given channel for e.g. WALK-IN, PHONE-IN etc.\",\"example\":\"WALK-IN\"},\"operationNote\":{\"maxLength\":1000,\"type\":\"string\",\"description\":\"Optional field for entering remarks or internal notes related to the payment operation.\"}}},{\"anyOf\":[{\"title\":\"ACH-specific\",\"required\":[\"secCode\"],\"properties\":{\"secCode\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"SEC code representing how the ACH payment was authorized by the consumer or business.\\n\\n- Optional field, but required for ACH payments, especially when using **Economy** or **Economy Plus** processing speeds.\\n- The SEC code **IAT** is not permitted for **Same Day ACH** payments.\\n\",\"example\":\"CCD\"},\"transactionTypeCode\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Optional 3-letter transaction type code used when the SEC code is set to **IAT**.\\n\\n- Required for international ACH payments using the **Economy** payment type.\\n- Must be a valid code configured in the system.\\n\",\"example\":\"ANN\"},\"paymentRemittanceNotes\":{\"type\":\"string\",\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\\n- Terminator handling for **ACH**:\\n  The system automatically appends a **tilde** (`~`) as the\\n  segment terminator at the end of the value if one is not\\n  already provided.\\n\\n  If you explicitly provide a terminator, the following are\\n  accepted:\\n    - Tilde: `~`\\n    - Backslash: `\\\\`\\n\\n  Example without terminator (system will auto-append `~`):\\n    `Invoice payment for order 12345`\\n\\n  Example with explicit terminator:\\n    `Invoice payment for order 12345~`\\n\\n- **Character limit rules for ACH:**\\n  \\n  - **Rule 1 — With terminator:**        \\n    The maximum allowed length is 80 characters including the terminator.\\n\\n  - **Rule 2 — Without terminator:**\\n    If no terminator is provided, the value must not exceed 79 characters.\\n    The system will auto-append ~, making the final stored length exactly 80 characters.      \\n\"},\"receiverIdentificationNumber\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"This is an optional field. It represents the Receiver’s DFI Identification Number and is applicable when the secCode is set to IAT. The value will be truncated by the system based on the selected payment rail.\",\"example\":\"12334356\"},\"benefitReceiver\":{\"$ref\":\"#/components/schemas/BenefitReceiver\"}},\"description\":\"ACH specific\"},{\"title\":\"Instant-specific\",\"properties\":{\"remittanceMethod\":{\"maxLength\":10,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Optional field used to specify the remittance delivery method.\\n\\n- Applicable only for **RTP (Real-Time Payments)**.\\n- Accepted values:\\n  - **EMAL** – Remittance information will be sent via email.\\n  - **URID** – Remittance information will be linked using a unique reference ID.\\n\",\"example\":\"EMAL\",\"enum\":[\"EMAL\",\"URID\"]},\"paymentRemittanceNotes\":{\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\"},\"localInstruments\":{\"type\":\"string\",\"description\":\"Local instrument code applicable for RTP or FEDNOW payment. For RTP if `ultimateSender` or `ultimateReceiver` is provided then localInstruments must be `INTERMEDIARY`\\n\",\"example\":\"STANDARD\",\"enum\":[\"STANDARD\",\"ZELLE\",\"INTERMEDIARY\",\"FDNA\"]}},\"description\":\"Fields specific to instant payment systems.\"},{\"title\":\"FEDWIRE-specific\",\"properties\":{\"referenceForBeneficiary\":{\"maxLength\":16,\"type\":\"string\",\"description\":\"This field is applicable for Fedwire payments, accepts an alphanumeric string, represents the beneficiary reference details, and is mapped to `EndToEndId` field and this will be mapped to {4320} tag.\",\"example\":\"RefForBeneficiary Details\"},\"detailsOfCharges\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies who is responsible for the payment charges. This optional field applies\\nto both **Fedwire** and **SWIFT** payment speeds with accepted values are:\\n`OUR` (originator pays), `BEN` (beneficiary pays), and `SHA` (shared charges).\\n\",\"example\":\"OUR\"},\"unstructuredAddendaInfo\":{\"type\":\"object\",\"properties\":{\"addendaInformation\":{\"type\":\"string\"}},\"description\":\"Remittance details associated with the Fedwire payment message, used to convey additional unstructured information in the addenda.\"},\"senderToReceiverNotes\":{\"maxLength\":105,\"type\":\"string\",\"description\":\"This is applicable for the fedwire payment specifies additional information for the Receiver. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6500} tag in three lines and each line will have 35 characters.\",\"example\":\"Sender To Reciever Notes\"},\"originatortoBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\",\"deprecated\":true},\"originatorToBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\"},\"proprietaryCode\":{\"maxLength\":35,\"type\":\"string\",\"description\":\"Deprecated field for fedwire payments, previously this is **required** for the fedwire payment where the local instrument set to PROP\",\"deprecated\":true},\"localInstruments\":{\"type\":\"string\",\"description\":\"Deprecated for fedwire CTP payments, Local instrument code applicable for the RTP or FEDNOW payment.\",\"example\":\"COVS\",\"deprecated\":true,\"enum\":[\"COVS\",\"ANSI\",\"GXML\",\"IXML\",\"NARR\",\"S820\",\"SWIF\",\"UEDI\",\"RRMT\",\"PROP\",\"RMTS\"]}},\"description\":\"FEDWIRE specific\"},{\"title\":\"SWIFT-specific\",\"properties\":{\"fxContractNumber\":{\"maxLength\":35,\"pattern\":\"^[0-9]+$\",\"type\":\"string\",\"description\":\"Unique identifier for the FX (foreign exchange) trade, applicable for international payments.\\nThis is used to validate the FX contract against the payment request.\\n\\n- Must be a valid and active FX contract number.\\n- Required for **SWIFT** payments when `paymentDate` is not provided.\\n- The FX contract must exist in the system and match the requesting customer.\\n- The same FX contract number cannot be reused across multiple payments.\\n\",\"example\":\"111234\"},\"detailsOfCharges\":{\"maxLength\":3,\"minLength\":3,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies who is responsible for the payment charges. This optional field applies\\nto both **Fedwire** and **SWIFT** payment speeds with accepted values are:\\n`OUR` (originator pays), `BEN` (beneficiary pays), and `SHA` (shared charges).\\n\",\"example\":\"OUR\"},\"paymentRemittanceNotes\":{\"type\":\"string\",\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\"}},\"description\":\"SWIFT specific\"}]}]}}},\"V5CreditPaymentInstruction\":{\"required\":[\"externalReferenceId\",\"paymentAmount\",\"paymentCurrency\",\"sender\",\"speed\"],\"properties\":{\"externalReferenceId\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"**externalReferenceId** is a reference ID assigned by the originator system\\nfor tracking and reconciliation.\\n\\nThis value is not required to be unique and may be reused across multiple\\ncredit and debit payment requests. The API does not enforce uniqueness.\\n\\n**externalReferenceId** does not provide idempotency. Clients must use the\\n`Idempotent-Key` request header to prevent duplicate processing.\\n\",\"example\":\"123e4567-e89b-12d3-a456-4266141740\"},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Payment amount. The payment amount is validated as per the limits set by the payment rails or by the bank for the customer.\\nFor the Fedwire payment, this will be mapped to the {2000} tag.\\n\\n❗ **Zero (`0`) is only allowed for ENR (Automated Enrollment Entry) payments.**\\nFor all other payment types, the amount must be **greater than zero**.\\n\\n  - The drawdown feature is currently not supported via OpenAPI. Therefore, when using FX Trade-based payments,\\nthe `paymentAmount` must exactly match the FX Trade amount.\\n\\nPayment rail limits per transaction:\\n  - RTP: up to $1,000,000\\n  - FedNow: up to $500,000\\n  - Fedwire: up to $9,999,999,999.99\\n  - Same Day ACH: up to $1,000,000\\n\",\"format\":\"double\",\"example\":175},\"paymentCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Payment currency code as per ISO 4217 (e.g., USD, EUR). The currency must exist in the system.\\n\\n- For international payments, non-USD payment currency must match the receiver currency.\\n- Payment currency must match either sender or receiver currency.\\n- For FX trades, payment currency must match the trade currency.\\n\",\"example\":\"USD\"},\"paymentDate\":{\"type\":\"string\",\"description\":\"Format: String with valid format as: MM-DD-YYYY\\n\\nThis is an optional field and signifies the date on which the Finzly system will settle the payment. If the paymentDate is not provided by the API user BankOS will derive it for the earliest available settlement date (not prior to the current business date), based on the configuration.\\n\\nACH Payments are typically settled two days after the current date.\\n\\n*SWIFT systems do not allow users to initiate payments on holidays or weekends.*\\n\\nPayment requests via API can be submitted using the following example guidelines:\\n\\n**Examples:**\\n\\n1. For Payment speed = Express (Wires), if the payment is submitted/created today* before cut-off, it will be sent to beneficiary today itself.\\n2. For Payment speed = Instant (FedNow, RTP), if the payment is submitted/created today before, it will be sent to beneficiary today itself.\\n3. For Payment speed = Economy Plus, if the payment is submitted/created today before cut-off, it will be sent to beneficiary today itself.\\n4. For Payment speed = Economy and if submitted/created for today before cut-off time, then the transaction shall have effective entry date of two days or one day after submission (T+2 or T+1) depending on your bank’s configuration. For Payment speed = Economy and if submitted on (12th Aug) for delivery date (on 16th Aug) before cut-off time, then the transaction shall be sent to beneficiary on 14th Aug assuming the configuration is two days prior to paymentDate.\\n\\n* today being business day\\n\",\"example\":\"05-08-2024\"},\"speed\":{\"type\":\"string\",\"description\":\"Specifies the delivery speed of the payment, which determines how quickly the funds will be delivered and the associated fee.\\nValid values are predefined and mapped to specific payment rails, as configured by the bank or financial institution.\\n\\n**Supported Speed Names and Rails (default configuration in FinzlyOS):**\\n- Economy: ACH (Regular)\\n- Economy Plus: ACH (Same Day)\\n- Express: Fedwire\\n- Instant: FedNow or RTP\\n- ON, TN, SPOT: SWIFT\\n\\n**Validation Rules:**\\n- If the provided speed value is not recognized or not configured for the given currency/payment type, the payment cannot proceed.\\n- If the speed value is missing, invalid, or not supported for the contact or currency pair, payment initiation will fail.\\n\",\"example\":\"Economy\"},\"paymentNotes\":{\"type\":\"string\",\"description\":\"Notes added by the payment originator. These notes will be truncated to the maximum allowed length and passed to the payment network according to rail-specific limits :\\n\\n- ACH: up to 10 characters\\n- Fedwire: up to 140 characters (Tag 6400 - Beneficiary Info)\\n- SWIFT: up to 140 characters (Tag 70)\\n- RTP/FedNow: up to 140 characters (ISO 20022 - RmtInf tag)\\n\\n`paymentNotes` is required for **ACH** and **SWIFT** payments.\\n\",\"example\":\"Notes\"},\"sender\":{\"type\":\"object\",\"description\":\"Payment sender and account details from which the money will be deducted.\",\"anyOf\":[{\"title\":\"Sender not in CRM\",\"required\":[\"accountNumber\",\"accountType\",\"bankId\",\"bankIdType\",\"entityType\",\"name\"],\"properties\":{\"accountNumber\":{\"type\":\"string\",\"description\":\"Sender's account number for debiting funds. Must be alphanumeric and exist in the system. GL account must be valid if provided.\\n\",\"example\":\"123452334\"},\"accountType\":{\"type\":\"string\",\"description\":\"Specifies the type of the account associated with the transaction.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is **required** for the speed associated with the ACH payment rail (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"name\":{\"type\":\"string\",\"description\":\"Sender name associated with the payment.\\n\\n- For the speed associated with the fedwire payment rail, this will be mapped to {5000} tag.\\n\",\"example\":\"Sender Name\"},\"phone\":{\"type\":\"string\",\"description\":\"Phone number associated with the sender. This is an optional field.\",\"example\":\"18001236754\"},\"email\":{\"type\":\"string\",\"description\":\"Email associated with the sender. This is an optional field.\",\"example\":\"email@domain.com\"},\"entityType\":{\"type\":\"string\",\"description\":\"Specifies the type of the sender entity involved in the transaction. Processing Org only applicable for GL accounts.\",\"example\":\"Consumer\",\"enum\":[\"Consumer\",\"Corporate\",\"Processing Org\"]},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"type\":\"string\",\"description\":\"Bank address line 1.\",\"example\":\"111 My Street\"},\"addressLine2\":{\"type\":\"string\",\"description\":\"Bank address line 2.\",\"example\":\"Suite 210\"},\"city\":{\"type\":\"string\",\"description\":\"City Name.\",\"example\":\"Charlotte\"},\"state\":{\"type\":\"string\",\"description\":\"State Name.\",\"example\":\"North Carolina\"},\"postalCode\":{\"type\":\"number\",\"description\":\"Country specific postal/zip code. \",\"example\":28269},\"countryCode\":{\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed. \",\"example\":\"US.\"}},\"description\":\"\\\"The address pertains to the sender or debtor. *If any of the address fields are provided, Required fields depend on the payment rail:*\\\"\\n- Swift & Fedwire: addressLine1, city, countryCode\\n- ACH & Instant: addressLine1, city, state, postalCode, countryCode\\n\",\"anyOf\":[{\"title\":\"Swift/Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant\",\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"]}]},\"bankIdType\":{\"type\":\"string\",\"description\":\"Specifies the type of bank identifier used to reference the sender’s bank details.\\n\\nYou must provide one of the following values:\\n- **NID**: A 9-digit ABA/routing number used to identify financial institutions within the United States.\\n- **BIC** (also known as SWIFT code): A standard 8 to 11-character alphanumeric code used to identify banks globally.\\n\\nEnsure the selected value is valid for the country involved in the transaction, as certain bank ID types may not be supported in all countries.\\n\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"bankId\":{\"type\":\"string\",\"description\":\"This field represents the sender's bank identifier, which can be either a NID (ABA/Routing number) or a SWIFT code, depending on the bankIdType.\\n\\n- For NID (ABA/Routing number), the value must be exactly 9 digits and cannot consist entirely of zeros.\\n- For SWIFT codes, the value must be between 8 and 11 characters.\\n- The bank ID must be valid and pre-configured in the CRM system. If it does not exist, the system will reject it.\\n- For payments using the Fedwire rail, this bankId is mapped to the {3100} tag in the payment message format.\\n\",\"example\":\"101206101\"},\"correspondentBankId\":{\"type\":\"string\",\"description\":\"This is an optional field used to specify the 9-digit routing number for the receiver's correspondent bank.\\n\\nIt is primarily applicable for **international Fedwire payments**, where the receiver bank's country is outside the United States.\\n\\nIf this field is left blank for an international Fedwire payment, the Finzly system will automatically retrieve the correspondent bank details from its internal configuration, based on the receiver’s country and currency setup.\\n\",\"example\":\"026009593\"},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH origination/company id is a 10-digit identifier used for ACH payment processing, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”). **This is an optional field, it is required only when payment speed associated with the ACH payment rail.**\",\"example\":\"122334789\"}},\"description\":\"Use this option when the sender is not registered in the Finzly's CRM system.\"},{\"title\":\"Sender in CRM\",\"required\":[\"accountUID\"],\"properties\":{\"accountUID\":{\"type\":\"number\",\"description\":\"The sender's bank account unique identifier exists in the Finzly-CRM system. \",\"example\":64564}},\"description\":\"Use this option when the sender is already registered in the Finzly's CRM system.\"}]},\"receiver\":{\"type\":\"object\",\"description\":\"Contains the payment receiver’s personal and account details, where the funds will be deposited.\\n\\nThis field is **required for all payment types except ENR payment (Automated Enrollment Entry)**.\\n\",\"anyOf\":[{\"title\":\"Beneficiary not in CRM\",\"required\":[\"accountCurrency\",\"accountNumber\",\"bank\",\"name\"],\"properties\":{\"accountNumber\":{\"type\":\"string\",\"description\":\"Receiver bank account number to which money will be deposited. This is the country specific bank account number such as ABA for USA, CLABE for Mexico,IBAN mainly for european countries  etc. This is required if beneficiaryId is not provided.\",\"example\":\"123422434\"},\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account. This is an optional field, it is **required** for the speed associated with the ACH payment rails.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"subAccountType\":{\"type\":\"string\",\"description\":\"This is an optional field, it is **required** for the speed associated with the ACH payment rails (This helps to identify the ACH tran code). If the accountType is GL then subAccountType should be GL also.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"accountCurrency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Receiver’s account currency in ISO 4217 format (e.g., USD, EUR). Must exist in the system.\\n\\n- For international payments, currency must be non-USD (USD not supported yet).\\n- Currency must be valid and configured in the system.\\n\",\"example\":\"USD\"},\"name\":{\"type\":\"string\",\"description\":\"Receiver name associated with the payment. This is an optional field, For the speed associated with the fedwire payment rail, this will be mapped to {4200} tag.\",\"example\":\"Receiver name\"},\"phone\":{\"type\":\"string\",\"description\":\"Optional phone number of the receiver. Must be numeric and up to 10 digits.\",\"example\":\"18001236754\"},\"email\":{\"type\":\"string\",\"description\":\"Optional email address of the receiver. Must be a valid format (e.g., user@example.com).\\nUsed for communication or notification purposes, if supported by the payment rail.\\n\",\"example\":\"email@domain.com\"},\"swiftTag\":{\"type\":\"string\",\"description\":\"Deprecated, previously swift tag is **Required** for CTP Fedwire payments where the local instrument is set to `COVS`.\",\"deprecated\":true},\"swiftNote\":{\"type\":\"string\",\"description\":\"Deprecated, previously Swift note is **Required** for CTP Fedwire payments where the local instrument is set to `COVS`.\",\"deprecated\":true},\"address\":{\"type\":\"object\",\"properties\":{\"addressLine1\":{\"type\":\"string\",\"description\":\"Bank address line 1. *Required for Fedwire payments.*\",\"example\":\"111 My Street\"},\"addressLine2\":{\"type\":\"string\",\"description\":\"Bank address line 2.\",\"example\":\"Suite 210\"},\"city\":{\"type\":\"string\",\"description\":\"City Name. *Required for Fedwire payments.* \",\"example\":\"Charlotte\"},\"state\":{\"type\":\"string\",\"description\":\"State Name.\",\"example\":\"North Carolina\"},\"postalCode\":{\"type\":\"number\",\"description\":\"Country specific postal/zip code. This is an optional field needed for the domestic payment.\",\"example\":28269},\"countryCode\":{\"maxLength\":2,\"minLength\":2,\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed. *Required for Fedwire payments.* \",\"example\":\"US\"}},\"description\":\"\\\"The address pertains to the receiver or debtor. This field is required for fedwire payments and optional for other payment rails.\\\"\\n\",\"anyOf\":[{\"title\":\"Fedwire\",\"required\":[\"addressLine1\",\"city\",\"countryCode\"]},{\"title\":\"Ach/Instant/Swift\"}]},\"bank\":{\"required\":[\"bankIdType\"],\"type\":\"object\",\"properties\":{\"bankIdType\":{\"type\":\"string\",\"description\":\"Specifies the type of identifier used to locate the receiver's bank.\\n\\n- `NID`: Used for country-specific identifiers such as ABA (USA), IBAN (Europe), CLABE (Mexico), etc. Supported only for receivers in the US.\\n- `SWIFT`: Used for international money transfers.\\n\\nThe selected value must be valid for the receiver's country. Unsupported combinations will be rejected.\\n\",\"example\":\"NID\",\"enum\":[\"NID\",\"SWIFT\"]},\"bankId\":{\"type\":\"string\",\"description\":\"Receiver's bank identifier. **Required** when `bankIdType` is `NID`.\\n\\n- Must be exactly 9 digits and cannot be all zeros.\\n- Must exist in the system and be valid for the selected payment speed (e.g., RTP).\\n\",\"example\":\"072000326\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"Receiver's SWIFT/BIC code. **Required** when `bankIdType` is `SWIFT`.\\n\\n- Must be 8 and 11 alphanumeric characters.\\n- Cannot consist entirely of zeros.\\n- Must be a valid and registered SWIFT code in the system.\\n\",\"example\":\"CHASUS33XXX\"},\"accountType\":{\"type\":\"string\",\"description\":\"An optional field that indicates the type of creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"IBAN\",\"enum\":[\"IBAN\",\"Others\"]},\"accountNumber\":{\"maxLength\":34,\"type\":\"string\",\"description\":\"A conditionally mandatory field. When an account type is specified, this field must be provided. Represents the creditor agent identifier. This is applicable only for fedwire payments.\\n\",\"example\":\"DE89370400440532013000\"},\"name\":{\"type\":\"string\",\"description\":\"Optional name of the bank. For domestic (NID) and international (SWIFT) payments, if not provided, the Finzly system will auto-populate the name using directory lookup based on the provided bank code.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Country code of the receiver, following ISO 3166 format (e.g., US, GB, IN).\\n\\n- **Required if** `address.countryCode` is not provided.\\n- If both are provided, the values must match.\\n- Must be valid and configured in the system.\\n\",\"example\":\"US\"},\"address\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"],\"properties\":{\"addressLine1\":{\"type\":\"string\",\"description\":\"Bank address line 1.\",\"example\":\"111 My Street\"},\"addressLine2\":{\"type\":\"string\",\"description\":\"Bank address line 2.\",\"example\":\"Suite 210\"},\"city\":{\"type\":\"string\",\"description\":\"City Name.\",\"example\":\"Charlotte\"},\"state\":{\"type\":\"string\",\"description\":\"State Name.\",\"example\":\"North Carolina\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Country specific postal/zip code.\",\"example\":\"28269\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Country code per ISO 3166. Must match the top-level countryCode field in the bank object. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed.\",\"example\":\"US\"}},\"description\":\"The bank address information is required for banks located outside the United States. If any of the address fields are provided, it is mandatory to include addressLine1, city, state, postalCode, and countryCode.\"}},\"description\":\"The bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\",\"oneOf\":[{\"title\":\"Bank Identifier: NID\",\"required\":[\"bankId\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"NID\"]}},\"description\":\"Requires 'bankId' when bankIdType is 'NID'.\"},{\"title\":\"Bank Identifier: SWIFT\",\"required\":[\"swiftCode\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"SWIFT\"]}},\"description\":\"Requires 'swiftCode' when bankIdType is 'SWIFT'.\"}]},\"intermediaryBank\":{\"required\":[\"bankIdType\"],\"type\":\"object\",\"properties\":{\"bankIdType\":{\"type\":\"string\",\"description\":\"The bank unique identifier type. Use SWIFT for the international money transfer. Use NID to identify the country specific bank id such as IBAN mainly for european countries, CLABE for Mexico, ABA for USA  etc.\",\"example\":\"NID\",\"enum\":[\"NID\",\"SWIFT\"]},\"bankId\":{\"type\":\"string\",\"description\":\"Specifies the bank identifier used when the `bankIdType` is set to **NID** (ABA/Routing number).\\n\\n- Must be a 9-digit numeric value.\\n- This field is **required** only when `bankIdType` is **NID**.\\n- The value must reference a bank that is already registered and pre-configured in the system.\\n\\nIf the provided bank ID does not exist in the system, or if it represents an invalid intermediary bank,\\nthe transaction will not be processed.\\n\",\"example\":\"072000326\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"Specifies the SWIFT code (also known as BIC) of the beneficiary’s intermediary bank.\\n\\n- Required only when `bankIdType` is set to **SWIFT**.\\n- Must be an alphanumeric value without special characters or spaces.\\n- A SWIFT code typically consists of **8 to 11 characters** and uniquely identifies banks worldwide.\\n\\nEnsure the provided SWIFT code is valid and already configured in the system.\\nIf the code does not exist, the system will not be able to route the payment and the transaction will not be processed.\\n\",\"example\":\"CHASUS33XXX\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the bank. This is an optional for domestic [NID] and international [SWIFT] code. If not provided Finzly system will assign the name as per the directory lookup.\",\"example\":\"XYZ Bank\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Country code as defined by the **ISO 3166** standard.\\n\\n- Must consist of exactly two alphabetic characters (e.g., `US`, `GB`, `IN`).\\n- If the `address` object is provided, this value must exactly match `address.countryCode`.\\n- This field is **optional** if `address.countryCode` is already provided; otherwise, it is **required**.\\n\",\"example\":\"US\"},\"address\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\",\"state\"],\"properties\":{\"addressLine1\":{\"type\":\"string\",\"description\":\"Bank address line 1.\",\"example\":\"111 My Street\"},\"addressLine2\":{\"type\":\"string\",\"description\":\"Bank address line 2.\",\"example\":\"Suite 210\"},\"city\":{\"type\":\"string\",\"description\":\"City Name.\",\"example\":\"Charlotte\"},\"state\":{\"type\":\"string\",\"description\":\"State Name.\",\"example\":\"North Carolina\"},\"postalCode\":{\"type\":\"number\",\"description\":\"Country specific postal/zip code.\",\"example\":28269},\"countryCode\":{\"type\":\"string\",\"description\":\"Country codes per ISO 3166. Must be a 2-letter alphabetic country code (e.g., 'US', 'IN'). Numbers or special characters are not allowed.\",\"example\":\"US\"}},\"description\":\"The bank address information is required for banks located outside the United States. If any of the address fields are provided, it is mandatory to include addressLine1, city, state, postalCode, and countryCode.\"}},\"description\":\"The bank or intermediary bank details is needed to process the payment and it is required when the sender/receiver/debtor/creditor are not configured in the Finzly-CRM system. Based on the bankIDType either bankId or swiftCode is required. For the speed associated with the fedwire payment rail, this will be mapped to {4100} for the receiver bank and to {4000} for the receiver intermediary bank.\",\"oneOf\":[{\"title\":\"Bank Identifier: NID\",\"required\":[\"bankId\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"NID\"]}},\"description\":\"Requires 'bankId' when bankIdType is 'NID'.\"},{\"title\":\"Bank Identifier: SWIFT\",\"required\":[\"swiftCode\"],\"properties\":{\"bankIdType\":{\"type\":\"string\",\"enum\":[\"SWIFT\"]}},\"description\":\"Requires 'swiftCode' when bankIdType is 'SWIFT'.\"}]}},\"description\":\"Use this option when the receiver is not registered in the Finzly's CRM system.\"},{\"title\":\"Beneficiary in CRM\",\"required\":[\"beneficiaryId\"],\"properties\":{\"beneficiaryId\":{\"type\":\"number\",\"description\":\"Unique identifier of the receiver in Finzly CRM system. Optional — if provided, other receiver details are not required.\\n\\n  - Must refer to an active contact, deleted or invalid records will cause an error.\\n  - Either `beneficiaryId` or `accountNumber` must be provided.\\n\",\"example\":209219}},\"description\":\"Use this option when the receiver is already registered in the Finzly's CRM system.\"}]},\"fee\":{\"required\":[\"amount\"],\"type\":\"object\",\"properties\":{\"feeName\":{\"type\":\"string\",\"description\":\"Optional name of the fee.\\nDefaults to **\\\"Custom\\\"** if not provided.\\n\",\"example\":\"Custom\"},\"amount\":{\"type\":\"number\",\"description\":\"The amount of the fee to be charged.\\n- The amount must be greater than zero.\\n- Negative values are not allowed.\\n- The maximum allowed fee amount is 10,000,000.\\n\",\"example\":10.88}},\"description\":\"Fee details to be charged for the payment transaction.\\n\\n- This field is **optional**.\\n- Fee currency is fixed to **USD**.\\n\"},\"recurrence\":{\"required\":[\"frequency\",\"payUntil\"],\"type\":\"object\",\"properties\":{\"frequency\":{\"type\":\"string\",\"description\":\"Specifies how often the payment should occur.\",\"example\":\"Daily\",\"enum\":[\"Daily\",\"Weekly\",\"BiWeekly\",\"Monthly\",\"Quarterly\",\"SemiAnnually\",\"Yearly\"]},\"payUntil\":{\"type\":\"string\",\"description\":\"Specifies when the recurring payment should stop.\\n\\nAccepted values:\\n- **Cancelled**: Recurrence continues until manually stopped.\\n- **EndDate**: Recurrence ends on a specified date.\\n- **NumberOfPayments**: Recurrence ends after a specific number of payments.\\n\",\"example\":\"Cancelled\",\"enum\":[\"Cancelled\",\"EndDate\",\"NumberOfPayments\"]},\"endDate\":{\"type\":\"string\",\"description\":\"Specifies the end date for the recurring payment.\\n- Required when `payUntil` is **EndDate**.\\n- Format must be **MM-dd-yyyy**.\\n- The end date must be greater than the initial payment date.\\n\",\"example\":\"01-29-2023\"},\"numberOfPayments\":{\"maximum\":9999,\"type\":\"integer\",\"description\":\"Specifies the number of times the payment should recur.\\n\\n- Required when `payUntil` is **NumberOfPayments**.\\n- Must be between **1** and **9999**.\\n\",\"example\":10}},\"description\":\"Defines the recurrence pattern for the payment.\\nUse this object to configure how frequently the payment should repeat and when it should stop.\\n\\nFields such as `endDate` or `numberOfPayments` are conditionally required depending on the `payUntil` value.\\n\",\"oneOf\":[{\"title\":\"Recurring Until End Date\",\"required\":[\"endDate\"],\"properties\":{\"payUntil\":{\"type\":\"string\",\"enum\":[\"EndDate\"]}},\"description\":\"Requires 'endDate' when 'payUntil' is set to 'EndDate'.\"},{\"title\":\"Recurring for a Number of Payments\",\"required\":[\"numberOfPayments\"],\"properties\":{\"payUntil\":{\"type\":\"string\",\"enum\":[\"NumberOfPayments\"]}},\"description\":\"Requires 'numberOfPayments' when 'payUntil' is set to 'NumberOfPayments'.\"}]},\"additionalInfo\":{\"allOf\":[{\"type\":\"object\",\"properties\":{\"channel\":{\"type\":\"string\",\"description\":\"Specifies the name of the channel through which the payment is initiated.\\n\\n- This field is **optional**. If not provided, it defaults to **API**.\\n- Common examples include: `API`, `TELLER`, etc.\\n- The channel name must be pre-defined and registered within the Finzly system before it can be used in an API request.\\n\",\"example\":\"API\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Optional field used to identify the cost center associated with the payment.\\n\\nA cost center is a department or function within an organization—such as Accounting, Human Resources, or IT—that incurs costs but does not directly contribute to profit.\\n\\nThe provided cost center value must already exist in the system configuration.\\nIf it does not exist, the transaction will be rejected. Please ensure a valid cost center is used.\\n\",\"example\":\"12897\"},\"requestMethod\":{\"type\":\"string\",\"description\":\"This is an optional field. Customer payment request method from a given channel for e.g. WALK-IN, PHONE-IN etc.\",\"example\":\"WALK-IN\"},\"operationNote\":{\"maxLength\":1000,\"type\":\"string\",\"description\":\"Optional field for entering remarks or internal notes related to the payment operation.\"}}},{\"anyOf\":[{\"title\":\"ACH-specific\",\"required\":[\"secCode\"],\"properties\":{\"secCode\":{\"type\":\"string\",\"description\":\"SEC code representing how the ACH payment was authorized by the consumer or business.\\n\\n- Optional field, but required for ACH payments, especially when using **Economy** or **Economy Plus** processing speeds.\\n- The SEC code **IAT** is not permitted for **Same Day ACH** payments.\\n\",\"example\":\"CCD\"},\"transactionTypeCode\":{\"type\":\"string\",\"description\":\"Optional 3-letter transaction type code used when the SEC code is set to **IAT**.\\n\\n- Required for international ACH payments using the **Economy** payment type.\\n- Must be a valid code configured in the system.\\n\",\"example\":\"ANN\"},\"paymentRemittanceNotes\":{\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\"},\"receiverIdentificationNumber\":{\"type\":\"string\",\"description\":\"This is an optional field. It represents the Receiver’s DFI Identification Number and is applicable when the secCode is set to IAT. The value will be truncated by the system based on the selected payment rail.\",\"example\":\"12334356\"},\"benefitReceiver\":{\"$ref\":\"#/components/schemas/V5BenefitReceiver\"}},\"description\":\"ACH specific\"},{\"title\":\"Instant-specific\",\"properties\":{\"remittanceMethod\":{\"type\":\"string\",\"description\":\"Optional field used to specify the remittance delivery method.\\n\\n- Applicable only for **RTP (Real-Time Payments)**.\\n- Accepted values:\\n  - **EMAL** – Remittance information will be sent via email.\\n  - **URID** – Remittance information will be linked using a unique reference ID.\\n\",\"example\":\"EMAL\",\"enum\":[\"EMAL\",\"URID\"]},\"paymentRemittanceNotes\":{\"description\":\"Optional field used to specify remittance information for the beneficiary.\\n\\nThis field allows the originator to provide a message that is transmitted to the beneficiary's bank.\\nIt explains the purpose of the credit transfer and helps the beneficiary with payment reconciliation.\\n\\n- Applicable for **ACH**, **RTP**, **FedNow** and **Swift** payments.\\n- Character limits:\\n  - **ACH**: Up to 80 characters\\n  - **RTP**, **FedNow**, **Swift**: Up to 140 characters\\n\\n- Special characters:\\n  There is **no restriction** on special characters for this field.\\n\"},\"localInstruments\":{\"type\":\"string\",\"description\":\"Local instrument code applicable for the CTP fedwire or RTP or FEDNOW payment.\",\"example\":\"COVS\",\"enum\":[\"COVS\",\"ANSI\",\"GXML\",\"IXML\",\"NARR\",\"S820\",\"SWIF\",\"UEDI\",\"RRMT\",\"PROP\",\"STANDARD\",\"ZELLE\",\"INTERMEDIARY\",\"FDNA\",\"RMTS\"]}},\"description\":\"Fields specific to instant payment systems.\"},{\"title\":\"FEDWIRE-specific\",\"properties\":{\"referenceForBeneficiary\":{\"type\":\"string\",\"description\":\"This field is applicable for Fedwire payments, accepts an alphanumeric string, represents the beneficiary reference details, and is mapped to `EndToEndId` field and this will be mapped to {4320} tag.\",\"example\":\"RefForBeneficiary Details\"},\"detailsOfCharges\":{\"type\":\"string\",\"description\":\"Specifies who is responsible for the payment charges. This optional field applies\\nto both **Fedwire** and **SWIFT** payment speeds with accepted values are:\\n`OUR` (originator pays), `BEN` (beneficiary pays), and `SHA` (shared charges).\\n\",\"example\":\"OUR\"},\"unstructuredAddendaInfo\":{\"type\":\"object\",\"properties\":{\"addendaInformation\":{\"type\":\"string\"}},\"description\":\"Remittance details associated with the Fedwire payment message, used to convey additional unstructured information in the addenda.\"},\"senderToReceiverNotes\":{\"type\":\"string\",\"description\":\"This is applicable for the fedwire payment specifies additional information for the Receiver. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6500} tag in three lines and each line will have 35 characters.\",\"example\":\"Sender To Reciever Notes\"},\"originatortoBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\",\"deprecated\":true},\"originatorToBeneficiary\":{\"maxLength\":140,\"type\":\"string\",\"description\":\"Any additional information to be provided to the wire recipient. This is an optional field. For the speed associated with the FEDWIRE this is mapped to {6000} tag in four lines and each line will have 35 characters.\",\"example\":\"OBI Notes\"},\"proprietaryCode\":{\"type\":\"string\",\"description\":\"Deprecated field for fedwire payments, previously this is **required** for the fedwire payment where the local instrument set to PROP\",\"deprecated\":true},\"localInstruments\":{\"type\":\"string\",\"description\":\"Local instrument code applicable for the CTP fedwire or RTP or FEDNOW payment.\",\"example\":\"COVS\",\"deprecated\":true,\"enum\":[\"COVS\",\"ANSI\",\"GXML\",\"IXML\",\"NARR\",\"S820\",\"SWIF\",\"UEDI\",\"RRMT\",\"PROP\",\"RMTS\"]}},\"description\":\"FEDWIRE specific\"},{\"title\":\"SWIFT-specific\",\"properties\":{\"fxContractNumber\":{\"type\":\"string\",\"description\":\"Unique identifier for the FX (foreign exchange) trade, applicable for international payments.\\nThis is used to validate the FX contract against the payment request.\\n\\n- Must be a valid and active FX contract number.\\n- Required for **SWIFT** payments when `paymentDate` is not provided.\\n- The FX contract must exist in the system and match the requesting customer.\\n- The same FX contract number cannot be reused across multiple payments.\\n\",\"example\":\"111234\"},\"detailsOfCharges\":{\"type\":\"string\",\"description\":\"Specifies who is responsible for the payment charges. This optional field applies\\nto both **Fedwire** and **SWIFT** payment speeds with accepted values are:\\n`OUR` (originator pays), `BEN` (beneficiary pays), and `SHA` (shared charges).\\n\",\"example\":\"OUR\"}},\"description\":\"SWIFT specific\"}]}]}}},\"V4PaymentResponse\":{\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"paymentUID\":{\"type\":\"string\",\"description\":\"The unique payment reference id assigned by the Finzly-Payment system.\",\"example\":\"12930\"},\"paymentStatus\":{\"type\":\"string\",\"description\":\"The payment status assigned by the system upon creation.\",\"example\":\"INITIATED\"},\"recurrenceId\":{\"type\":\"number\",\"description\":\"The unique recurrence id which is associated with the payment.\",\"example\":5599},\"externalReferenceId\":{\"type\":\"string\",\"description\":\"Returing the unique reference id provided by the originator system.\",\"example\":\"123e4567\"}}},\"errors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V4PaymentError\"}}}},\"V3CreatePositivePayRule\":{\"required\":[\"amount\",\"customerAccountNumber\",\"effectiveDate\",\"paymentRuleType\"],\"type\":\"object\",\"oneOf\":[{\"title\":\"For FEDWIRE or INSTANT rule\",\"required\":[\"amountType\",\"beneBankId\",\"customerName\",\"frequency\"],\"properties\":{\"paymentRuleType\":{\"type\":\"string\",\"enum\":[\"FEDWIRE\",\"INSTANT\"]},\"customerName\":{\"type\":\"string\",\"description\":\"Customer short name associated with the payment positive rule\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment. If the customer is processing org then beneName is required for \\\"FEDNOW\\\", otherwise it's always required.\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"type\":\"string\",\"description\":\"Beneficiary bank name\",\"example\":\"Bank Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number, other than customer processing org beneAccountNumber is required.\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency\",\"example\":\"Annual\",\"enum\":[\"Ongoing\",\"Onetime\",\"Daily\",\"Weekly\",\"Bi-weekly\",\"Monthly\",\"Quarterly\",\"Semi-annual\",\"Annual\"]},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"}}},{\"title\":\"For ACH rule\",\"required\":[\"achCompanyID\"],\"properties\":{\"paymentRuleType\":{\"type\":\"string\",\"enum\":[\"ACH\"]},\"customerName\":{\"type\":\"string\",\"description\":\"Customer short name associated with the payment positive rule, If not provided, populated from the bank account profile configured in CRM\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"customerRoutingNumber\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Receiver bank routing number. If not provided, populated from the bank account profile configured in CRM or core.\",\"example\":\"071212128\"},\"authType\":{\"type\":\"string\",\"description\":\"Authorization type.Defaults to DEBIT if not provided.\",\"example\":\"DEBIT\",\"enum\":[\"DEBIT\",\"CREDIT\"]},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"1234567899\"},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment.\",\"example\":\"XYZ Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number.\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.Defaults to 'Exact' if not provided.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency.Defaults to 'Onetime' if not provided.\",\"example\":\"Ongoing\",\"enum\":[\"Ongoing\",\"Onetime\",\"Daily\",\"Weekly\",\"Bi-weekly\",\"Monthly\",\"Quarterly\",\"Semi-annual\",\"Annual\"]},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule. It is an optional field.\",\"example\":\"CCD\",\"enum\":[\"ALL\",\"WEB\",\"PPD\",\"CCD\",\"CTX\",\"POP\",\"COR\",\"TEL\",\"CIE\",\"ARC\",\"BOC\",\"POS\",\"RCK\",\"ADV\",\"ATX\",\"DNE\",\"MTE\",\"SHR\",\"TRC\",\"TRX\",\"XCK\",\"IAT\"]},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"},\"authorizationUntil\":{\"type\":\"string\",\"description\":\"Positive pay rule Authorization Until.Defaults to 'Until Cancelled' if not provided.\",\"example\":\"Until Cancelled\",\"enum\":[\"Until Cancelled\",\"Certain Date\",\"Certain number of payments\"]},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format. Required when authorizationUntil is 'Certain Date'.\",\"example\":\"12-31-2022\"},\"numberOfPayments\":{\"type\":\"number\",\"description\":\"Number of payments the rule remains active for. Required when authorizationUntil is 'Certain Number of Payments'. Valid range: 1 to 9999. Defaults to 1 if not provided\\\"\\n\",\"example\":10},\"transactionIdNumber\":{\"maxLength\":15,\"type\":\"string\",\"description\":\"Transaction identification number used in ACH rule matching. Represents Identification Number or Check Number depending on SEC Code. Max 15 characters (9 for POP SEC code).\",\"example\":\"TXN12345\"},\"entryDescription\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"Entry description for ACH rule matching. Compared to NACHA Batch Header Company Entry Description.\",\"example\":\"PAYROLL\"},\"discretionaryData\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Company discretionary data for ACH rule matching. Compared to NACHA Batch Header Company Discretionary Data.\",\"example\":\"DISC_DATA\"}}}]},\"V3CreatePositivePayRuleResponse\":{\"properties\":{\"ruleUID\":{\"type\":\"number\",\"description\":\"The unique rule id assigned by the Finzly-Payment system.\",\"example\":12930}}},\"V3UpdatePositivePayRule\":{\"oneOf\":[{\"title\":\"For FEDWIRE or INSTANT rule\",\"properties\":{\"customerName\":{\"type\":\"string\",\"description\":\"Customer short name associated with the payment positive rule\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment. If the customer is processing org then beneName is required for \\\"FEDNOW\\\", otherwise it's always required.\",\"example\":\"XYZ Name\"},\"beneBankName\":{\"type\":\"string\",\"description\":\"Beneficiary bank name\",\"example\":\"Bank Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number, other than customer processing org beneAccountNumber is required.\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency\",\"example\":\"Annual\",\"enum\":[\"Ongoing\",\"Onetime\",\"Daily\",\"Weekly\",\"Bi-weekly\",\"Monthly\",\"Quarterly\",\"Semi-annual\",\"Annual\"]},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"}}},{\"title\":\"For ACH rule\",\"properties\":{\"customerName\":{\"type\":\"string\",\"description\":\"Customer short name associated with the payment positive rule, If not provided, populated from the bank account profile configured in CRM\",\"example\":\"ABC Company\"},\"customerAccountNumber\":{\"type\":\"string\",\"description\":\"Bank Account Number\",\"example\":\"12387878\"},\"customerRoutingNumber\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Receiver bank routing number.\",\"example\":\"071212128\"},\"authType\":{\"type\":\"string\",\"description\":\"Authorization type.\",\"example\":\"DEBIT\",\"enum\":[\"DEBIT\",\"CREDIT\"]},\"achCompanyID\":{\"type\":\"string\",\"description\":\"ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)\",\"example\":\"1234567899\"},\"beneBankId\":{\"type\":\"string\",\"description\":\"Bank unique id that is used to identify a specific bank\",\"example\":\"12345678\"},\"beneName\":{\"type\":\"string\",\"description\":\"A beneficiary is the person or entity that will receive the payment.\",\"example\":\"XYZ Name\"},\"beneAccountNumber\":{\"type\":\"string\",\"description\":\"A beneficiary bank account number.\",\"example\":\"12345678\"},\"amount\":{\"type\":\"number\",\"description\":\"Payment amount\",\"example\":10},\"amountType\":{\"type\":\"string\",\"description\":\"Type of amount associated with the positive pay rule.\",\"example\":\"EXACT\",\"enum\":[\"EXACT\",\"MAXIMUM\"]},\"frequency\":{\"type\":\"string\",\"description\":\"Positive pay rule frequency.\",\"example\":\"Onetime\",\"enum\":[\"Ongoing\",\"Onetime\",\"Daily\",\"Weekly\",\"Bi-weekly\",\"Monthly\",\"Quarterly\",\"Semi-annual\",\"Annual\"]},\"secCode\":{\"type\":\"string\",\"description\":\"SEC code associated with the ACH positive rule. It is an optional field.\",\"example\":\"CCD\",\"enum\":[\"ALL\",\"WEB\",\"PPD\",\"CCD\",\"CTX\",\"POP\",\"COR\",\"TEL\",\"CIE\",\"ARC\",\"BOC\",\"POS\",\"RCK\",\"ADV\",\"ATX\",\"DNE\",\"MTE\",\"SHR\",\"TRC\",\"TRX\",\"XCK\",\"IAT\"]},\"effectiveDate\":{\"type\":\"string\",\"description\":\"Rule effective date in mm-dd-yyyy format\",\"example\":\"12-31-2022\"},\"authorizationUntil\":{\"type\":\"string\",\"description\":\"Positive pay rule Authorization Until.Defaults to 'Until Cancelled' if not provided.\",\"example\":\"Until Cancelled\",\"enum\":[\"Until Cancelled\",\"Certain Date\",\"Certain number of payments\"]},\"expiryDate\":{\"type\":\"string\",\"description\":\"Rule expiry date in mm-dd-yyyy format. Required when authorizationUntil is 'Certain Date'.\",\"example\":\"12-31-2022\"},\"numberOfPayments\":{\"type\":\"number\",\"description\":\"Number of payments the rule remains active for. Required when authorizationUntil is 'Certain Number of Payments'. Valid range: 1 to 9999. Defaults to 1 if not provided\\\"\\n\",\"example\":10},\"transactionIdNumber\":{\"maxLength\":15,\"type\":\"string\",\"description\":\"Transaction identification number used in ACH rule matching. Represents Identification Number or Check Number depending on SEC Code. Max 15 characters (9 for POP SEC code).\",\"example\":\"TXN12345\"},\"entryDescription\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"Entry description for ACH rule matching. Compared to NACHA Batch Header Company Entry Description.\",\"example\":\"PAYROLL\"},\"discretionaryData\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Company discretionary data for ACH rule matching. Compared to NACHA Batch Header Company Discretionary Data.\",\"example\":\"DISC_DATA\"}}}]},\"V3UpdatePositivePayRuleResponse\":{\"properties\":{\"errors\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code for identifying the issue.\"}}}}}},\"WaterfallTransferRequest\":{\"required\":[\"externalReferenceId\",\"payments\"],\"type\":\"object\",\"properties\":{\"externalReferenceId\":{\"maxLength\":200,\"pattern\":\"^[a-zA-Z0-9_-]+$\",\"type\":\"string\",\"description\":\"Unique identifier assigned to the payment request.\\n - Populated as a batch number by the bank.\\n - Provides traceability and prevents duplicate processing.\\n\",\"example\":\"wf-20250716-279514\"},\"payments\":{\"type\":\"array\",\"description\":\"List of individual payments in the waterfall.\",\"items\":{\"required\":[\"creditorAccount\",\"debtorAccount\",\"paymentAmount\",\"paymentIndex\"],\"type\":\"object\",\"properties\":{\"paymentIndex\":{\"minimum\":1,\"uniqueItems\":true,\"type\":\"integer\",\"description\":\"Index representing the position of this payment in the waterfall execution sequence.\\n - Must be unique within the batch.\\n - Cannot be duplicated or repeated across payments in the same request.\\n\",\"example\":1},\"paymentAmount\":{\"type\":\"number\",\"description\":\"Amount to be transferred in USD.\",\"format\":\"float\",\"example\":10000},\"paymentNotes\":{\"maxLength\":200,\"pattern\":\"^[a-zA-Z0-9 ]+$\",\"type\":\"string\",\"description\":\"Optional notes or comments about this payment.\\n- Provided by the payment originator.\\n- Can include details or instructions related to the payment.\\n- Helps with payment tracking and reconciliation.\\n\",\"example\":\"First waterfall payment\"},\"debtorAccount\":{\"required\":[\"accountNumber\",\"accountSubType\",\"accountType\",\"routingNumber\"],\"type\":\"object\",\"properties\":{\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9]*$\",\"type\":\"string\",\"description\":\"Bank account number of the debtor from which the payment amount will be withdrawn.\\n- Represents the debtor's source account for the transaction.\\n- Must be valid and authorized for initiating payments.\\n\",\"example\":\"123452334\"},\"accountType\":{\"maxLength\":35,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies the type of the account associated with the transaction.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"accountSubType\":{\"pattern\":\"^[a-zA-Z]+( [a-zA-Z]+)*$\",\"type\":\"string\",\"description\":\"Specifies the sub-type of the bank account.\\n  - Provides additional classification beyond the main account type.\\n  - Must correspond to the account type defined in the system.\\n\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"routingNumber\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[A-Za-z0-9]*$\",\"type\":\"string\",\"description\":\"Routing number of the debtor, used to identify the financial institution.\\n\",\"example\":\"022300173\"}}},\"creditorAccount\":{\"required\":[\"accountNumber\",\"accountSubType\",\"accountType\",\"routingNumber\"],\"type\":\"object\",\"properties\":{\"accountNumber\":{\"maxLength\":35,\"pattern\":\"^[A-Za-z0-9]*$\",\"type\":\"string\",\"description\":\"Bank account number of the creditor from which the payment amount will be withdrawn.\\n- Represents the creditor's source account for the transaction.\\n- Must be valid and authorized for initiating payments.\\n\",\"example\":\"123452334\"},\"accountType\":{\"maxLength\":35,\"pattern\":\"^[a-zA-Z]+$\",\"type\":\"string\",\"description\":\"Specifies the type of the account associated with the transaction.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"GL\",\"Loan\"]},\"accountSubType\":{\"pattern\":\"^[a-zA-Z]+( [a-zA-Z]+)*$\",\"type\":\"string\",\"description\":\"Specifies the sub-type of the bank account.\\n  - Provides additional classification beyond the main account type.\\n  - Must correspond to the account type defined in the system.\\n\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"CD\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]},\"routingNumber\":{\"maxLength\":9,\"minLength\":9,\"pattern\":\"^[A-Za-z0-9]*$\",\"type\":\"string\",\"description\":\"Routing number of the creditor, used to identify the financial institution.\\n\",\"example\":\"022300173\"}}}}}}}},\"RfiSendRequest\":{\"type\":\"object\",\"properties\":{\"missingInformation\":{\"type\":\"array\",\"description\":\"List of missing information items being requested. \\nAllowed codes: MS01, NARR (same for both RTP and FedNow)\\n\",\"items\":{\"$ref\":\"#/components/schemas/MissingStatusReasonInfo\"}},\"incorrectInformation\":{\"type\":\"array\",\"description\":\"List of incorrect information items being requested. \\nAllowed codes depend on payment delivery method:\\n- RTP: IN01, IN04, IN06, IN15, IN19, IN38, IN39, MM20, MM21, NARR\\n- FedNow: IN03, IN13, IN14, IN39, IN07, IN08, IN38, IN06, IN16, IN02, IN15, MM35, MM20, MM21, NARR, MM31, MM32, MM27, MM28, MM29, MM30, MM25, MM26\\nCodes are validated against the payment's delivery method.\\n\",\"items\":{\"$ref\":\"#/components/schemas/IncorrectStatusReasonInfo\"}},\"initiatingPartyName\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Name of the party initiating the RFI request. This field is required.\",\"example\":\"ABC Corporation\"}},\"description\":\"Request body for sending RFI. \\nWorks for both RTP and FedNow delivery methods.\\nAt least one of missingInformation or incorrectInformation must be provided.\\ninitiatingPartyName is required.\\nNote: Incorrect information codes are validated against the payment's delivery method.\\nRTP allowed incorrect codes: IN01, IN04, IN06, IN15, IN19, IN38, IN39, MM20, MM21, NARR\\nFedNow allowed incorrect codes: IN03, IN13, IN14, IN39, IN07, IN08, IN38, IN06, IN16, IN02, IN15, MM35, MM20, MM21, NARR, MM31, MM32, MM27, MM28, MM29, MM30, MM25, MM26\\n\",\"example\":{\"missingInformation\":[{\"code\":\"MS01\",\"additionalInfo\":\"Missing beneficiary account information\"},{\"code\":\"NARR\",\"additionalInfo\":\"Additional narrative information required for processing\"}],\"incorrectInformation\":[{\"code\":\"IN01\",\"additionalInfo\":\"Incorrect beneficiary name\"}],\"initiatingPartyName\":\"ABC Corporation\"},\"x-validation-rules\":[\"At least one of missingInformation or incorrectInformation must be provided\"]},\"RfiSendSuccessResponse\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Response message describing the operation result\",\"example\":\"Request for Information has been sent successfully\"},\"paymentId\":{\"type\":\"string\",\"description\":\"Payment identifier associated with the RFI request\",\"example\":\"126791\"},\"deliveryMethod\":{\"type\":\"string\",\"description\":\"Delivery method of the payment (RTP or FEDNOW)\",\"example\":\"FEDNOW\",\"enum\":[\"RTP\",\"FEDNOW\"]},\"timestamp\":{\"type\":\"string\",\"description\":\"Timestamp when the RFI request was processed\",\"format\":\"date-time\",\"example\":\"2025-12-03T10:51:29.4687354+05:30\"}},\"example\":{\"message\":\"Request for Information has been sent successfully\",\"paymentId\":\"126791\",\"deliveryMethod\":\"FEDNOW\",\"timestamp\":\"2025-12-03T10:51:29.4687354+05:30\"}},\"RfiSendErrorResponse\":{\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of errors that occurred during processing\",\"items\":{\"$ref\":\"#/components/schemas/RFIError\"}}},\"example\":{\"errors\":[{\"code\":\"RFI_MISSINGORINCORRECTINFO_REQUIRED\",\"message\":\"Please provide at least one of the following: missing information or incorrect information details to proceed with the Request for Information.\"}]}},\"MissingStatusReasonInfo\":{\"required\":[\"code\"],\"type\":\"object\",\"properties\":{\"code\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Status reason code indicating the type of missing information.\\nAllowed codes: MS01, NARR (same for both RTP and FedNow delivery methods).\\nIf code is 'NARR', additionalInfo is required.\\n\",\"example\":\"MS01\",\"enum\":[\"MS01\",\"NARR\"]},\"additionalInfo\":{\"maxLength\":500,\"type\":\"string\",\"description\":\"Additional details about the missing information status reason.\\nThis field is required when code is 'NARR'.\\n\",\"example\":\"Missing beneficiary account information\"}},\"description\":\"Status reason information for missing information items.\\nThe code field is required. When code is 'NARR', the additionalInfo field is mandatory.\\n\",\"example\":{\"code\":\"MS01\",\"additionalInfo\":\"Missing beneficiary account information\"}},\"IncorrectStatusReasonInfo\":{\"required\":[\"code\"],\"type\":\"object\",\"properties\":{\"code\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Status reason code indicating the type of incorrect information.\\nAllowed codes depend on payment delivery method:\\n- RTP: IN01, IN04, IN06, IN15, IN19, IN38, IN39, MM20, MM21, NARR\\n- FedNow: IN03, IN13, IN14, IN39, IN07, IN08, IN38, IN06, IN16, IN02, IN15, MM35, MM20, MM21, NARR, MM31, MM32, MM27, MM28, MM29, MM30, MM25, MM26\\nCodes are validated against the payment's delivery method at runtime.\\nIf code is 'NARR', additionalInfo is required.\\n\",\"example\":\"IN01\"},\"additionalInfo\":{\"maxLength\":500,\"type\":\"string\",\"description\":\"Additional details about the incorrect information status reason.\\nThis field is required when code is 'NARR'.\\n\",\"example\":\"Incorrect beneficiary name\"}},\"description\":\"Status reason information for incorrect information items.\\nThe code field is required. When code is 'NARR', the additionalInfo field is mandatory.\\nNote: Allowed codes depend on the payment's delivery method (RTP or FedNow) and are validated at runtime.\\n\",\"example\":{\"code\":\"IN01\",\"additionalInfo\":\"Incorrect beneficiary name\"}},\"RFIError\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code identifying the type of error\",\"example\":\"RFI_MISSINGORINCORRECTINFO_REQUIRED\",\"enum\":[\"RFI_MISSINGORINCORRECTINFO_REQUIRED\",\"RFI_INITPARTYNAME_REQUIRED\",\"RFI_STATUSREASONINFO_NULL\",\"RFI_STATUSREASONCODE_REQUIRED\",\"RFI_ADDITIONALINFO_REQUIRED\",\"RFI_MISSINGINFOCODE_INVALID\",\"RFI_INCORRECTINFOCODE_INVALID\",\"RFI_INCORRECTINFOCODE_MISMATCH\",\"RFI_PAYMENTID_REQUIRED\",\"RFI_PAYMENTID_INVALID\",\"RFI_PAYMENT_NOTFOUND\",\"RFI_PAYMENTDELIVERYMETHOD_INVALID\",\"RFI_PAYMENTIOTYPE_INVALID\",\"RFI_ENTRYTYPE_INVALID\",\"RFI_OUTPAYMENTSTATUS_INVALID\",\"RFI_DIRECTION_REQUIRED\",\"RFI_DIRECTION_INVALID\",\"RFI_SERVICE_ERROR\",\"RFI_SERVICE_CALL_FAILED\",\"RFI_VALIDATION_ERROR\",\"RFI_INVALID_INPUT\"]},\"message\":{\"type\":\"string\",\"description\":\"Human-readable error message describing the issue\",\"example\":\"Please provide at least one of the following: missing information or incorrect information details to proceed with the Request for Information.\"}},\"example\":{\"code\":\"RFI_MISSINGORINCORRECTINFO_REQUIRED\",\"message\":\"Please provide at least one of the following: missing information or incorrect information details to proceed with the Request for Information.\"}},\"RfiHistorySuccessResponse\":{\"type\":\"object\",\"properties\":{\"paymentId\":{\"type\":\"string\",\"description\":\"Payment identifier associated with the RFI history\",\"example\":\"PAY123456789\"},\"deliveryMethod\":{\"type\":\"string\",\"description\":\"Delivery method of the payment (RTP or FEDNOW)\",\"example\":\"RTP\",\"enum\":[\"RTP\",\"FEDNOW\"]},\"recordCount\":{\"type\":\"integer\",\"description\":\"Number of RFI history records returned\",\"example\":2},\"rfiHistory\":{\"type\":\"array\",\"description\":\"List of unified RFI history records (works for both RTP and FedNow)\",\"items\":{\"$ref\":\"#/components/schemas/RfiHistoryItem\"}}},\"example\":{\"paymentId\":\"PAY123456789\",\"deliveryMethod\":\"RTP\",\"recordCount\":2,\"rfiHistory\":[{\"rfiMessageId\":\"M20251127101010101MTBOTS00154950919\",\"requestDirection\":\"IN\",\"missingInformation\":[{\"code\":\"MS01\",\"additionalInfo\":\"Missing beneficiary account information\"}],\"incorrectInformation\":[],\"initiatingPartyName\":\"ABC Corporation\"}]}},\"RfiHistoryErrorResponse\":{\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"description\":\"List of errors that occurred during processing\",\"items\":{\"$ref\":\"#/components/schemas/RFIError\"}}},\"example\":{\"errors\":[{\"code\":\"RFI_PAYMENTID_REQUIRED\",\"message\":\"Payment ID is required to process this Request for Information. Please provide a valid payment identifier.\"}]}},\"RfiHistoryItem\":{\"type\":\"object\",\"properties\":{\"rfiMessageId\":{\"type\":\"string\",\"description\":\"Message identifier for the RFI transaction\",\"example\":\"M20251127101010101MTBOTS00154950919\"},\"requestDirection\":{\"type\":\"string\",\"description\":\"Direction of the RFI request\",\"example\":\"IN\",\"enum\":[\"IN\",\"OUT\"]},\"missingInformation\":{\"type\":\"array\",\"description\":\"List of missing information items\",\"items\":{\"$ref\":\"#/components/schemas/MissingStatusReasonInfo\"}},\"incorrectInformation\":{\"type\":\"array\",\"description\":\"List of incorrect information items\",\"items\":{\"$ref\":\"#/components/schemas/IncorrectStatusReasonInfo\"}},\"initiatingPartyName\":{\"type\":\"string\",\"description\":\"Name of the party initiating the RFI request\",\"example\":\"ABC Corporation\"}},\"description\":\"Individual RFI history record. Unified format for both RTP and FedNow delivery methods.\\n\",\"example\":{\"rfiMessageId\":\"M20251127101010101MTBOTS00154950919\",\"requestDirection\":\"IN\",\"missingInformation\":[{\"code\":\"MS01\",\"additionalInfo\":\"Missing beneficiary account information\"}],\"incorrectInformation\":[{\"code\":\"IN01\",\"additionalInfo\":\"Incorrect beneficiary name\"}],\"initiatingPartyName\":\"ABC Corporation\"}},\"GenericForbiddenErrorResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"example\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"},\"messageKey\":{\"type\":\"string\",\"nullable\":true},\"messageParams\":{\"type\":\"object\",\"nullable\":true},\"data\":{\"type\":\"object\",\"nullable\":true}}},\"V2ErrorResponse\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"example\":\"Failure\"},\"code\":{\"type\":\"string\",\"example\":\"API901\"},\"message\":{\"type\":\"string\",\"example\":\"Unauthorized request\"},\"data\":{\"type\":\"string\",\"nullable\":true}}}},\"securitySchemes\":{\"oAuth2\":{\"type\":\"oauth2\",\"description\":\"Finzly Connect API uses OAuth 2.0 authcodeflow with PKCE for end user authorization or implicit grant flow for system API accounts. A support request to Finzly is required to use implicit grant flow.\",\"flows\":{\"authorizationCode\":{\"authorizationUrl\":\"https://sandbox-security-uat.finzly.io/auth\",\"tokenUrl\":\"https://sandbox-security-uat.finzly.io/auth/realms/BANKOS.UAT.SANDBOX.CUSTOMER/protocol/openid-connect/token\",\"scopes\":{\"roles\":\"manage\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Node.js\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi/paymentapi/overview/","redocItemId":"tag/Positive-Pay/operation/getPositivePayRule","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"}]}},"requestLogin":false,"lastModified":"2026-04-24T14:01:20.000Z"},"seo":{"title":"Get PositivePay Rule By RuleUID"}}},"pageContext":{"id":"e36cccba-aa44-53eb-91e0-dfb451429746operation/getPositivePayRule__redocly content/openapi/paymentapi/operation/getPositivePayRule/","seo":{"title":"Get PositivePay Rule By RuleUID","description":"Get Positive Pay Rule","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/paymentAPI.page.yaml#operation/getPositivePayRule","pageBaseUrl":"/openapi/paymentapi","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/paymentapi/operation/getPositivePayRule/","sidebarName":"training","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"paymentApi","id":"paymentApi","title":"paymentApi","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}