{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/customerapi/operation/deleteCustomerSignatory/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/customerapi/operation/deleteCustomerSignatory/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Customer and Account API\",\"version\":\"2.5.1\"},\"servers\":[{\"url\":\"https://sandbox-digitalbanking-uat.finzly.io/auth/realms/{{TENANT}}/protocol/openid-connect/token\",\"description\":\"FinzlyConnect Customer APIs\",\"variables\":{\"tenant\":{\"description\":\"BankOS tenant code\",\"default\":\"sandbox\"}}}],\"security\":[{\"oAuth2\":[\"roles\"]}],\"tags\":[{\"name\":\"Customer\",\"description\":\"Customer APIs entitles the downstream partners, Banks and their associates to formally onboard clients with all the necessary information required to perform financial operations. \\n\\nThese API's will further help to search & maintain these onboarded clients, update any changes in client information.\\n\\nFollowing use cases helps you to understand the current customer capabilities exposed via APIs \\n\\n1. Create Customer\\n2. Update Customer\\n3. Search Customers\\n4. Get Customer Details\\n\"},{\"name\":\"Customer Account\",\"description\":\"The Customer Account API is now `deprecated` and should no longer be used for new integrations. \\nThis API previously supported managing customer-associated accounts, including:\\n\\n1. Create Customer Account\\n2. Update Customer Account\\n3. Search Customer Accounts\\n4. Get Customer Account Details\\n\\nTo ensure continued support and access to the latest features and enhancements, please use the *`Customer Account – V3 API`*, which serves as the upgraded and actively supported version.\\n\"},{\"name\":\"Customer Contact\",\"description\":\"Customer Contact APIs helps you to manage the customer  beneficiaries (contacts) in the finzly CRM system. \\n\\nOnce the contacts are defined the contact UID can be used in the payment API as a receiver [accountUID] to initiate a payment request. \\n\\nFollowing use cases helps you to understand the current customer contacts capabilities exposed via APIs\\n\\n1. Create Customer Contact\\n2. Update Customer Contact\\n3. Search Customer Contacts\\n4. Get Customer Contact Details\\n\"},{\"name\":\"Customer User\",\"description\":\"Customer user APIs helps you to manage the users associated with the customer.\\n\\nFollowing use cases helps you to understand the current customer users capabilities exposed via APIs\\n\\n1. Create Customer User\\n2. Update Customer User\\n\"},{\"name\":\"Customer Role\",\"description\":\"Customer role APIs helps you to manage the roles associated with the users.\\n\\nFollowing use cases helps you to understand the current customer roles capabilities exposed via APIs\\n\\n1. Create Customer Role\\n2. Update Customer Role\\n\"},{\"name\":\"Customer Lookup\",\"description\":\"The **Customer Lookup** API allows you to retrieve detailed customer information quickly and reliably.\\n\\nTo perform a lookup, you must provide the following fields:\\n- **Customer Account Number** (required)\\n- **Customer Account Type** (optional, but recommended for more accurate results)\\n\\nIf `accountType` is not provided, the lookup will return details for all matching account types.\\n\"},{\"name\":\"Customer Signatories\",\"description\":\"**Customer signatory** — A person authorized to act on behalf of a **customer** (legal entity), including\\ncontact details, title, and an optional **approval limit** for transactions.\\n\\nSignatory data is owned by the **legal-entity** service. This API is **customer-centric**: URLs and path\\nparameters use `customerId`, and the Open Banking layer maps those calls to the appropriate legal-entity\\nsignatory operations.\\n\\nSupported capabilities in this specification: **create** a signatory, **partially update** one, **list**\\nsignatories for a customer (including optional paging), and **delete** a signatory.\\n\\n**Note:** There is no standalone **get signatory by id** operation in this API. Clients obtain `id` values from\\ncreate and list responses and may select a row from the list payload when a single record is needed.    \\n\"}],\"paths\":{\"/v2/customers\":{\"get\":{\"tags\":[\"Customer\"],\"summary\":\"Search customers\",\"description\":\"Search and retrieve customers associated with a customer based on their search parameters.\\n\",\"operationId\":\"searchCustomers\",\"parameters\":[{\"name\":\"legalName\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Full text search of full legal name\"}},{\"name\":\"customerType\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by type of customer such as Corporate, Consumer, Financial_Institution, Downstream_Partner.\"}},{\"name\":\"shortName\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by Customer short name\"}},{\"name\":\"customerId\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by customerId\"}},{\"name\":\"customerUID\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by customer unique id.\"}},{\"name\":\"status\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by status\"}},{\"name\":\"taxId\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Search by taxId\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Which number of page of results to be returned\",\"example\":\"1\"}},{\"name\":\"limit\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":1000,\"type\":\"string\",\"description\":\"Total number of records to be returned for a given page\",\"example\":\"100\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomersResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomersResponse\"}}}}}},\"post\":{\"tags\":[\"Customer\"],\"summary\":\"Add customer\",\"description\":\"Create a customer in the BankOS CRM system\",\"operationId\":\"createCustomer\",\"requestBody\":{\"description\":\"Customer details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateCustomerRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateUpdateCustomerResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Customer details with newly created ID\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateUpdateCustomerResponse\"}}}}}}},\"/v2/customers/{customerUID}\":{\"get\":{\"tags\":[\"Customer\"],\"summary\":\"Get customer\",\"description\":\"Retrieve the customer information from the system\",\"operationId\":\"getCustomerByCustomerUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier associated with the customer in the Finzly's CRM system\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomersResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomersResponse\"}}}}}},\"put\":{\"tags\":[\"Customer\"],\"summary\":\"Update customer\",\"description\":\"Update an existing customer information\",\"operationId\":\"updateCustomerByCustomerUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier associated with the customer in the Finzly's CRM system\"}}],\"requestBody\":{\"description\":\"Customer details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomerRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomersResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Customer details with newly created ID\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomersResponse\"}}}}}}},\"/v1/customers/{customerUID}/fees\":{\"post\":{\"tags\":[\"Customer\"],\"summary\":\"Add customer fee tier\",\"description\":\"This endpoint allows adding a customer fee tier for an existing customer, only if the fee is already configured in the system.\",\"operationId\":\"addCustomerFeeTierByCustomerUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier associated with the customer in the Finzly's CRM system\"}}],\"requestBody\":{\"description\":\"Customer fee tier details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AddCustomerFeeTierRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FeeAddAndUpdateResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\"},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Customer fee tier id.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FeeAddAndUpdateResponse\"}}}}}}},\"/v1/customers/{customerUID}/fees/{feeId}\":{\"put\":{\"tags\":[\"Customer\"],\"summary\":\"Update customer fee tier\",\"description\":\"This feature allows update a customer fee tier for an existing customer, only if the fee is already configured in the system.\",\"operationId\":\"updateCustomerFeeTierByCustomerUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier associated with the customer in the Finzly's CRM system\"}},{\"name\":\"feeId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer feeTier unique identifier associated with the customer in the Finzly's CRM system\"}}],\"requestBody\":{\"description\":\"Customer fee tier details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomerFeeTierRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully processed request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FeeAddAndUpdateResponse\"}}}},\"400\":{\"description\":\"bad input parameter environment\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_400\"}}}},\"401\":{\"description\":\"You are not authorized to access the resource\"},\"402\":{\"description\":\"The parameters were valid but the request failed.\"},\"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\"},\"409\":{\"description\":\"The request conflicts with another request (perhaps due to using the same idempotent key).\"},\"429\":{\"description\":\"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"},\"500\":{\"description\":\"Something went wrong on back end.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Customer fee tier id.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FeeAddAndUpdateResponse\"}}}}}}},\"/v2/customers/{customerUID}/accounts\":{\"get\":{\"tags\":[\"Customer Account\"],\"summary\":\"Search Customer Accounts\",\"description\":\"Search the customer accounts for a given customer\",\"operationId\":\"searchCustomerAccounts\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier assigned by the system\"}},{\"name\":\"accountType\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Type of account. Applicable values are `Deposit` and `Loan`.\",\"example\":\"Deposit\"}},{\"name\":\"accountSubType\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Type of sub account type. Applicable values: `Checking`, `Savings` and `Pseudo`.\",\"example\":\"Checking\"}},{\"name\":\"status\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Status if the account\",\"example\":\"Active or Closed or Suspended\"}},{\"name\":\"currency\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Currency of the account\",\"example\":\"USD\"}},{\"name\":\"wireEnabled\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\"},\"example\":true},{\"name\":\"accountNumber\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\"},\"example\":11223345}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchAccountResponse\"}}}}}},\"post\":{\"tags\":[\"Customer Account\"],\"summary\":\"Create customer account\",\"description\":\"Create a customer account\",\"operationId\":\"createCustomerAccount\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"integer\",\"description\":\"Unique Customer Id\"}}],\"requestBody\":{\"description\":\"Account Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountResponse\"}}}}}}},\"/v2/customers/{customerUID}/accounts/{accountUID}\":{\"get\":{\"tags\":[\"Customer Account\"],\"summary\":\"Get customer account\",\"description\":\"Retrieve an account details\",\"operationId\":\"getCustomerAccountByAccountUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Account Id\",\"example\":\"Account UID\"}},{\"name\":\"includeAccountBalance\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"boolean\",\"description\":\"Pass this as true if to pull in account balance as well, false otherwise\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetAccountResponse\"}}}}}},\"put\":{\"tags\":[\"Customer Account\"],\"summary\":\"Update customer account\",\"description\":\"Update Customer Account\",\"operationId\":\"updateCustomerAccountByAccountUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Account Id\"}}],\"requestBody\":{\"description\":\"Account Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountResponse\"}}}}}},\"delete\":{\"tags\":[\"Customer Account\"],\"summary\":\"Delete customer account\",\"description\":\"Delete Customer Account\",\"operationId\":\"deleteCustomerAccountByAccountUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Account Id\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountResponse\"}}}}}},\"patch\":{\"tags\":[\"Customer Account\"],\"summary\":\"Update customer account status\",\"description\":\"Update Customer Account status\",\"operationId\":\"updatestatusbyid\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Account Id\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/accounts_accountUID_body\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_200\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/customers/{customerUID}/accounts/{accountUID}\":{\"get\":{\"tags\":[\"Customer Account - V3\"],\"summary\":\"Get customer account\",\"description\":\"This API endpoint is used to retrieve details of a specific customer account using the unique customer and account identifiers.\\nOptionally, you can include the current account balance in the response by passing `includeAccountBalance=true` as a query parameter.     \\n\",\"operationId\":\"getCustomerAccountByAccountUIDV3\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Unique identifier of the customer. \\nThis is a mandatory path parameter used to identify the customer whose account information is being retrieved.            \\n\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Unique identifier of the account associated with the specified customer. \\nThis is a mandatory path parameter and should correspond to the correct account under the provided customer UID.            \\n\",\"example\":\"101\"}},{\"name\":\"includeAccountBalance\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"boolean\",\"description\":\"Pass this as true if to pull in account balance as well, false otherwise\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_200_1\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse\"}}}},\"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/V3AccountBadResponse\"}}}}}},\"patch\":{\"tags\":[\"Customer Account - V3\"],\"summary\":\"Update customer account\",\"description\":\"Update a customer account\",\"operationId\":\"updateCustomerAccountV3\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"integer\",\"description\":\"Unique Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Unique identifier of the account associated with the specified customer. \\nThis is a mandatory path parameter and should correspond to the correct account under the provided customer UID.            \\n\",\"example\":\"101\"}}],\"requestBody\":{\"description\":\"Account Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3UpdateAccountRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse\"}}}},\"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/V3AccountBadResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/customers/{customerUID}/accounts\":{\"post\":{\"tags\":[\"Customer Account - V3\"],\"summary\":\"Create customer account\",\"description\":\"Create a customer account\",\"operationId\":\"createCustomerAccountV3\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"integer\",\"description\":\"Unique Customer Id\"}}],\"requestBody\":{\"description\":\"Account Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Created\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3CreateAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse\"}}}},\"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/V3AccountBadResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"}}}},\"/v3/customers/{customerUID}/accounts/search\":{\"post\":{\"tags\":[\"Customer Account - V3\"],\"summary\":\"Search Customer Accounts\",\"description\":\"Search the customer accounts for a given customer\",\"operationId\":\"searchCustomerAccountsV3\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier assigned by the system\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Which number of page of results to be returned and the default value is '1'\",\"example\":\"1\"}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":1000,\"type\":\"string\",\"description\":\"Total number of records to be returned for a given page and the default value is '10'\",\"example\":\"100\"}}],\"requestBody\":{\"description\":\"Account Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3SearchAccountRequest\"}}}},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3SearchAccountResponse\"}}}},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse\"}}}},\"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/V3AccountBadResponse\"}}}}}}},\"/v1/customers/{customerUID}/accounts/{accountUID}/sweeps/{direction}\":{\"get\":{\"tags\":[\"Customer Account Sweeps\"],\"summary\":\"Fetch sweep details for a customer account\",\"description\":\"Retrieves sweep configuration details for the specified account and direction (in, out, or both).\",\"operationId\":\"getCustomerAccountSweeps\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Account Id\"}},{\"name\":\"direction\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Sweep Direction\",\"enum\":[\"in\",\"out\",\"both\"]}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}},\"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/CreateAccountSweepsResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}},\"post\":{\"tags\":[\"Customer Account Sweeps\"],\"summary\":\"Create customer account sweep\",\"description\":\"Create a customer account sweep\",\"operationId\":\"createCustomerAccountSweep\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Account Id\"}},{\"name\":\"direction\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Sweep Direction\",\"enum\":[\"in\",\"out\",\"both\"]}}],\"requestBody\":{\"description\":\"Create Customer Account Sweeps Request Fields.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Created\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}},\"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/CreateAccountSweepsResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}}}},\"delete\":{\"tags\":[\"Customer Account Sweeps\"],\"summary\":\"Delete customer account sweeps\",\"description\":\"Delete Customer Account Sweeps\",\"operationId\":\"deleteCustomerAccountSweeps\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Account Id\"}},{\"name\":\"direction\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Sweep Direction\",\"enum\":[\"in\",\"out\",\"both\"]}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}},\"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/CreateAccountSweepsResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}},\"patch\":{\"tags\":[\"Customer Account Sweeps\"],\"summary\":\"Update customer account sweep\",\"description\":\"Update a customer account sweep\",\"operationId\":\"updateCustomerAccountSweep\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Customer Id\"}},{\"name\":\"accountUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"number\",\"description\":\"Unique Account Id\"}},{\"name\":\"direction\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Sweep Direction\",\"enum\":[\"in\",\"out\",\"both\"]}}],\"requestBody\":{\"description\":\"Update Customer Account Sweeps Request Fields.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateAccountSweepsRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\"},\"400\":{\"description\":\"Bad request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}},\"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/CreateAccountSweepsResponse\"}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateAccountSweepsResponse\"}}}}}}},\"/v1/customers/{customerId}/beneficiary\":{\"post\":{\"tags\":[\"Customer Contact\"],\"summary\":\"Create customer contact\",\"description\":\"Create a new customer contact (Beneficiary)\",\"operationId\":\"createbeneficiary\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Unique Customer Id\"}}],\"requestBody\":{\"description\":\"Contact Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerContactRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateCustomerContactResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateCustomerContactResponse\"}}}}}}},\"/v1/customers/{customerId}/beneficiary/{contactId}\":{\"patch\":{\"tags\":[\"Customer Contact\"],\"summary\":\"Update customer contact\",\"description\":\"Update customer contact details\",\"operationId\":\"updatebeneficiary\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique id in Finzly system.\"}},{\"name\":\"contactId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Contact unique id in Finzly system.\"}}],\"requestBody\":{\"description\":\"Contact Info\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomerContact\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateCustomerContactResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateCustomerContactResponse\"}}}}}}},\"/v2/customers/{customerUID}/contacts\":{\"get\":{\"tags\":[\"Customer Contact\"],\"summary\":\"Search customer contacts\",\"description\":\"Search customer contacts for a given customer\",\"operationId\":\"searchCustomerContacts\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"integer\",\"description\":\"Unique Customer Id\"}},{\"name\":\"contactName\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Contact name\"}},{\"name\":\"accountNumber\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Contact Account Number\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Which page of results are to be returned, page should be greater than zero.\"}},{\"name\":\"limit\",\"in\":\"query\",\"required\":true,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":100,\"type\":\"string\",\"description\":\"Specifies how many records are returned in the result set. The limit must be greater than zero. The maximum limit is configurable in the system; if it is not configured, the default maximum value is 100\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerContactResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerContactResponse\"}}}}}}},\"/v2/customers/{customerUID}/contacts/{contactUID}\":{\"get\":{\"tags\":[\"Customer Contact\"],\"summary\":\"Get customer contact\",\"description\":\"Retrieve customer contact details\",\"operationId\":\"getCustomerContactByUID\",\"parameters\":[{\"name\":\"customerUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique id in finzly system\"}},{\"name\":\"contactUID\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Contact unique id in finzly system\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerContactResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Successful\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerContactResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/users\":{\"post\":{\"tags\":[\"Customer User\"],\"summary\":\"Create new customer user.\",\"description\":\"To save customer user details in the system.\",\"operationId\":\"save\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Unique Identifier and which is associated with the token legal entity.\",\"example\":\"103\"}}],\"requestBody\":{\"description\":\"Create User Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerUserCreateRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerUserResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Save user details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerUserResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/users/{userId}\":{\"put\":{\"tags\":[\"Customer User\"],\"summary\":\"Update existing customer user.\",\"description\":\"To update existing customer user details in the system.\",\"operationId\":\"update\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer Unique Identifier and which is associated with the token legal entity.\",\"example\":\"103\"}},{\"name\":\"userId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer user unique Identifier. It should be associated with the requested legal entity.\"}}],\"requestBody\":{\"description\":\"Update User Request fields\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerUserUpdateRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomerUserResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Save user details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateCustomerUserResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/users/{userId}/suspend\":{\"put\":{\"tags\":[\"Customer User\"],\"summary\":\"Suspend customer user.\",\"description\":\"To update customer user status.\",\"operationId\":\"suspend\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity.\"}},{\"name\":\"userId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer user unique identifier. It should be associated with the requested legal entity.\"}}],\"responses\":{\"204\":{\"description\":\"The user status updated successfully.\"},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Update user status\"}}}},\"/api/user-management/v1/customers/{customerId}/users/{userId}/activate\":{\"put\":{\"tags\":[\"Customer User\"],\"summary\":\"Activate customer user.\",\"description\":\"To update customer user status.\",\"operationId\":\"activate\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity.\"}},{\"name\":\"userId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer user unique identifier. It should be associated with the requested legal entity.\"}}],\"responses\":{\"204\":{\"description\":\"The user status updated successfully.\"},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Update user status\"}}}},\"/api/user-management/v1/customer/{customerId}/users/{userId}\":{\"get\":{\"tags\":[\"Customer User\"],\"summary\":\"Get customer user.\",\"description\":\"Get customer user details in the system.\",\"operationId\":\"get-user\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity.\"}},{\"name\":\"userId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer user unique identifier. It should be associated with the requested legal entity.\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerUserResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Get user details by userId\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerUserResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/users/search\":{\"post\":{\"tags\":[\"Customer User\"],\"summary\":\"Search customer user.\",\"description\":\"Get customer user details in the system.\",\"operationId\":\"search-user\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity.\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page index. If page index is not provided then the default index i.e 1 will be applicable.\"}},{\"name\":\"size\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page size.If page size is not provided then the default index i.e 10 will be applicable.\"}}],\"requestBody\":{\"description\":\"Search criteria\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerUserRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerUserResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Get user details based upon search criteria\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerUserResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/roles/{roleId}\":{\"get\":{\"tags\":[\"Customer Role\"],\"summary\":\"Get customer role.\",\"description\":\"Get customer role details in the system.\",\"operationId\":\"get-role\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"description\":\"Customer unique identifier and which is associated with the token legal entity\",\"example\":12345}},{\"name\":\"roleId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Role Unique Identifier.\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerRoleResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Get role details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GetCustomerRoleResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/roles/search\":{\"get\":{\"tags\":[\"Customer Role\"],\"summary\":\"Search customer role.\",\"description\":\"Search customer role details in the system.\",\"operationId\":\"search-role\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity\"}},{\"name\":\"page\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page index. It is an optional attribute if it is not provided then the default value is 1.\",\"example\":1}},{\"name\":\"size\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"number\",\"description\":\"page size. It is an optional attribute if it is not provided then the default value is 10.\",\"example\":10}},{\"name\":\"roleName\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Role name.\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerRoleResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Get role details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SearchCustomerRoleResponse\"}}}}}}},\"/api/user-management/v1/customers/{customerId}/roles\":{\"post\":{\"tags\":[\"Customer Role\"],\"summary\":\"Create new customer role.\",\"description\":\"To save customer role details in the system.\",\"operationId\":\"save-role\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"description\":\"Customer unique identifier and which is associated with the token legal entity\"}}],\"requestBody\":{\"description\":\"Customer role fileds\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerRoleCreateRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerRoleResponse\"}}}},\"400\":{\"description\":\"Bad request\"},\"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\"},\"503\":{\"description\":\"Service unavailable\"},\"default\":{\"description\":\"Save user details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerRoleResponse\"}}}}}}},\"/v1/customers/{customerId}/limits\":{\"post\":{\"tags\":[\"Customer Limit\"],\"summary\":\"Customer transaction limits\",\"description\":\"Checks and returns the applicable per-transaction, daily, weekly, and monthly limits for the specified customer based on the requested payment amount, delivery date and payment rail.\\n\",\"operationId\":\"checkCustomerLimits\",\"parameters\":[{\"name\":\"customerId\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"number\",\"description\":\"Unique Customer Id\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/customerId_limits_body\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Successfully retrieved applicable transaction limits\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_200_2\"}}}},\"204\":{\"description\":\"No applicable limit data found for the given request.\"},\"400\":{\"description\":\"Bad request — invalid or missing input fields.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/V4StandardResponse\"}}}},\"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\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"/v1/customers/lookup/{accountNumber}\":{\"get\":{\"tags\":[\"Customer Lookup\"],\"summary\":\"Customer lookup\",\"description\":\"Checks and retreive customer lookup details based on the account type and account number.\\n\",\"operationId\":\"getCustomerLookUp\",\"parameters\":[{\"name\":\"accountNumber\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"pattern\":\"^[a-zA-Z0-9]+$\",\"type\":\"string\",\"description\":\"Customer account number\",\"example\":\"1234567890\"}},{\"name\":\"accountType\",\"in\":\"query\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"type\":\"string\",\"description\":\"Customer account type. This is an optional field.\\nIf not provided, the default behavior is to return results for all account types.\\n\",\"example\":\"LOAN\",\"enum\":[\"DEPOSIT\",\"LOAN\"]}}],\"responses\":{\"200\":{\"description\":\"Successfully retrieved applicable customer lookup details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse\"}}}},\"400\":{\"description\":\"Bad request — invalid or missing input fields.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_400_1\"}}}},\"401\":{\"description\":\"Unauthorized - You are not authorized to access the resource\\n\"},\"403\":{\"description\":\"Forbidden\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_403\"}}}},\"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\"},\"500\":{\"description\":\"Internal server error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/inline_response_500\"}}}},\"503\":{\"description\":\"Service Unavailable – The server is temporarily unavailable.                  \\n\"}}}},\"/v1/customers/{customerId}/signatories\":{\"get\":{\"tags\":[\"Customer Signatories\"],\"summary\":\"List signatories for a customer\",\"description\":\"Returns signatories for the customer. Supports paging and optional ordering (passed through to the\\nlegal-entity service).\\n\\n**Access and authorization**\\n\\n- Appropriate Open Banking access is required (e.g. `mCust` in the implementation).\\n- The caller's **partner identifier** must be present (`SIG_PARTNERID_REQUIRED` if missing).\\n- The **requested customer** must exist (`SIG_CUSTOMERNOTFOUND`) and be allowed for the caller's token\\n  (`SIG_CUSTOMERACCESS_DENIED`).\\n\\n**Validation**\\n\\n- Query parameters such as `page` and `size` must remain within supported ranges when provided; invalid\\n  path or query values can yield `SIG_VALIDATION_ERROR`.\\n\\nWhen no rows exist, HTTP **200** still returns with an empty `signatories` array and an empty-state message.\\n\",\"operationId\":\"listCustomerSignatories\",\"parameters\":[{\"name\":\"page\",\"in\":\"query\",\"description\":\"Zero-based page index.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":9999,\"minimum\":0,\"type\":\"integer\",\"default\":0}},{\"name\":\"size\",\"in\":\"query\",\"description\":\"Page size.\",\"required\":false,\"style\":\"form\",\"explode\":true,\"schema\":{\"maximum\":500,\"minimum\":1,\"type\":\"integer\",\"default\":10}}],\"responses\":{\"200\":{\"description\":\"List result (may be empty)\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ListSignatoriesResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/SignatoryBadRequest\"},\"401\":{\"$ref\":\"#/components/responses/OpenBankingUnauthorized\"},\"403\":{\"$ref\":\"#/components/responses/OpenBankingForbidden\"},\"500\":{\"$ref\":\"#/components/responses/SignatoryUnhandledServerError\"}}},\"post\":{\"tags\":[\"Customer Signatories\"],\"summary\":\"Create a signatory for a customer\",\"description\":\"Creates a new signatory for the given customer.\\n\\n**Access and authorization**\\n\\n- Appropriate Open Banking access is required (implementation uses permission `mCust`; HTTP status for\\n  unauthenticated or forbidden callers may depend on your API gateway).\\n- The caller's **partner identifier** must be present in the security context (`SIG_PARTNERID_REQUIRED` if missing).\\n- The service resolves the caller's legal entity from the token and verifies the **requested customer** is\\n  allowed for that caller (`SIG_CUSTOMERACCESS_DENIED` if not).\\n- If **no customer** exists for `customerId`, the request fails (`SIG_CUSTOMERNOTFOUND`).\\n\\n**Validation**\\n\\n- **fullName**, **emailAddress**, and **phoneNumber** are required; **title** and **approvalLimit** are optional.\\n- **Email:** must be a valid address format and must be **unique** where required by platform rules; duplicate\\n  or invalid submissions return a validation or business error with a message and code from the backend.\\n- **Phone:** must pass the legal-entity **validate-phone** check (`SIG_PHONE_INVALID`, or an integration\\n  failure code if the validator cannot be reached).\\n- **Approval limit:** when provided, must be non-negative and within the integer/fraction digit limits\\n  enforced by the API.\\n\\nReturns HTTP **201 Created** with the new signatory identifier and downstream status fields.\\n\",\"operationId\":\"createCustomerSignatory\",\"parameters\":[],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateSignatoryRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Signatory created\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CreateSignatorySuccessResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/SignatoryBadRequest\"},\"401\":{\"$ref\":\"#/components/responses/OpenBankingUnauthorized\"},\"403\":{\"$ref\":\"#/components/responses/OpenBankingForbidden\"},\"500\":{\"$ref\":\"#/components/responses/SignatoryUnhandledServerError\"}}}},\"/v1/customers/{customerId}/signatories/{signatoryId}\":{\"delete\":{\"tags\":[\"Customer Signatories\"],\"summary\":\"Delete a signatory for a customer\",\"description\":\"Deletes the signatory identified by `signatoryId` under the given customer.\\n\\n**Access and authorization**\\n\\n- Appropriate Open Banking access is required (e.g. `mCust` in the implementation).\\n- The caller's **partner identifier** must be present (`SIG_PARTNERID_REQUIRED` if missing).\\n- The **customer** must exist (`SIG_CUSTOMERNOTFOUND`) and be allowed for the caller's token\\n  (`SIG_CUSTOMERACCESS_DENIED`).\\n\\n**Validation**\\n\\n- No request body. Failures from missing signatory, downstream constraints, or integration issues are\\n  returned as errors with appropriate codes and messages.\\n\",\"operationId\":\"deleteCustomerSignatory\",\"parameters\":[],\"responses\":{\"200\":{\"description\":\"Delete accepted; body contains downstream status/message\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DeleteSignatorySuccessResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/SignatoryBadRequest\"},\"401\":{\"$ref\":\"#/components/responses/OpenBankingUnauthorized\"},\"403\":{\"$ref\":\"#/components/responses/OpenBankingForbidden\"},\"500\":{\"$ref\":\"#/components/responses/SignatoryUnhandledServerError\"}}},\"patch\":{\"tags\":[\"Customer Signatories\"],\"summary\":\"Partially update a signatory\",\"description\":\"**Merge** semantics: only non-null fields in the body override the latest downstream signatory state.\\n\\n**Access and authorization**\\n\\n- Appropriate Open Banking access is required (e.g. `mCust` in the implementation).\\n- The caller's **partner identifier** must be present (`SIG_PARTNERID_REQUIRED` if missing).\\n- The **customer** must exist (`SIG_CUSTOMERNOTFOUND`) and be allowed for the token (`SIG_CUSTOMERACCESS_DENIED`).\\n- The signatory must belong to the requested customer; otherwise the call fails (e.g. access denied or\\n  signatory not found, depending on downstream behavior).\\n\\n**Validation**\\n\\n- At least **one** body property must be present; an empty JSON object is rejected (`SIG_VALIDATION_ERROR`).\\n- **Email:** if `emailAddress` is sent, it must be a valid format and satisfy **uniqueness** rules where the\\n  platform applies them.\\n- **Phone:** after merge, the effective phone number is validated with **validate-phone** (`SIG_PHONE_INVALID`\\n  if invalid)—this applies even when the number was not changed in the patch but remains the current value.\\n- **Approval limit:** when provided, must be non-negative and within digit/scale limits.\\n\\nPhone is validated against the **merged** signatory state, not only newly sent fields.\\n\",\"operationId\":\"updateCustomerSignatory\",\"parameters\":[],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateSignatoryRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Signatory updated\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UpdateSignatorySuccessResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/SignatoryBadRequest\"},\"401\":{\"$ref\":\"#/components/responses/OpenBankingUnauthorized\"},\"403\":{\"$ref\":\"#/components/responses/OpenBankingForbidden\"},\"500\":{\"$ref\":\"#/components/responses/SignatoryUnhandledServerError\"}}}}},\"components\":{\"schemas\":{\"Error\":{\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Error code assigned by the system\",\"example\":\"invalidMethod\"},\"description\":{\"type\":\"string\",\"description\":\"Error description to provide additional details about the error code\",\"example\":\"Invalid HTTP method used\"}}},\"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\":{\"$ref\":\"#/components/schemas/PaymentNoteOptionValueChildren_data\"}}},\"UpdateCustomerContactIntermediaryBankAddress\":{\"properties\":{\"addressLine1\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address Line 2\",\"example\":\"Suite 210\"},\"addressLine3\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address Line 3\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"City\",\"example\":\"Charlotte\"},\"postalCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Postal code\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"ISO country code\",\"example\":\"USA\"},\"country\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Country name\",\"example\":\"UNITED STATES OF AMERICA\"}}},\"CustomerContactIntermediaryBankAddress\":{\"required\":[\"addressLine1\",\"city\",\"countryCode\",\"postalCode\"],\"properties\":{\"addressLine1\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address Line 2\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"City\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"State\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Postal code\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"ISO country code\",\"example\":\"US\"}}},\"CustomerAddress\":{\"required\":[\"addressLine1\",\"city\",\"postalCode\"],\"properties\":{\"addressLine1\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address Line 2\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"City\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"State\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Postal code\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"ISO country code, Default to US.\",\"example\":\"US\"}}},\"UpdateCustomerAddress\":{\"properties\":{\"addressLine1\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Address Line 2\",\"example\":\"Suite 210\"},\"city\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"City\",\"example\":\"Charlotte\"},\"state\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"State\",\"example\":\"North Carolina\"},\"postalCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Postal code\",\"example\":\"28269\"},\"countryCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"ISO country code. Defaults to US if not provided.\",\"example\":\"US\"}}},\"CustomerAppLimit\":{\"properties\":{\"appName\":{\"type\":\"string\",\"description\":\"A vailid application name which is present in the finzly system. e.g. Payment Galaxy, Confirms\",\"example\":\"Payment Galaxy\"},\"appLimits\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomerLimit\"}}}},\"CustomerLimit\":{\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"A valid appication limit code which is associated with the provided application name. e.g. | 1. Payment Galaxy FEDWIRE_PAYMENT_LIMIT_PER_FILE, FEDWIRE_PAYMENT_LIMIT_PER_DAY, FEDWIRE_PAYMENT_LIMIT_PER_MONTH, FEDWIRE_PAYMENT_LIMIT_PER_TRANSACTION, FEDWIRE_PAYMENT_LIMIT_PER_WEEK, INSTANT_PAYMENT_LIMIT_PER_DAY, INSTANT_PAYMENT_LIMIT_PER_FILE, INSTANT_PAYMENT_LIMIT_PER_MONTH, NO_OF_ACH_BATCHES_PER_FILE, INSTANT_PAYMENT_LIMIT_PER_TRANSACTION, INSTANT_PAYMENT_LIMIT_PER_WEEK, NO_OF_ACH_FILES_PER_DAY, NO_OF_ACH_FILES_PER_MONTH, SWIFT_PAYMENT_LIMIT_PER_MONTH, SWIFT_PAYMENT_LIMIT_PER_DAY, SWIFT_PAYMENT_LIMIT_PER_TRANSACTION, SWIFT_PAYMENT_LIMIT_PER_WEEK, ACH_PAYMENT_LIMIT_PER_TRANSACTION, ACH_POP_CREDIT_LIMIT_PER_BATCH, ACH_POP_CREDIT_TRANSACTION_LIMIT, ACH_POP_DEBIT_LIMIT_PER_BATCH, ACH_POP_DEBIT_TRANSACTION_LIMIT, ACH_PPD_CREDIT_LIMIT_PER_BATCH, ACH_PPD_CREDIT_TRANSACTION_LIMIT, ACH_PPD_DEBIT_LIMIT_PER_BATCH, ACH_PPD_DEBIT_TRANSACTION_LIMIT, ACH_WEB_CREDIT_LIMIT_PER_BATCH, ACH_WEB_CREDIT_TRANSACTION_LIMIT, ACH_WEB_DEBIT_LIMIT_PER_BATCH, ACH_WEB_DEBIT_TRANSACTION_LIMIT, ACH_WHITELIST_LIMIT 2. Confrms FX_FORWARD_LIMIT, FX_DAILY_SETTLEMENT_LIMIT\",\"example\":\"FEDWIRE_PAYMENT_LIMIT_PER_DAY\"},\"value\":{\"type\":\"string\",\"description\":\"The value should be non negative.\",\"example\":\"1000\"}}},\"CustomerAdditonalProfileDetails\":{\"properties\":{\"sso\":{\"type\":\"boolean\"},\"billingCustomer\":{\"type\":\"boolean\"},\"restrictedAccess\":{\"type\":\"boolean\"},\"achPositivePay\":{\"type\":\"boolean\",\"description\":\"Deprecated. Retained only for backward compatibility.\",\"default\":false},\"achWhitelist\":{\"type\":\"boolean\"},\"paymentFileAuthentication\":{\"type\":\"boolean\"},\"detailsOfCharge\":{\"type\":\"string\",\"example\":\"OUR\",\"enum\":[\"OUR\",\"BEN\",\"SHA\"]},\"fxPricingTier\":{\"maxLength\":255,\"type\":\"string\",\"example\":\"Finzly Test\"},\"creditValueAdjustment\":{\"maximum\":1,\"minimum\":0.0001,\"type\":\"string\",\"example\":\"0.00010\"}}},\"LegalEntityAccessSettings\":{\"properties\":{\"allowOnlineAccess\":{\"type\":\"boolean\"},\"userPinForNewEntry\":{\"type\":\"boolean\"},\"userDualApproval\":{\"type\":\"boolean\"},\"userPinForApproval\":{\"type\":\"boolean\"},\"notificationsDualApproval\":{\"type\":\"boolean\"},\"customerPinForNewEntry\":{\"type\":\"boolean\"},\"customerDualApproval\":{\"type\":\"boolean\"},\"customerPinForApproval\":{\"type\":\"boolean\"},\"benePinForNewEntry\":{\"type\":\"boolean\"},\"beneDualApproval\":{\"type\":\"boolean\"},\"benePinForApproval\":{\"type\":\"boolean\"},\"paymentPinForNewEntry\":{\"type\":\"boolean\"},\"paymentLimitforFirstApprover\":{\"maximum\":999999999.99,\"minimum\":0,\"type\":\"number\",\"description\":\"Payment limit for the first approver. Must be a positive value between 0 and 999,999,999.99.\",\"format\":\"double\",\"example\":5000000},\"paymentDualApproval\":{\"type\":\"boolean\"},\"paymentLimitforSecondApprover\":{\"maximum\":999999999.99,\"minimum\":0,\"type\":\"number\",\"description\":\"Payment limit for the second approver. Must be a positive value between 0 and 999,999,999.99.\",\"format\":\"double\",\"example\":5000000},\"paymentNumberOfApprovers\":{\"type\":\"number\",\"enum\":[0,1,2]},\"paymentPinForApproval\":{\"type\":\"boolean\"},\"feeTierForApproval\":{\"type\":\"boolean\"}}},\"CreateUpdateCustomerResponse\":{\"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\",\"example\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"This will be the detailed error message indicating what failed and how to fix the issue\",\"example\":\"Failed to create a customer due to the mandatory attribute <attribute-name> is not provide.\"},\"data\":{\"$ref\":\"#/components/schemas/CreateUpdateCustomerResponse_data\"}}},\"CreateCustomerRequest\":{\"required\":[\"customerType\",\"legalAddress\",\"legalName\",\"shortName\",\"taxId\"],\"properties\":{\"legalName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's legal name\",\"example\":\"ABC Bank\"},\"shortName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's short name. Must be unique across all customers.\",\"example\":\"BOFA\"},\"customerId\":{\"type\":\"string\",\"description\":\"Customer Id, this is an optional field and if it is provided then it is unique.\",\"example\":\"CUST123\"},\"customerType\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"Type of customer\",\"example\":\"Corporate\",\"enum\":[\"Corporate\",\"Consumer\",\"Financial Institution\",\"Downstream Partner\",\"Processing Org\"]},\"taxId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"Tax ID\",\"example\":\"123456789\"},\"lei\":{\"maxLength\":20,\"pattern\":\"^[A-Z0-9]{4}00[A-Z0-9]{12}[0-9]{2}$\",\"type\":\"string\",\"description\":\"Legal Entity Identifier (LEI) used for accounting and tax purposes. \\nThis field is optional but must be unique across all customers if provided. \\nThe value must follow the ISO 17442 standard: a 20-character alphanumeric format. \\n\",\"example\":\"5493001KJTIIGC8Y1R12\"},\"swiftCode\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"SWIFT code\",\"example\":\"BOFAUS3N\"},\"language\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Supported language. Defaults to English if not provided.\",\"example\":\"English\",\"enum\":[\"English\",\"Spanish\"]},\"emailAddress\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer Email Address\",\"example\":\"abc@abc.com\"},\"phoneNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's Phone number\",\"example\":\"123-124-9877\"},\"faxNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's phone number\",\"example\":\"123-124-9877\"},\"webSite\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's website\",\"example\":\"http://www.finzly.com\"},\"logoUrl\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's logo url\",\"example\":\"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png\"},\"linkedinUrl\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's LinkedIn profile URL\",\"example\":\"https://www.linkedin.com/company/finzly\"},\"twitterUrl\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Customer's twitter url\",\"example\":\"https://twitter.com/finzly\"},\"legalAddress\":{\"$ref\":\"#/components/schemas/CustomerAddress\"},\"mailAddressSameAsLegal\":{\"type\":\"boolean\",\"description\":\"Indicates whether the mailing address is the same as the legal address. Defaults to true.\"},\"mailingAddress\":{\"$ref\":\"#/components/schemas/CustomerAddress\"},\"relationshipType\":{\"type\":\"string\",\"description\":\"Optional field. This will be auto-populated based on the customer type.\",\"example\":\"Customer\",\"enum\":[\"customer\",\"bank\",\"thirdparty\",\"self\"]},\"partnerOrgShortName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"This is shortname of the partner org. This is required if the relationshipType is Third Party optional otherwise.\",\"example\":\"ABC\"},\"costCenter\":{\"maxLength\":20,\"type\":\"string\",\"description\":\"Cost Center code is an optional field. If it is not provided, the default cost center will be taken from the relation.\",\"example\":\"123123121\"},\"relationshipManager\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Relationship manager login ID. Must be a valid user login ID in the system. Optional when `partnerOrgShortName` is provided.\",\"example\":\"testuser\"},\"originatingOfficer\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Originating officer login ID. Must be a valid user login ID in the system. Optional when `partnerOrgShortName` is provided.\",\"example\":\"testuser\"},\"parentEntityShortName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"This is shortname of the parent org\",\"example\":\"ParentEntity\"},\"additionalProfileDetails\":{\"$ref\":\"#/components/schemas/CustomerAdditonalProfileDetails\"},\"note\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"notes\",\"example\":\"Note for the LE\"},\"legalEntityAccessSettings\":{\"$ref\":\"#/components/schemas/LegalEntityAccessSettings\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of additional customer attributes configured in the system.\",\"items\":{\"$ref\":\"#/components/schemas/AdditionalAttribute\"}}}},\"UpdateCustomerRequest\":{\"properties\":{\"legalName\":{\"type\":\"string\",\"description\":\"Customer's legal name\",\"example\":\"ABC Bank\"},\"customerId\":{\"type\":\"string\",\"description\":\"Customer Id assigned by the user.\",\"example\":\"CUST123\"},\"customerType\":{\"type\":\"string\",\"description\":\"Type of customer\",\"example\":\"Corporate\",\"enum\":[\"Corporate\",\"Consumer\",\"Financial Institution\",\"Downstream Partner\",\"Processing Org\"]},\"taxId\":{\"type\":\"string\",\"description\":\"Tax ID / TIN/SSN\",\"example\":\"123456789\"},\"lei\":{\"pattern\":\"^[A-Z0-9]{4}00[A-Z0-9]{12}[0-9]{2}$\",\"type\":\"string\",\"description\":\"Legal Entity Identifier (LEI) used for accounting and tax purposes.\\nIt must be unique across all customers.\\nThe value must follow the ISO 17442 standard: a 20-character alphanumeric format.\\n\",\"example\":\"5493001KJTIIGC8Y1R12\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"SWIFT code\",\"example\":\"BOFAUS3N\"},\"language\":{\"type\":\"string\",\"description\":\"Suported language\",\"example\":\"English\"},\"emailAddress\":{\"type\":\"string\",\"description\":\"Customer Email Address\",\"example\":\"abc@abc.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Customer's Phone number\",\"example\":\"123-124-9877\"},\"faxNumber\":{\"type\":\"string\",\"description\":\"Customer's phone number\",\"example\":\"123-124-9877\"},\"webSite\":{\"type\":\"string\",\"description\":\"Customer's website\",\"example\":\"http://www.finzly.com\"},\"logoUrl\":{\"type\":\"string\",\"description\":\"Customer's logo url\",\"example\":\"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png\"},\"linkedinUrl\":{\"type\":\"string\",\"description\":\"Customer's LinkedIn profile URL\",\"example\":\"https://www.linkedin.com/company/finzly\"},\"twitterUrl\":{\"type\":\"string\",\"description\":\"Customer's twitter url\",\"example\":\"https://twitter.com/finzly\"},\"legalAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"mailAddressSameAsLegal\":{\"type\":\"boolean\"},\"mailingAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"relationshipType\":{\"type\":\"string\",\"description\":\"Optional field. This will be auto-populated based on the customer type.\",\"example\":\"Customer\",\"enum\":[\"customer\",\"bank\",\"thirdparty\",\"self\"]},\"partnerOrgShortName\":{\"type\":\"string\",\"description\":\"This is shortname of the partner org. This is required if the relationshipType is Third Party optional otherwise\",\"example\":\"ABC\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost Center code is an optional field. If it is not provided, the default cost center will be taken from the relation.\",\"example\":\"123123121\"},\"relationshipManager\":{\"type\":\"string\",\"description\":\"Relationship manager name. It needs to be a valid user login id in the system\",\"example\":\"testuser\"},\"originatingOfficer\":{\"type\":\"string\",\"description\":\"Originating Officer name. Its needs to be a valid user login id in the system\",\"example\":\"testuser\"},\"parentEntityShortName\":{\"type\":\"string\",\"description\":\"This is shortname of the parent org\",\"example\":\"ParentEntity\"},\"additionalProfileDetails\":{\"$ref\":\"#/components/schemas/CustomerAdditonalProfileDetails\"},\"note\":{\"type\":\"string\"},\"legalEntityAccessSettings\":{\"$ref\":\"#/components/schemas/LegalEntityAccessSettings\"},\"limits\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomerAppLimit\"}}}},\"AddCustomerFeeTierRequest\":{\"required\":[\"application\",\"feeName\",\"feeTier\",\"product\"],\"properties\":{\"application\":{\"type\":\"string\",\"description\":\"A valid application name should be present in the Finzly system  and enabled for fees.\\ne.g. Confirms, FX FrontOffice, Deposit, Teller, FX Trader, Foreign Exchange, Payment Galaxy, etc...\",\"example\":\"Payment Galaxy\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"A valid account number should be present in the Finzly system and associated with the respective Legal Entity (LE).\",\"example\":\"32265656\"},\"feeTier\":{\"type\":\"string\",\"description\":\"A valid fee tier must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"Gold\"},\"feeName\":{\"type\":\"string\",\"description\":\"A valid fee name must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"TN\"},\"product\":{\"type\":\"string\",\"description\":\"A valid product must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"Outgoing Payment\"}}},\"UpdateCustomerFeeTierRequest\":{\"properties\":{\"application\":{\"type\":\"string\",\"description\":\"A valid application name should be present in the Finzly system  and enabled for fees.\\ne.g. Confirms, FX FrontOffice, Deposit, Teller, FX Trader, Foreign Exchange, Payment Galaxy, etc...\",\"example\":\"Payment Galaxy\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"A valid account number should be present in the Finzly system and associated with the respective Legal Entity (LE).\",\"example\":\"32265656\"},\"feeTier\":{\"type\":\"string\",\"description\":\"A valid fee tier must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"Gold\"},\"feeName\":{\"type\":\"string\",\"description\":\"A valid fee name must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"TN\"},\"product\":{\"type\":\"string\",\"description\":\"A valid product must be available in the Finzly system. Please reach out to the bank support team for the correct value.\",\"example\":\"Outgoing Payment\"}}},\"FeeAddAndUpdateResponse\":{\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"Customer fee tier id.\",\"example\":889}}},\"UpdateCustomersResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get the customer: <Reason>\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/GetCustomerDetailResponse\"}}}},\"GetCustomersResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get the customer: <Reason>\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/GetCustomerDetailResponse\"}}}},\"SearchCustomersResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get the customer: <Reason>\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SearchCustomerDetailResponse\"}}}},\"SearchCustomerDetailResponse\":{\"properties\":{\"legalName\":{\"type\":\"string\",\"description\":\"Customer's legal name\",\"example\":\"DEMO Bank\"},\"shortName\":{\"type\":\"string\",\"description\":\"Customer's short name\",\"example\":\"DMOB\"},\"customerUID\":{\"type\":\"number\",\"description\":\"The unique identifier associated with the customer record assigned by the Finzly system.\",\"example\":111222},\"customerType\":{\"type\":\"string\",\"description\":\"Type of the customers in the Finzly CRM system\",\"example\":\"Consumer or Corporate or Downstream Partner or Processing Org or Financial Institution\",\"enum\":[\"Consumer\",\"Corporate\",\"Financial Institution\",\"Downstream Partner\",\"Processing Org\"]},\"taxId\":{\"type\":\"string\",\"description\":\"A tax id that the US government uses to identify business entities located in the US number.\",\"example\":\"123456789\"},\"customerId\":{\"type\":\"string\",\"description\":\"Customer id assigned by the user.\",\"example\":\"12347890\"},\"status\":{\"type\":\"string\",\"description\":\"Current status of the customer.\",\"example\":\"Active\"},\"lei\":{\"type\":\"string\",\"description\":\"Legal Entity Identifier (LEI) associated with the customer, used for accounting and tax purposes.\",\"example\":\"5493001KJTIIGC8Y1R12\"},\"swiftcode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch\",\"example\":\"BOFAUS3N\"},\"language\":{\"type\":\"string\",\"description\":\"language\",\"example\":\"English\"},\"emailAddress\":{\"type\":\"string\",\"description\":\"Customer email address\",\"example\":\"abc@bank.com\"},\"faxNumber\":{\"type\":\"string\",\"description\":\"Customer fax number\",\"example\":\"1231249877\"},\"website\":{\"type\":\"string\",\"description\":\"Customer website url address\",\"example\":\"http://www.bank.com\"},\"logoUrl\":{\"type\":\"string\",\"description\":\"Customer logo url\",\"example\":\"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png\"},\"twitterUrl\":{\"type\":\"string\",\"description\":\"Customer twitter url\",\"example\":\"https://twitter.com/bank\"},\"legalAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"mailAddressSameAsLegal\":{\"type\":\"boolean\"},\"mailingAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"relationshipType\":{\"type\":\"string\",\"description\":\"Relationship Type\",\"example\":\"Customer or Bank or ThirdParty or Self\",\"enum\":[\"customer\",\"bank\",\"thirdparty\",\"self\"]},\"partnerOrgShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the customer defined in the CRM system as 'Downstream Partner'. This is required only if the customer relationshipType is Third party\",\"example\":\"TESTBANK\"},\"processingOrgShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the processing org the customer is associated with.\",\"example\":\"POBANK\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity\",\"example\":\"123123121\"},\"relationshipManager\":{\"type\":\"string\",\"description\":\"Relationship manager name. It needs to be a valid user login id in the finzly system.\",\"example\":\"testuser\"},\"originatingOfficer\":{\"type\":\"string\",\"description\":\"Originating Officer name. Its needs to be a valid user login id in the finzly system.\",\"example\":\"testuser\"},\"parentEntityShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the existing customer legal entity act as a parent entity\",\"example\":\"TESTBANK\"},\"additionalProfileDetails\":{\"$ref\":\"#/components/schemas/CustomerAdditonalProfileDetails\"},\"note\":{\"type\":\"string\",\"description\":\"Free form text to leave any notes for the csutomer entity.\",\"example\":\"Notes for the customer\"}}},\"GetCustomerDetailResponse\":{\"properties\":{\"legalName\":{\"type\":\"string\",\"description\":\"Customer's legal name\",\"example\":\"DEMO Bank\"},\"shortName\":{\"type\":\"string\",\"description\":\"Customer's short name\",\"example\":\"DMOB\"},\"customerUID\":{\"type\":\"number\",\"description\":\"The unique identifier associated with the customer record assigned by the Finzly system.\",\"example\":111222},\"customerType\":{\"type\":\"string\",\"description\":\"Type of the customers in the Finzly CRM system\",\"example\":\"Consumer or Corporate or Downstream Partner or Processing Org or Financial Institution\",\"enum\":[\"Consumer\",\"Corporate\",\"Financial Institution\",\"Downstream Partner\",\"Processing Org\"]},\"taxId\":{\"type\":\"string\",\"description\":\"A tax id that the US government uses to identify business entities located in the US number.\",\"example\":\"123456789\"},\"customerId\":{\"type\":\"string\",\"description\":\"Customer id assigned by the user.\",\"example\":\"12347890\"},\"status\":{\"type\":\"string\",\"description\":\"Current status of the customer.\",\"example\":\"Active\"},\"lei\":{\"type\":\"string\",\"description\":\"Legal Entity Identifier (LEI) associated with the customer, used for accounting and tax purposes.\",\"example\":\"5493001KJTIIGC8Y1R12\"},\"swiftcode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch\",\"example\":\"BOFAUS3N\"},\"language\":{\"type\":\"string\",\"description\":\"language\",\"example\":\"English\"},\"emailAddress\":{\"type\":\"string\",\"description\":\"Customer email address\",\"example\":\"abc@bank.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Customer phone number\",\"example\":\"1112223333\"},\"faxNumber\":{\"type\":\"string\",\"description\":\"Customer fax number\",\"example\":\"1231249877\"},\"website\":{\"type\":\"string\",\"description\":\"Customer website url address\",\"example\":\"http://www.bank.com\"},\"logoUrl\":{\"type\":\"string\",\"description\":\"Customer logo url\",\"example\":\"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png\"},\"linkedinUrl\":{\"type\":\"string\",\"description\":\"Company linkedin URL\",\"example\":\"https://www.linkedin.com/company/finzly\"},\"twitterUrl\":{\"type\":\"string\",\"description\":\"Customer twitter url\",\"example\":\"https://twitter.com/bank\"},\"legalAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"mailAddressSameAsLegal\":{\"type\":\"boolean\"},\"mailingAddress\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"relationshipType\":{\"type\":\"string\",\"description\":\"Relationship Type\",\"example\":\"Customer or Bank or ThirdParty or Self\",\"enum\":[\"customer\",\"bank\",\"thirdparty\",\"self\"]},\"partnerOrgShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the customer defined in the CRM system as 'Downstream Partner'. This is required only if the customer relationshipType is Third party\",\"example\":\"TESTBANK\"},\"processingOrgShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the processing org the customer is associated with.\",\"example\":\"POBANK\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity\",\"example\":\"123123121\"},\"relationshipManager\":{\"type\":\"string\",\"description\":\"Relationship manager name. It needs to be a valid user login id in the finzly system.\",\"example\":\"testuser\"},\"originatingOfficer\":{\"type\":\"string\",\"description\":\"Originating Officer name. Its needs to be a valid user login id in the finzly system.\",\"example\":\"testuser\"},\"parentEntityShortName\":{\"type\":\"string\",\"description\":\"This is the shortname associated with the existing customer legal entity act as a parent entity\",\"example\":\"TESTBANK\"},\"additionalProfileDetails\":{\"$ref\":\"#/components/schemas/CustomerAdditonalProfileDetails\"},\"note\":{\"type\":\"string\",\"description\":\"Free form text to leave any notes for the csutomer entity.\",\"example\":\"Notes for the customer\"},\"legalEntityOriginatingOfficer\":{\"type\":\"string\",\"example\":\"user1\"},\"legalEntityRelationshipManager\":{\"type\":\"string\",\"example\":\"user1\"},\"legalEntityAccessSettings\":{\"$ref\":\"#/components/schemas/LegalEntityAccessSettings\"},\"feeTier\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/feeTier\"}},\"legalEntityLimits\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/legalEntityLimits\"}},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of additional customer attributes configured in the system.\",\"items\":{\"$ref\":\"#/components/schemas/GetCustomerDetailResponse_additionalAttributes\"}}}},\"feeTier\":{\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Application feeTier unique id which is associated with customer.\",\"example\":\"3616\"},\"application\":{\"type\":\"string\",\"description\":\"An application name which is associated with customer and feeTier. e.g. Payment Galaxy, Confirms\",\"example\":\"Confirms\"},\"feeTier\":{\"type\":\"string\",\"description\":\"Fee tier name.\",\"example\":\"Gold\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"Customer bank account number which is accosiated with customer and the fee tier.\",\"example\":\"40000023\"},\"product\":{\"type\":\"string\",\"description\":\"Product that is configured for the fee in the fee system\",\"example\":\"Outgoing Payment\"},\"feeName\":{\"type\":\"string\",\"description\":\"Name of the fee configured in the fee system\",\"example\":\"SPOT\"}}},\"legalEntityLimits\":{\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"Application limit code which is associated customer.\",\"example\":\"ACH_CCD_DEBIT_LIMIT_PER_BATCH\"},\"value\":{\"type\":\"string\",\"description\":\"Application level limit which is associated customer.\",\"example\":\"21\"},\"applicationName\":{\"type\":\"string\",\"description\":\"An application name which is associated with customer. e.g. Payment Galaxy, Confirms\",\"example\":\"Payment Galaxy\"}}},\"UpdateAccountRequest\":{\"properties\":{\"accountType\":{\"type\":\"string\",\"description\":\"Type of account\",\"example\":\"Loan\",\"enum\":[\"Deposit\",\"Loan\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Sub account type\",\"example\":\"Savings\",\"enum\":[\"Checking\",\"Savings\",\"Health Savings Account\",\"CD\",\"MoneyMarket    (Deprecated, use Money Market)\",\"LineofCredit  (Deprecated, use Line of Credit)\",\"Money Market\",\"Pseudo\",\"Credit Card\",\"Heloc\",\"Line of Credit\"]},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"System of records.\",\"example\":\"External\",\"enum\":[\"Other Core\",\"External\",\"Finzly Core\"]},\"accountNumber\":{\"type\":\"string\",\"description\":\"Bank account number. This an unique value in the finzly db.\",\"example\":\"95659895\"},\"currency\":{\"type\":\"string\",\"description\":\"Currency of the account\",\"example\":\"USD\"},\"accountName\":{\"type\":\"string\",\"description\":\"Bank account name.\",\"example\":\"xyz\"},\"masterGl\":{\"type\":\"string\",\"description\":\"Master GL number.\"},\"enableOffset\":{\"type\":\"string\",\"description\":\"Enable offset account\",\"example\":\"Yes\",\"enum\":[\"Yes\",\"No\"]},\"enableWire\":{\"type\":\"string\",\"description\":\"Enable or Disable for the wire transaction\",\"example\":\"Yes\",\"enum\":[\"Yes\",\"No\"]},\"defaultOffset\":{\"type\":\"string\",\"description\":\"Indicates whether the account is the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'.\\n\",\"example\":\"Yes\",\"enum\":[\"Yes\",\"No\"]},\"feeAccount\":{\"type\":\"string\",\"description\":\"Whether the accountNumber is a Fee account\",\"example\":\"Yes\",\"enum\":[\"Yes\",\"No\"]},\"returnAccount\":{\"type\":\"string\",\"description\":\"Whether the accountNumber is a Return account\",\"example\":\"Yes\",\"enum\":[\"Yes\",\"No\"]},\"fboAccountNumber\":{\"type\":\"string\",\"description\":\"The fbo account number should be associated with legal entity.\",\"example\":\"1122344\"},\"countryCode\":{\"type\":\"string\",\"description\":\"ISO country code\",\"example\":\"US\"},\"routingNumber\":{\"type\":\"string\",\"description\":\"Valid routing number/bankId\",\"example\":\"101206101\"},\"bankIdType\":{\"type\":\"string\",\"description\":\"Bank identifier type\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Enable call backs. It is an optional field. The Possible values are true/false.\",\"example\":false},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Call back limit.\",\"example\":1000},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity\",\"example\":\"5235666\"},\"isUnderWritten\":{\"type\":\"boolean\",\"description\":\"To allow UnderWritten for the account. It is an optional field. The Possible values are true/false.\",\"example\":false},\"isAchPrefund\":{\"type\":\"boolean\",\"description\":\"ACH Prefunding is a practice that ensures the account has sufficient funds for ACH Credit payments. It is an optional field. The Possible values are true/false.\",\"example\":false},\"debitExposureLimit\":{\"minimum\":0,\"type\":\"number\",\"description\":\"Maximum allowed amount for debit transfers for prefunded ACH accounts. Must be a positive value.\",\"format\":\"double\",\"example\":1000},\"creditExposureLimit\":{\"minimum\":0,\"type\":\"number\",\"description\":\"Maximum allowed amount for credit transfers for prefunded ACH accounts. Must be a positive value.\",\"format\":\"double\",\"example\":5000},\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Account analysis status.\",\"example\":false},\"secCodes\":{\"type\":\"array\",\"description\":\"Provide all valid SEC-Standard Entry Class codes allowed for the given customer entity. e.g. WEB,CCD,PPD,TEL,IAT, etc..\",\"items\":{\"maxLength\":100,\"type\":\"string\",\"example\":\"WEB\"}},\"achCompanyId\":{\"maxLength\":10,\"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\"},\"accountFeatures\":{\"$ref\":\"#/components/schemas/AccountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"An optional list of additional account attributes.\",\"items\":{\"$ref\":\"#/components/schemas/AdditionalAttribute\"}}}},\"UpdateAccountResponse\":{\"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\":\"ACC001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to update an account: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/UpdateAccountResponse_data\"}}},\"CreateAccountRequest\":{\"required\":[\"accountName\",\"accountNumber\",\"accountSubType\",\"accountType\",\"currency\",\"masterGl\",\"routingNumber\",\"systemOfRecords\"],\"properties\":{\"accountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name for the account. Only letters, numbers, and spaces are allowed.\",\"example\":\"xyz 123\"},\"accountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"User bank account number.\",\"example\":\"2136565\"},\"accountType\":{\"maxLength\":45,\"type\":\"string\",\"description\":\"Bank account type.\",\"enum\":[\"Deposit\",\"Loan\"]},\"accountSubType\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Bank account sub type.\",\"enum\":[\"Checking\",\"Savings\",\"Health Savings Account\",\"CD\",\"Money Market\",\"Pseudo\",\"Credit Card\",\"Heloc\",\"Line of Credit\",\"MoneyMarket  (Deprecated, use Money Market)\",\"LineofCredit (Deprecated, use Line of Credit)\"]},\"currency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Account currency. Currency Code is ISO format.\",\"example\":\"USD\"},\"countryCode\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ISO country code. The default value is set to US.\",\"example\":\"US\"},\"costCenter\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity\",\"example\":\"5235666\"},\"enableOffset\":{\"type\":\"string\",\"description\":\"Enable offset account. Possible values are 'Yes','No'.\",\"example\":\"Yes\"},\"enableWire\":{\"type\":\"string\",\"description\":\"Enable or Disable for the wire transaction. The default value is 'Yes' Possible values are 'Yes','No'\",\"example\":\"Yes\"},\"defaultOffset\":{\"type\":\"string\",\"description\":\"Indicates whether the account is the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'.\\n\",\"example\":\"Yes\"},\"feeAccount\":{\"type\":\"string\",\"description\":\"Whether the accountNumber is a Fee account. Possible values are 'Yes','No'\",\"example\":\"Yes\"},\"returnAccount\":{\"type\":\"string\",\"description\":\"Whether the accountNumber is a Return account. Possible values are 'Yes','No'\",\"example\":\"Yes\"},\"fboAccountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"The fbo account number should be associated with legal entity.\"},\"systemOfRecords\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"System of records.\",\"enum\":[\"Other Core\",\"External\"]},\"routingNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Valid routing number/bankId\",\"example\":\"101206101\"},\"masterGl\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Master gl.\",\"example\":\"9898965\"},\"reason\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Note\",\"example\":\"Notes\"},\"isUnderWritten\":{\"type\":\"boolean\",\"description\":\"To allow UnderWritten for the account. It is an optional field. The Possible values are true/false.\",\"example\":false},\"isAchPrefund\":{\"type\":\"boolean\",\"description\":\"ACH Prefunding is a practice that ensures the account has sufficient funds for ACH Credit payments. It is an optional field. The Possible values are true/false.\",\"example\":false},\"debitExposureLimit\":{\"minimum\":0,\"type\":\"number\",\"description\":\"Maximum allowed amount for debit transfers for prefunded ACH accounts. Must be a positive value.\",\"format\":\"double\",\"example\":1000},\"creditExposureLimit\":{\"minimum\":0,\"type\":\"number\",\"description\":\"Maximum allowed amount for credit transfers for prefunded ACH accounts. Must be a positive value.\",\"format\":\"double\",\"example\":5000},\"bankIdType\":{\"maxLength\":50,\"type\":\"string\",\"description\":\"Bank identifier type\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Account analysis. It is an optional field. The Possible values are true/false.\",\"example\":false},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Call back limit.\",\"format\":\"double\",\"example\":1000},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Enable call backs. It is an optional field. The Possible values are true/false.\",\"example\":false},\"secCodes\":{\"type\":\"array\",\"description\":\"Provide all valid SEC-Standard Entry Class codes allowed for the given customer entity. e.g. WEB,CCD,PPD,TEL,IAT, etc..\",\"items\":{\"maxLength\":100,\"type\":\"string\",\"example\":\"WEB\"}},\"achCompanyId\":{\"maxLength\":10,\"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”).\\n\",\"example\":\"1234567899\"},\"accountFeatures\":{\"$ref\":\"#/components/schemas/AccountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"An optional list of additional account attributes.\",\"items\":{\"$ref\":\"#/components/schemas/AdditionalAttribute\"}}}},\"V3CreateAccountRequest\":{\"required\":[\"accountName\",\"accountNumber\",\"accountSubType\",\"accountType\",\"countryCode\",\"currency\",\"masterGl\",\"routingNumber\",\"systemOfRecords\"],\"type\":\"object\",\"properties\":{\"accountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name for the account. Only letters, numbers, and spaces are allowed.\",\"example\":\"xyz 123\"},\"accountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"User bank account number.\",\"example\":\"2136565\"},\"accountType\":{\"type\":\"string\",\"description\":\"Bank account type.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"Loan\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Bank account sub type.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"Health Savings Account\",\"CD\",\"Money Market\",\"Pseudo\",\"Credit Card\",\"Heloc\",\"Line of Credit\",\"MoneyMarket\",\"LineofCredit\"]},\"currency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Account currency. Currency Code is ISO format.\",\"example\":\"USD\"},\"countryCode\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ISO country code.\",\"example\":\"US\"},\"costCenter\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity.\",\"example\":\"5235666\"},\"fboAccountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"The For-Benefit-Of (FBO) account number associated with a legal entity.\\nThis field is required when the accountSubType is set to \\\"Pseudo\\\".          \\n\"},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"System of records where the account is maintained.\",\"example\":\"Other Core\",\"enum\":[\"Other Core\",\"External\"]},\"routingNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Valid routing number / bankId.\",\"example\":\"101206101\"},\"masterGl\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Master GL number for accounting purposes.\",\"example\":\"9898965\"},\"reason\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Optional note or reason for account creation.\",\"example\":\"Notes\"},\"bankIdType\":{\"type\":\"string\",\"description\":\"Type of bank identifier.\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"accountFeatures\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of additional key-value attributes configured for the account.\",\"items\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_additionalAttributes\"}}}},\"V3CreateAccountResponse\":{\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Code associated with the error.\",\"example\":\"SUCCESS\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Bank account created successfully\"},\"data\":{\"$ref\":\"#/components/schemas/CreateAccountResponse_data\"}}},\"V3UpdateAccountRequest\":{\"type\":\"object\",\"properties\":{\"accountName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Name for the account. Only letters, numbers, and spaces are allowed.\",\"example\":\"xyz 123\"},\"accountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"User bank account number.\",\"example\":\"2136565\"},\"accountType\":{\"type\":\"string\",\"description\":\"Bank account type.\",\"example\":\"Deposit\",\"enum\":[\"Deposit\",\"Loan\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Bank account sub type.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"Health Savings Account\",\"CD\",\"Money Market\",\"Pseudo\",\"Credit Card\",\"Heloc\",\"Line of Credit\",\"MoneyMarket\",\"LineofCredit\"]},\"currency\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"Account currency. Currency Code is ISO format.\",\"example\":\"USD\"},\"countryCode\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ISO country code.\",\"example\":\"US\"},\"costCenter\":{\"maxLength\":25,\"type\":\"string\",\"description\":\"Cost Center associated with the customer entity.\",\"example\":\"5235666\"},\"fboAccountNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"The For-Benefit-Of (FBO) account number associated with a legal entity.\\nThis field is required when the accountSubType is set to \\\"Pseudo\\\".          \\n\"},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"System of records where the account is maintained.\",\"example\":\"Other Core\",\"enum\":[\"Other Core\",\"External\"]},\"routingNumber\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Valid routing number / bankId.\",\"example\":\"101206101\"},\"masterGl\":{\"maxLength\":100,\"type\":\"string\",\"description\":\"Master GL number for accounting purposes.\",\"example\":\"9898965\"},\"reason\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Optional note or reason for account creation.\",\"example\":\"Notes\"},\"bankIdType\":{\"type\":\"string\",\"description\":\"Type of bank identifier.\",\"example\":\"NID\",\"enum\":[\"NID\",\"BIC\"]},\"accountFeatures\":{\"$ref\":\"#/components/schemas/V3UpdateAccountRequest_accountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of additional key-value attributes configured for the account.\",\"items\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_additionalAttributes\"}}}},\"AccountFeatures\":{\"properties\":{\"rfpReceive\":{\"type\":\"boolean\",\"description\":\"Is receiving a Request for Pay permitted from the account? This is an optional field, and the possible values are true or false.\",\"example\":true},\"rfpSend\":{\"type\":\"boolean\",\"description\":\"Is sending a Request for Pay permitted from the account? This is an optional field, with possible values being true or false.\",\"example\":true}}},\"CreateAccountResponse\":{\"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\":\"ACC001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to create an account: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/CreateAccountResponse_data\"}}},\"SearchAccountResponse\":{\"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\":\"ACC001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get an account: <Reason>\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SearchCustomerBankAccount\"}}}},\"GetAccountResponse\":{\"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\":\"ACC001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get an account: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/CustomerBankAccount\"}}},\"V3GetAccountResponse\":{\"type\":\"object\",\"properties\":{\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account (e.g., Deposit or Loan)\",\"example\":\"Deposit\"},\"accountSubType\":{\"type\":\"string\",\"description\":\"Subtype of the account (e.g., Savings, Checking, Pseudo)\",\"example\":\"Savings\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"Masked account number\",\"example\":\"****0001\"},\"accountName\":{\"type\":\"string\",\"description\":\"Name associated with the account\",\"example\":\"usd savings acc\"},\"routingNumber\":{\"type\":\"string\",\"description\":\"Bank routing number\",\"example\":\"123456789\"},\"currency\":{\"type\":\"string\",\"description\":\"Currency code in ISO format\",\"example\":\"USD\"},\"masterGl\":{\"type\":\"string\",\"description\":\"Master General Ledger number\",\"example\":\"50651123\"},\"fboAccountNumber\":{\"type\":\"string\",\"description\":\"FBO account number associated with the legal entity\",\"example\":\"\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost center associated with the account\",\"example\":\"Global\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Country code in ISO format\",\"example\":\"US\"},\"reason\":{\"type\":\"string\",\"description\":\"Reason for account status or change\",\"nullable\":true},\"bankIdType\":{\"type\":\"string\",\"description\":\"Type of the bank identifier (e.g., ABA, NationalBankCode)\",\"example\":\"NationalBankCode\"},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"Identifier of the source system where the account is maintained\",\"example\":\"Finzly Core\"},\"externalAccount\":{\"type\":\"string\",\"description\":\"External account reference, if any\",\"nullable\":true},\"accountFeatures\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_accountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of custom attributes configured on the account\",\"items\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_additionalAttributes\"}},\"balanceType\":{\"type\":\"string\",\"description\":\"Type of balance maintained for the account\",\"nullable\":true},\"ledgerBalance\":{\"type\":\"number\",\"description\":\"Ledger balance of the account in the core banking system\",\"format\":\"double\",\"example\":190000.55},\"availableBalance\":{\"type\":\"number\",\"description\":\"Available balance of the account in the core banking system\",\"format\":\"double\",\"example\":190000.55},\"availableBalanceStatus\":{\"type\":\"string\",\"description\":\"Status of the available balance\",\"example\":\"Available\"},\"amountPrecision\":{\"type\":\"integer\",\"description\":\"Decimal precision supported for amount fields\",\"example\":2}},\"description\":\"Customer Bank Account details\"},\"V3AccountBadResponse\":{\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code for identifying the issue.\"},\"errors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse_errors\"}}}},\"V3SearchAccountRequest\":{\"type\":\"object\",\"properties\":{\"accountNumber\":{\"type\":\"string\",\"description\":\"Unique account number assigned by the bank.\",\"example\":\"2136565\"},\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account. Typically Deposit or Loan.\",\"example\":\"Loan\",\"enum\":[\"Deposit\",\"Loan\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Subtype of the account.\",\"example\":\"Heloc\",\"enum\":[\"Checking\",\"Savings\",\"Health Savings Account\",\"CD\",\"Money Market\",\"Pseudo\",\"Credit Card\",\"Heloc\",\"Line of Credit\"]},\"currency\":{\"type\":\"string\",\"description\":\"ISO 4217 currency code for the account.\",\"example\":\"USD\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost center to which the account is mapped.\",\"example\":\"Global\"},\"status\":{\"type\":\"string\",\"description\":\"Current status of the account.\",\"example\":\"Active\",\"enum\":[\"Active\",\"Inactive\",\"Closed\",\"Pending\",\"New\",\"Suspended\",\"Deceased\"]},\"achEnabled\":{\"type\":\"boolean\",\"description\":\"Whether ACH are enabled for the account.\",\"example\":true},\"wireEnabled\":{\"type\":\"boolean\",\"description\":\"Whether wire transfers are enabled for this account.\",\"example\":true},\"fedNowEnabled\":{\"type\":\"boolean\",\"description\":\"Whether FedNow transfers are enabled for this account.\",\"example\":true},\"rtpEnabled\":{\"type\":\"boolean\",\"description\":\"Whether RTP (Real-Time Payments) are enabled.\",\"example\":true},\"swiftEnabled\":{\"type\":\"boolean\",\"description\":\"Whether SWIFT transfers are enabled.\",\"example\":false},\"fedwireEnabled\":{\"type\":\"boolean\",\"description\":\"Whether Fedwire transfers are enabled.\",\"example\":true}}},\"V3SearchAccountResponse\":{\"properties\":{\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse\"}}}},\"SearchCustomerBankAccount\":{\"properties\":{\"accountUID\":{\"type\":\"string\",\"description\":\"Account unique identifier assigned by the system\",\"example\":\"100100\"},\"accountName\":{\"type\":\"string\",\"description\":\"Account Name\",\"example\":\"Demo 1\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"Account Number\",\"example\":\"1122345\"},\"fboAccountNumber\":{\"type\":\"string\",\"description\":\"The fbo account number should be associated with legal entity.\",\"example\":\"2233445\"},\"accountType\":{\"type\":\"string\",\"description\":\"Account Type. e.g. DEPOSIT, LOAN\",\"example\":\"DEPOSIT\"},\"accountSubType\":{\"type\":\"string\",\"description\":\"Account Type. e.g Savings, Checking, Psuedo\",\"example\":\"Checking\"},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"Identifier of the system of record. e.g Other Core,  External\",\"example\":\"Other Core\"},\"currency\":{\"type\":\"string\",\"description\":\"Currency Code is ISO format\",\"example\":\"USD\"},\"country\":{\"type\":\"string\",\"description\":\"Country Name\",\"example\":\"UNITED STATE OF AMERICA\"},\"routingNumber\":{\"type\":\"string\",\"description\":\"Bank routing number\",\"example\":\"11223498\"},\"bankIdType\":{\"type\":\"string\",\"description\":\"Bank identifier type\",\"example\":\"By ABA or By Address\"},\"enableWires\":{\"type\":\"boolean\",\"description\":\"Wire status\",\"example\":false},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Offset account\",\"example\":false},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Default offset account\",\"example\":false},\"feeAccount\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Fee account\",\"example\":false},\"returnAccount\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Return account\",\"example\":false},\"status\":{\"type\":\"string\",\"description\":\"Account status\",\"example\":\"Active\"},\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Account analysis status.\",\"example\":false},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Call back limit.\",\"example\":10000},\"costCenter\":{\"type\":\"string\",\"description\":\"Valid cost center which is associated with the legal entity.\",\"example\":\"CCD\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Valid country code.\",\"example\":\"US\"},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"Credit exposure limit. Which is applicable for the credit payments for the legal entity.\",\"example\":5000},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"Debit exposure limit. Which is applicable for the credit payments for the legal entity.\",\"example\":50000},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Flag for the call back functionality.\",\"example\":true},\"isUnderWritten\":{\"type\":\"boolean\",\"description\":\"Under writen.\",\"example\":true},\"masterGl\":{\"type\":\"string\",\"description\":\"Master GL number.\",\"example\":\"5001\"},\"reason\":{\"type\":\"string\",\"example\":\"Type here...\"},\"secCodes\":{\"type\":\"array\",\"description\":\"Sec Codes. e.g. WEB,CCD,PPD,TEL,IAT, etc..\",\"items\":{\"maxLength\":100,\"type\":\"string\",\"example\":\"WEB\"}},\"achCompanyId\":{\"maxLength\":10,\"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\"}}},\"CustomerBankAccount\":{\"properties\":{\"accountUID\":{\"type\":\"number\",\"description\":\"Account unique identifier assigned by the system\",\"example\":100100},\"name\":{\"type\":\"string\",\"description\":\"Account Name\",\"example\":\"Checking\"},\"accountNumber\":{\"type\":\"string\",\"description\":\"Account Number\",\"example\":\"1122345\"},\"fboAccountNumber\":{\"type\":\"string\",\"description\":\"The fbo account number should be associated with legal entity.\",\"example\":\"2233445\"},\"type\":{\"type\":\"string\",\"description\":\"Account Type\",\"example\":\"DEPOSIT or LOAN\"},\"subType\":{\"type\":\"string\",\"description\":\"Account Type\",\"example\":\"Checking, Savings, Psuedo\"},\"systemOfRecords\":{\"type\":\"string\",\"description\":\"Identifier of the system of record\",\"example\":\"Other Core or External\"},\"balanceType\":{\"type\":\"string\",\"description\":\"Account balance type in the bank core system\",\"example\":\"DDA\"},\"ledgerBalance\":{\"type\":\"string\",\"description\":\"Account ledger balance amount in the bank core system\",\"example\":\"24000.00\"},\"availableBalance\":{\"type\":\"string\",\"description\":\"Account balance amount in the bank core system\",\"example\":\"25000.00\"},\"availableBalanceStatus\":{\"type\":\"string\",\"description\":\"Account balance status in the bank core system\",\"example\":\"NSF\"},\"amountPrecision\":{\"type\":\"number\",\"description\":\"Amount amountPrecision\"},\"currency\":{\"type\":\"string\",\"description\":\"Currency Code is ISO format\",\"example\":\"USD\"},\"country\":{\"type\":\"string\",\"description\":\"Country Name\",\"example\":\"UNITED STATE OF AMERICA\"},\"bankId\":{\"type\":\"string\",\"description\":\"Bank routing number\",\"example\":\"11223498\"},\"bankName\":{\"type\":\"string\",\"description\":\"Name of the bank associated with the bankId\",\"example\":\"Chase\"},\"bankIdType\":{\"type\":\"string\",\"description\":\"Bank identifier type\",\"example\":\"By ABA or By Address\"},\"enableWires\":{\"type\":\"boolean\",\"description\":\"Wire status\",\"example\":false},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Offset account\",\"example\":false},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Default offset account\",\"example\":false},\"feeAccount\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Fee account\",\"example\":false},\"returnAccount\":{\"type\":\"boolean\",\"description\":\"Whether the accountNumber is a Return account\",\"example\":false},\"status\":{\"type\":\"string\",\"description\":\"Account status\",\"example\":\"Active\"},\"countryCode\":{\"type\":\"string\",\"description\":\"Valid country code.\",\"example\":\"US\"},\"masterGl\":{\"type\":\"string\",\"description\":\"Master GL number.\",\"example\":\"5001\"},\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Account analysis.\",\"example\":true},\"externalAccount\":{\"type\":\"string\",\"description\":\"External Account\"},\"costCenter\":{\"type\":\"string\",\"description\":\"Cost Center\",\"example\":\"Global\"},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Enable Callbacks\",\"example\":true},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Callback limit\",\"example\":10.15},\"reason\":{\"type\":\"string\",\"description\":\"Reason\"},\"isUnderWritten\":{\"type\":\"boolean\",\"description\":\"UnderWritten account\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"Debit Exposure Limit\",\"example\":25.45},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"Credit Exposure Limit\",\"example\":50.5},\"isAchPrefund\":{\"type\":\"boolean\",\"description\":\"ACH Prefunding is a practice that ensures the account has sufficient funds for ACH Credit payments.\",\"example\":false},\"secCodes\":{\"type\":\"array\",\"description\":\"Sec Codes. e.g. WEB,CCD,PPD,TEL,IAT, etc..\",\"items\":{\"maxLength\":100,\"type\":\"string\",\"example\":\"WEB\"}},\"achCompanyId\":{\"maxLength\":10,\"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\"},\"accountFeatures\":{\"$ref\":\"#/components/schemas/CustomerBankAccount_accountFeatures\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of account custom attributes configured.\",\"items\":{\"$ref\":\"#/components/schemas/CustomerBankAccount_additionalAttributes\"}}}},\"CustomerContactRequest\":{\"required\":[\"address\",\"contactBank\",\"name\",\"templateName\"],\"properties\":{\"templateName\":{\"type\":\"string\",\"description\":\"Contact unique name. Unique name assigned to the contact for easy identification.\\n- Spaces and special characters are not allowed.\\n\",\"example\":\"bene1\"},\"name\":{\"minLength\":2,\"type\":\"string\",\"description\":\"Contact name.\",\"example\":\"bene\"},\"email\":{\"type\":\"string\",\"description\":\"Customer Email Address\",\"example\":\"abc@abc.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Customer's Phone number\",\"example\":\"+1 202-555-0176\"},\"address\":{\"$ref\":\"#/components/schemas/CustomerAddress\"},\"contactBank\":{\"description\":\"Contact bank details\",\"allOf\":[{\"$ref\":\"#/components/schemas/CustomerContact_contactBank\"}]},\"intermediaryBank\":{\"description\":\"Contact intermediary bank details.\",\"allOf\":[{\"$ref\":\"#/components/schemas/CustomerContact_intermediaryBank\"}]},\"otherInfo\":{\"$ref\":\"#/components/schemas/CustomerContact_otherInfo\"},\"regulartoryReporting\":{\"type\":\"array\",\"description\":\"The key for regular reporting should be configured in BankOs staticData. eg. routingNumber,social, TaxId etc...\",\"items\":{\"$ref\":\"#/components/schemas/CustomerContact_regulartoryReporting\"}}}},\"CustomerContact\":{\"properties\":{\"templateName\":{\"type\":\"string\",\"description\":\"Contact unique name.\",\"example\":\"bene1\"},\"contactUID\":{\"type\":\"string\",\"description\":\"Contact unique id.\",\"example\":\"345345\"},\"name\":{\"type\":\"string\",\"description\":\"Contact name.\",\"example\":\"John\"},\"address\":{\"$ref\":\"#/components/schemas/CustomerContact_address\"},\"email\":{\"type\":\"string\",\"description\":\"Customer Email Address\",\"example\":\"abc@abc.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Customer's Phone number\",\"example\":\"+1 202-555-0176\"},\"contactBank\":{\"$ref\":\"#/components/schemas/CustomerContact_contactBank\"},\"intermediaryBank\":{\"$ref\":\"#/components/schemas/CustomerContact_intermediaryBank\"},\"otherInfo\":{\"$ref\":\"#/components/schemas/CustomerContact_otherInfo\"},\"regulartoryReporting\":{\"type\":\"array\",\"description\":\"The key for regular reporting should be configured in BankOs staticData. eg. routingNumber,social, TaxId etc...\",\"items\":{\"$ref\":\"#/components/schemas/CustomerContact_regulartoryReporting\"}}}},\"UpdateCustomerContact\":{\"properties\":{\"templateName\":{\"type\":\"string\",\"description\":\"Contact unique name. Unique name assigned to the contact for easy identification.\\n- Spaces and special characters are not allowed.\\n\",\"example\":\"bene1\"},\"name\":{\"type\":\"string\",\"description\":\"Contact name.\",\"example\":\"John\"},\"email\":{\"type\":\"string\",\"description\":\"Customer Email Address\",\"example\":\"abc@abc.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Customer's Phone number\",\"example\":\"+1 202-555-0176\"},\"address\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"contactBank\":{\"$ref\":\"#/components/schemas/UpdateCustomerContact_contactBank\"},\"intermediaryBank\":{\"$ref\":\"#/components/schemas/UpdateCustomerContact_intermediaryBank\"},\"otherInfo\":{\"$ref\":\"#/components/schemas/CustomerContact_otherInfo\"},\"regulartoryReporting\":{\"type\":\"array\",\"description\":\"The key for regular reporting should be configured in BankOs staticData. eg. routingNumber,social, TaxId etc...\",\"items\":{\"$ref\":\"#/components/schemas/CustomerContact_regulartoryReporting\"}}}},\"CreateCustomerContactResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to create a customer contact: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/CreateCustomerContactResponse_data\"}}},\"SearchCustomerContactResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to search the customer contact: <Reason>\"},\"pagination\":{\"$ref\":\"#/components/schemas/Pagination\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CustomerContact\"}}}},\"GetCustomerContactResponse\":{\"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\":\"CUST001\"},\"message\":{\"type\":\"string\",\"description\":\"Error message corresponding to the error code indicating the issue in API call and an indication on how to resolve it.\",\"example\":\"Failed to get a customer contact: <Reason>\"},\"data\":{\"$ref\":\"#/components/schemas/CustomerContact\"}}},\"CustomerUserCreateRequest\":{\"required\":[\"department\",\"email\",\"firstName\",\"lastName\",\"loginId\",\"mobile\",\"roleNames\"],\"properties\":{\"loginId\":{\"type\":\"string\",\"description\":\"Unique identifier. Only characters, numbers and special characters are allowed.\",\"example\":\"user123\"},\"firstName\":{\"type\":\"string\",\"description\":\"User first name. Only characters are allowed.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name of user. Only characters are allowed.\",\"example\":\"Cane.\"},\"email\":{\"type\":\"string\",\"description\":\"The valid users emailId\\\"\",\"example\":\"user123@gamil.com\"},\"phoneNumber\":{\"pattern\":\"^\\\\+[1-9]\\\\d{0,2}([ -]?\\\\(?\\\\d+\\\\)?)*$\",\"type\":\"string\",\"description\":\"User contact number including country code. Spaces, hyphens, and parentheses are allowed.\",\"example\":\"+1 202-555-0176\"},\"roleNames\":{\"type\":\"array\",\"description\":\"Valid role names, which is associated with the requested legal entity.\",\"items\":{\"type\":\"string\",\"example\":\"Admin\"}},\"applicationLimits\":{\"type\":\"array\",\"description\":\"Application limits are optional. If provided, they must be valid and associated with the specified roles.\",\"items\":{\"$ref\":\"#/components/schemas/Applications\"}}}},\"Applications\":{\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The allowed application names are \\n1. Accounts\\n2. Bulk_Payments\\n3. Contacts\\n4. Digital_Banking_Portal\\n5. Foreign_Exchange\\n6. Group_Payments\\n7. Positive_Rules\\n8. User_Admin\\n9. Payments\\n\",\"example\":\"Accounts\"},\"limits\":{\"type\":\"array\",\"description\":\"Limits are optional. If it is provided then it should be greater than or equals to zero. If it is not provided then no limit will be applicable.\",\"items\":{\"$ref\":\"#/components/schemas/limits\"}}}},\"limits\":{\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Each application has a valid limit name. The allowed limits are listed below. \\n1. Foreign_Exchange - \\n    i. Daily_Payment_Limits\\n    \\n    ii. Per_Transaction_Payment_Limits\\n\\n2. Payments - \\n    i. Daily_Payment_Approve_Limits\\n    \\n    ii. Daily_Payment_Limits\\n    \\n    iii. Monthly_Payment_Limits\\n    \\n    iv. Monthly_Payment_Approve_Limits\\n    \\n    v. Per_Transaction_Payment_Approve_Limits\\n    \\n    vi. Per_Transaction_Payment_Limits\\n    \\n\",\"example\":\"Daily_Payment_Approve_Limits\"},\"value\":{\"type\":\"number\",\"description\":\"Limit value. In the update flow sytem will override the exsiting value.\",\"example\":1022.23}}},\"SearchCustomerUserRequest\":{\"properties\":{\"loginId\":{\"type\":\"string\",\"description\":\"Unique identifier.\",\"example\":\"user123\"},\"firstName\":{\"type\":\"string\",\"description\":\"User first name.\",\"example\":\"john\"},\"lastName\":{\"type\":\"string\",\"description\":\"last name of user\",\"example\":\"Doe\"}}},\"SearchCustomerRoleResponse\":{\"properties\":{\"totalElements\":{\"type\":\"number\",\"description\":\"Total records exist in the system for the match the search criteria.\",\"example\":1212},\"totalPages\":{\"type\":\"number\",\"description\":\"Total number of pages\",\"example\":40},\"size\":{\"type\":\"number\",\"description\":\"Page size.\",\"example\":50},\"page\":{\"type\":\"number\",\"description\":\"Page index.\",\"example\":1},\"data\":{\"type\":\"array\",\"description\":\"Search results\",\"items\":{\"$ref\":\"#/components/schemas/SearchRoleResponse\"}}}},\"SearchCustomerUserResponse\":{\"properties\":{\"totalElements\":{\"type\":\"number\",\"description\":\"Total number of users\",\"example\":1212},\"totalPages\":{\"type\":\"number\",\"description\":\"Total number of pages\",\"example\":40},\"size\":{\"type\":\"number\",\"description\":\"Return of records\",\"example\":50},\"page\":{\"type\":\"number\",\"description\":\"Current page\",\"example\":1},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SearchUserResponse\"}}}},\"CustomerUserUpdateRequest\":{\"properties\":{\"firstName\":{\"type\":\"string\",\"description\":\"User first name. Only characters are allowed.\",\"example\":\"John\"},\"lastName\":{\"type\":\"string\",\"description\":\"Last name of user. Only characters are allowed.\",\"example\":\"Cane.\"},\"email\":{\"type\":\"string\",\"description\":\"The valid users emailId\\\"\",\"example\":\"user123@gamil.com\"},\"phoneNumber\":{\"pattern\":\"^\\\\+[1-9]\\\\d{0,2}([ -]?\\\\(?\\\\d+\\\\)?)*$\",\"type\":\"string\",\"description\":\"User contact number including country code. Spaces, hyphens, and parentheses are allowed.\",\"example\":\"+1 202-555-0176\"},\"roleNames\":{\"type\":\"array\",\"description\":\"Valid role names, which is associated with the requested legal entity.\",\"items\":{\"type\":\"string\",\"example\":\"Admin-Role\"}},\"applicationLimits\":{\"type\":\"array\",\"description\":\"Application limits are optional. If it ia provided then it should be the valid and which associated with the provided roles.\",\"items\":{\"$ref\":\"#/components/schemas/Applications\"}}}},\"CustomerUserResponse\":{\"properties\":{\"userId\":{\"type\":\"string\",\"example\":\"f37f6757-c546-42d4-8235-5965419b495d.\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating the issue in API call along with the reason.\",\"example\":\"<Reason>\"}}},\"UpdateCustomerUserResponse\":{\"properties\":{\"userId\":{\"type\":\"string\",\"example\":\"f37f6757-c546-42d4-8235-5965419b495d.\"}}},\"CustomerRoleCreateRequest\":{\"required\":[\"applications\",\"description\",\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"A valid role name can consist of alphanumeric characters.\",\"example\":\"Admin, ManagerRole1\"},\"description\":{\"type\":\"string\",\"description\":\"Description for the role.\",\"example\":\"Role for admin users\"},\"applications\":{\"type\":\"array\",\"description\":\"Customer applications which are present in the Bank's customer app store. Minimum one application should be provided.\",\"items\":{\"$ref\":\"#/components/schemas/RoleApplication\"}}}},\"RoleApplication\":{\"required\":[\"entitlements\",\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The allowed application names are \\n1. Accounts\\n2. Bulk_Payments\\n3. Contacts,\\n4. Foreign_Exchange \\n5. Group_Payments \\n6. Positive_Rules\\n7. User_Admin \\n8. Payments\\n9. Digital_Banking_Portal\\n\",\"example\":\"Accounts\"},\"entitlements\":{\"type\":\"array\",\"description\":\"Entitlements control application access, with each app having its own set. The allowed entitlements are listed below. \\n1. Accounts -\\n\\n    i. Manage_Account\\n    \\n    ii. View_Account\\n    \\n    \\n              \\n2. Bulk_Payments - \\n\\n    i. Approve_bulk_payments\\n    \\n    ii. Upload_Bulk_Payment_File\\n    \\n    iii. View_bulk_payments\\n    \\n\\n3. Contacts -\\n\\n    i. Manage_Contacts\\n    \\n    ii. View_Contacts\\n    \\n\\n4. Digital_Banking_Portal -\\n\\n    i. View_Portal\\n\\n5. Foreign_Exchange - \\n\\n    i. Cancel_Trades\\n    \\n    ii. View_Trades\\n    \\n    iii. Spot_Trade\\n    \\n    iv. Create_Instruct_Trades\\n    \\n\\n6. Group_Payments -\\n\\n    i. Approve_Group\\n    \\n    ii. View_Group\\n    \\n    iii. Initiate_Cancel_Group_Payment\\n    \\n    iv. Manage_Group\\n    \\n\\n7. Payments -\\n\\n    i. Reversal_Payments\\n    \\n    ii. View_Payments\\n    \\n    iii. Return_Payments\\n    \\n    iv. Cancel_Payments\\n    \\n    v. Initiate_Payments\\n    \\n    vi. Approve_Payments\\n    \\n\\n8. Positive_Rules - \\n\\n    i. Manage_Exception\\n    \\n    ii. View_Positive_Rules\\n    \\n    iii. Manage_Positive_Rules\\n    \\n\\n9.  User_Admin - \\n\\n    i. View_Roles_And_Users\\n    \\n    ii. Manage_Roles\\n    \\n    iii. Manage_Users\\n    \\n    iv. Activate_Users\\n    \\n    v. View_Category\\n    \\n    vi. Add_Update_Delete_Category\\n    \\n    vii. Suspend_Users\\n    \\n\",\"items\":{\"type\":\"string\",\"example\":\"Manage_Account,  View_Account\"}},\"limits\":{\"type\":\"array\",\"description\":\"Application limits are optional.\",\"items\":{\"$ref\":\"#/components/schemas/limits\"}}}},\"CustomerRoleResponse\":{\"properties\":{\"roleId\":{\"type\":\"string\",\"description\":\"New role Id.\",\"example\":\"7c40d833-6dfe-454a-bdea-0d6098c12c61\"},\"message\":{\"type\":\"string\",\"description\":\"Error message indicating the issue in API call along with the reason.\",\"example\":\"<Reason>\"}}},\"SearchUserResponse\":{\"properties\":{\"loginId\":{\"type\":\"string\",\"description\":\"Unique identifier.\",\"example\":\"user123\"},\"firstName\":{\"type\":\"string\",\"description\":\"User first name.\",\"example\":\"john\"},\"lastName\":{\"type\":\"string\",\"description\":\"last name of user.\",\"example\":\"T\"},\"email\":{\"type\":\"string\",\"description\":\"users email id.\",\"example\":\"user123@gamil.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"User contact number.\",\"example\":\"+1 202-555-0176\"},\"status\":{\"type\":\"string\",\"description\":\"User current status in the system.\",\"example\":\"Active\"},\"shortName\":{\"type\":\"string\",\"description\":\"Legal entity short name which is associated with the user.\",\"example\":\"CORP1\"}}},\"GetCustomerUserResponse\":{\"properties\":{\"userId\":{\"type\":\"string\",\"description\":\"User unique identifer.\",\"example\":\"f945bc67-c44b-4f88-91d9-d09434e4dd37\"},\"loginId\":{\"type\":\"string\",\"description\":\"Unique identifier.\",\"example\":\"user123\"},\"firstName\":{\"type\":\"string\",\"description\":\"User first name.\",\"example\":\"john\"},\"lastName\":{\"type\":\"string\",\"description\":\"last name of user.\",\"example\":\"T\"},\"email\":{\"type\":\"string\",\"description\":\"users email id.\",\"example\":\"user123@gamil.com\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"User contact number.\",\"example\":\"+1 202-555-0176\"},\"status\":{\"type\":\"string\",\"description\":\"User current status in the system.\",\"example\":\"Active\"},\"shortName\":{\"type\":\"string\",\"description\":\"Legal entity short name which is associated with the user.\",\"example\":\"CORP1\"},\"roleNames\":{\"type\":\"array\",\"description\":\"Unique identifier.\",\"items\":{\"type\":\"string\",\"example\":\"Admin\"}},\"limits\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/limits\"}}}},\"SearchRoleResponse\":{\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Role id.\",\"example\":\"f37f6757-c546-42d4-8235-5965419b495d.\"},\"name\":{\"type\":\"string\",\"description\":\"Role name.\",\"example\":\"adminRole.\"},\"description\":{\"type\":\"string\",\"description\":\"Role description.\",\"example\":\"Role description.\"},\"leId\":{\"type\":\"number\",\"description\":\"Customer id  associated with role.\",\"example\":11950},\"status\":{\"type\":\"string\",\"description\":\"Status of role.\",\"example\":\"Active\"},\"type\":{\"type\":\"string\",\"description\":\"Type of the role. e.g. Bank, customer\",\"example\":\"CUSTOMER\"},\"owner\":{\"type\":\"string\",\"description\":\"The owner of this role will indicate who created it.\",\"example\":\"Bank, Customer\"}}},\"GetCustomerRoleResponse\":{\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Role id.\",\"example\":\"f37f6757-c546-42d4-8235-5965419b495d.\"},\"name\":{\"type\":\"string\",\"description\":\"Role name.\",\"example\":\"adminRole.\"},\"description\":{\"type\":\"string\",\"description\":\"Role description.\",\"example\":\"Role description.\"},\"leId\":{\"type\":\"number\",\"description\":\"Customer id  associated with role.\",\"example\":11950},\"type\":{\"type\":\"string\",\"description\":\"Type of the role. e.g. Bank, customer\",\"example\":\"CUSTOMER\"},\"status\":{\"type\":\"string\",\"description\":\"Status of role.\",\"example\":\"Active\"},\"owner\":{\"type\":\"string\",\"description\":\"The owner of this role will indicate who created it.\",\"example\":\"Bank, Customer\"},\"applications\":{\"$ref\":\"#/components/schemas/RoleApplication\"}}},\"PaymentNoteOptionValueChildren_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\"}}},\"CreateUpdateCustomerResponse_data\":{\"type\":\"object\",\"properties\":{\"customerUID\":{\"type\":\"number\",\"description\":\"Customer id within Finzly's CRM system\",\"example\":12345},\"shortName\":{\"type\":\"string\",\"example\":\"ACBCORP\"},\"customerEntityStatus\":{\"type\":\"string\",\"description\":\"Status of the customer\",\"example\":\"New\"}}},\"UpdateAccountResponse_data\":{\"type\":\"object\",\"properties\":{\"accountUID\":{\"type\":\"string\",\"description\":\"Account unique identifier assigned by the system\"}}},\"CreateAccountResponse_data\":{\"type\":\"object\",\"properties\":{\"accountUID\":{\"type\":\"string\"}}},\"CustomerContact_contactBank\":{\"required\":[\"accountCcy\",\"accountNo\",\"accountSubType\",\"accountType\",\"country\"],\"type\":\"object\",\"properties\":{\"country\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Country name\",\"example\":\"UNITED STATES OF AMERICA\"},\"accountNo\":{\"type\":\"string\",\"description\":\"Account Number\",\"example\":\"98989898\"},\"accountCcy\":{\"type\":\"string\",\"description\":\"Account currency. Currency Code is ISO format.\",\"example\":\"USD\"},\"name\":{\"type\":\"string\",\"description\":\"The bank name is mandatory if the national code and SWIFT code are not provided, but address details provided.\",\"example\":\"Banka\"},\"address\":{\"description\":\"The bank address is optional unless the national code or SWIFT code is not provided, in which case it becomes mandatory.\",\"allOf\":[{\"$ref\":\"#/components/schemas/CustomerContactIntermediaryBankAddress\"}]},\"nationalCode\":{\"type\":\"string\",\"description\":\"National code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"012548722\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"USBNX000\"},\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account.\",\"example\":\"Deposit\",\"enum\":[\"GL\",\"Loan\",\"Deposit\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Sub Type of the account.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]}}},\"CustomerContact_intermediaryBank\":{\"type\":\"object\",\"properties\":{\"country\":{\"type\":\"string\",\"description\":\"Country name\",\"example\":\"UNITED STATES OF AMERICA\"},\"name\":{\"type\":\"string\",\"description\":\"The bank name is mandatory if the national code and SWIFT code are not provided, but bank address details provided.\",\"example\":\"Banka\"},\"nationalCode\":{\"type\":\"string\",\"description\":\"National code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"012548780\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"USBNX000\"},\"coverMessageRequired\":{\"type\":\"boolean\",\"example\":true},\"address\":{\"description\":\"The bank address is optional unless the national code or SWIFT code is not provided, in which case it becomes mandatory.\",\"allOf\":[{\"$ref\":\"#/components/schemas/CustomerContactIntermediaryBankAddress\"}]}}},\"CustomerContact_otherInfo\":{\"type\":\"object\",\"properties\":{\"beneNotes\":{\"type\":\"string\",\"description\":\"Bene note\",\"example\":\"Type something.....\"},\"otherBeneBankInfo\":{\"type\":\"string\",\"description\":\"Other bene bank info.\",\"example\":\"bank info.\"}}},\"CustomerContact_regulartoryReporting\":{\"type\":\"object\",\"properties\":{\"key\":{\"type\":\"string\",\"example\":\"routingNumber\"},\"value\":{\"type\":\"string\",\"example\":\"4545\"}}},\"UpdateCustomerContact_contactBank\":{\"type\":\"object\",\"properties\":{\"country\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Country name\",\"example\":\"UNITED STATES OF AMERICA\"},\"accountNo\":{\"type\":\"string\",\"description\":\"Account Number\",\"example\":\"98989898\"},\"accountCcy\":{\"type\":\"string\",\"description\":\"Account currency. Currency Code is ISO format.\",\"example\":\"USD\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the bank. If the national code and SWIFT code are null, and address details are provided, then the name is mandatory.\",\"example\":\"Banka\"},\"address\":{\"$ref\":\"#/components/schemas/UpdateCustomerAddress\"},\"nationalCode\":{\"type\":\"string\",\"description\":\"National code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"0125487\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"USBNX000\"},\"accountType\":{\"type\":\"string\",\"description\":\"Type of the account.\",\"example\":\"Deposit\",\"enum\":[\"GL\",\"Loan\",\"Deposit\"]},\"accountSubType\":{\"type\":\"string\",\"description\":\"Sub type of the account.\",\"example\":\"Checking\",\"enum\":[\"Checking\",\"Savings\",\"Line of Credit\",\"Credit Card\",\"Heloc\",\"GL\"]}}},\"UpdateCustomerContact_intermediaryBank\":{\"type\":\"object\",\"properties\":{\"country\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Country name\",\"example\":\"UNITED STATES OF AMERICA\"},\"name\":{\"type\":\"string\",\"description\":\"Name of the intermediary bank.\",\"example\":\"Banka\"},\"nationalCode\":{\"type\":\"string\",\"description\":\"National code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"0125487\"},\"swiftCode\":{\"type\":\"string\",\"description\":\"SWIFT code that identifies your bank, country, location, and branch. Either swiftCode or nationalCode is needed.\",\"example\":\"USBNX000\"},\"coverMessageRequired\":{\"type\":\"boolean\",\"example\":true},\"address\":{\"$ref\":\"#/components/schemas/UpdateCustomerContactIntermediaryBankAddress\"}}},\"CreateCustomerContactResponse_data\":{\"type\":\"object\",\"properties\":{\"customerContactUID\":{\"type\":\"string\",\"description\":\"Customer contact unique identifier created by the system.\"}}},\"AdditionalAttribute\":{\"required\":[\"attributeName\",\"value\"],\"type\":\"object\",\"properties\":{\"attributeName\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"Custom Attribute must be defined in BankOS Static Data App - Custom Attributes at Entity/Customer Level.\",\"example\":\"SourceReferenceId\"},\"value\":{\"maxLength\":255,\"type\":\"string\",\"description\":\"The custom attribute value must match the type configured in the system. For a Text type, the value can contain any characters. For a Boolean type, the value must be either 'True' or 'False'. For a Date type, the value must follow the YYYY-MM-DD format.\",\"example\":\"7c40d833-6dfe-454a-bdea-0d6098c12c61\"}}},\"SweepRange\":{\"type\":\"object\",\"properties\":{\"toAmount\":{\"type\":\"number\",\"description\":\"To amount which is want to sweep to.\",\"example\":1000.05},\"fromAmount\":{\"type\":\"number\",\"description\":\"From amount want to sweep in.\",\"example\":100.12}}},\"CreateAccountSweepsRequest\":{\"anyOf\":[{\"title\":\"both\",\"required\":[\"balanceType\",\"frequency\",\"range\",\"sweepFrom\",\"sweepTo\"],\"properties\":{\"balanceType\":{\"type\":\"string\",\"description\":\"Specifies the sweep type, which defines how the account balance is managed. The range type is applicable for both sweep directions\",\"example\":\"Range\",\"enum\":[\"Target\",\"Range\",\"Zero\"]},\"sweepFrom\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepFrom\"},{\"required\":[\"contactId\",\"paymentMethod\"],\"type\":\"object\"}]},\"sweepTo\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepTo\"},{\"required\":[\"contactId\",\"paymentMethod\"],\"type\":\"object\"}]},\"range\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepRange\"},{\"required\":[\"fromAmount\",\"toAmount\"],\"type\":\"object\"}]},\"frequency\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepFrequency\"},{\"required\":[\"type\"],\"type\":\"object\"}]}},\"description\":\"Configuration for a sweep that supports both sweep-in and sweep-out directions.\"},{\"title\":\"out\",\"required\":[\"balanceType\",\"frequency\",\"sweepTo\",\"targetBalance\"],\"properties\":{\"balanceType\":{\"type\":\"string\",\"description\":\"Specifies the sweep type, which determines how the account balance is managed. Target or Zero types are applicable only for sweep-out direction.\",\"example\":\"Target\",\"enum\":[\"Target\",\"Range\",\"Zero\"]},\"sweepTo\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepTo\"},{\"required\":[\"contactId\",\"paymentMethod\"],\"type\":\"object\"}]},\"targetBalance\":{\"type\":\"number\",\"description\":\"Target balance to maintain when sweeping funds out of the account. For Zero balance type amount should be zero. If target balance not provided default to be 0.\",\"example\":100},\"frequency\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepFrequency\"},{\"required\":[\"type\"],\"type\":\"object\"}]}},\"description\":\"Configuration for a sweep where funds are moved out of the source account.\"},{\"title\":\"in\",\"required\":[\"balanceType\",\"frequency\",\"sweepFrom\",\"targetBalance\"],\"properties\":{\"balanceType\":{\"type\":\"string\",\"description\":\"Specifies the sweep type, which determines how the account balance is managed. The Target type is applicable only for the sweep-in direction.\",\"example\":\"Target\",\"enum\":[\"Target\",\"Range\",\"Zero\"]},\"sweepFrom\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepFrom\"},{\"required\":[\"contactId\",\"paymentMethod\"],\"type\":\"object\"}]},\"targetBalance\":{\"type\":\"number\",\"description\":\"Target balance to maintain when sweeping funds into the account.\",\"example\":100},\"frequency\":{\"allOf\":[{\"$ref\":\"#/components/schemas/SweepFrequency\"},{\"required\":[\"type\"],\"type\":\"object\"}]}},\"description\":\"Configuration for a sweep where funds are moved into the target account.\"}]},\"CreateAccountSweepsResponse\":{\"properties\":{\"errors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse_errors\"}}}},\"UpdateAccountSweepsRequest\":{\"anyOf\":[{\"title\":\"both\",\"properties\":{\"sweepFrom\":{\"$ref\":\"#/components/schemas/SweepFrom\"},\"sweepTo\":{\"$ref\":\"#/components/schemas/SweepTo\"},\"range\":{\"$ref\":\"#/components/schemas/SweepRange\"},\"frequency\":{\"$ref\":\"#/components/schemas/SweepFrequency\"}},\"description\":\"Configuration for a sweep that supports both sweep-in and sweep-out directions.\"},{\"title\":\"out\",\"properties\":{\"sweepTo\":{\"$ref\":\"#/components/schemas/SweepTo\"},\"targetBalance\":{\"type\":\"number\",\"description\":\"Target balance to maintain when sweeping funds out of the account.\",\"example\":100},\"frequency\":{\"$ref\":\"#/components/schemas/SweepFrequency\"}}},{\"title\":\"in\",\"properties\":{\"sweepFrom\":{\"$ref\":\"#/components/schemas/SweepFrom\"},\"targetBalance\":{\"type\":\"number\",\"description\":\"Target balance to maintain when sweeping funds into the account.\",\"example\":100},\"frequency\":{\"$ref\":\"#/components/schemas/SweepFrequency\"}}}]},\"GetAccountSweepsResponse\":{\"type\":\"object\",\"properties\":{\"balanceType\":{\"type\":\"string\",\"description\":\"Specifies the type of sweep.\",\"example\":\"Range\",\"enum\":[\"Range\",\"Zero\",\"Target\"]},\"targetBalance\":{\"type\":\"number\",\"description\":\"Specifies the sweep amount, applicable only when the direction is either sweep-in or sweep-out.\",\"format\":\"double\",\"example\":98.05},\"range\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_range\"},\"sweepFrom\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_sweepFrom\"},\"sweepTo\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_sweepTo_1\"}}},\"SweepFrequency\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Frequency at which the sweep is executed.\\n- For MONTHLY type, `dayOfMonth` is required.\\n- For WEEKLY type, `dayOfWeek` is required.\\n- For INTRADAY type, `scheduleType` is required.\\n\",\"example\":\"WEEKLY\",\"enum\":[\"DAILY\",\"WEEKLY\",\"MONTHLY\",\"INTRADAY\"]},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep is executed.\",\"example\":\"Monday\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"dayOfMonth\":{\"type\":\"number\",\"description\":\"Specifies the month in which the sweep is executed.  Acceptable values range from 1 to 12, where 1 represents January and 12 represents December.\",\"example\":6},\"scheduleType\":{\"type\":\"string\",\"description\":\"Type of sweep schedule configuration. Required when frequency type is `INTRADAY`.\",\"example\":\"Interval\",\"enum\":[\"INTERVAL\",\"SpecificTimes\"]},\"intervalTime\":{\"type\":\"string\",\"description\":\"Defines how frequently the sweep runs within the day when `scheduleType` is `INTERVAL`. This field is required when the schedule type is `INTERVAL`.\",\"example\":\"Every 30 minutes\",\"enum\":[\"Every 30 minutes\",\"Every 1 hour\",\"Every 2 hours\",\"Every 3 hours\",\"Every 4 hours\"]},\"specificTimes\":{\"type\":\"array\",\"description\":\"- Specifies the exact times when the sweep should execute when `scheduleType` is `SPECIFIC_TIMES`.\\n- This field is required when the schedule type is `SPECIFIC_TIMES`.\\n- Time must be provided in 24-hour format.\\n\",\"example\":[\"10:00\",\"12:00\",\"21:00\"],\"items\":{\"type\":\"string\",\"format\":\"time\"}}},\"description\":\"Frequency configuration for sweep execution.\"},\"SweepFrom\":{\"type\":\"object\",\"properties\":{\"contactId\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"string\",\"description\":\"Unique identifier of the sweep-in beneficiary.\",\"example\":\"936\"},\"paymentMethod\":{\"type\":\"string\",\"description\":\"Payment method used to execute the sweep-in.\",\"example\":\"InstantRFP\",\"enum\":[\"AchDebit\",\"WireDrawdown\",\"InstantRFP\"]}},\"description\":\"Configuration for sweeping funds into the account.\"},\"SweepTo\":{\"type\":\"object\",\"properties\":{\"contactId\":{\"pattern\":\"^(?!0+$)[0-9]+$\",\"type\":\"string\",\"description\":\"Unique identifier of the sweep-out beneficiary.\",\"example\":\"947\"},\"paymentMethod\":{\"type\":\"string\",\"description\":\"Payment method used to execute the sweep-out.\",\"example\":\"AchCredit\",\"enum\":[\"AchCredit\",\"WirePayment\",\"InstantPayment\"]}},\"description\":\"Configuration for sweeping funds out of the account.\"},\"V4StandardResponse\":{\"properties\":{\"errors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V3AccountBadResponse_errors\"}}}},\"CustomerLookUpResponse\":{\"type\":\"object\",\"properties\":{\"profiles\":{\"type\":\"array\",\"description\":\"List of customer profiles\",\"items\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse_profiles\"}}},\"description\":\"Customer lookup details\"},\"customerId\":{\"description\":\"Customer (legal entity) identifier used on the public Open Banking surface.\"},\"signatoryId\":{\"description\":\"Signatory identifier (from create response or list items).\"},\"SignatorySimpleErrorResponse\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Machine-readable code (e.g. `SIGNATORY_UNAUTHORIZED_REQUEST`, `SIGNATORY_ACCESS_FORBIDDEN`, `SIGNATORY_INTERNAL_ERROR`).\",\"example\":\"SIGNATORY_ACCESS_FORBIDDEN\"},\"message\":{\"type\":\"string\",\"description\":\"Human-readable explanation.\",\"example\":\"The user is not authorized to perform this operation, please contact the administrator for support.\"}},\"description\":\"Minimal error envelope for signatory **401**, **403**, and **500** responses. **Only** `code` and `message`\\n(no `status`, `errors`, `data`, etc.). Differs from **400** responses that use `SignatoryErrorResponse` with\\nan `errors` array.\\n\"},\"CreateSignatoryRequest\":{\"required\":[\"emailAddress\",\"fullName\",\"phoneNumber\"],\"type\":\"object\",\"properties\":{\"fullName\":{\"type\":\"string\",\"description\":\"Full name of the signatory (required, not blank).\",\"example\":\"Jane Doe\"},\"emailAddress\":{\"type\":\"string\",\"description\":\"Email address (required, valid email format).\",\"format\":\"email\",\"example\":\"jane.doe@example.com\"},\"title\":{\"type\":\"string\",\"description\":\"Optional job title or role label.\",\"example\":\"CFO\"},\"approvalLimit\":{\"type\":\"number\",\"description\":\"Optional monetary approval limit. If provided, must be >= 0 with at most **12** integer digits\\nand **2** decimal places.\\n\",\"format\":\"double\",\"example\":100000.5},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Phone number (required). Validated against the legal-entity phone validation service after format checks.\\n\",\"example\":\"+15551234567\"}}},\"UpdateSignatoryRequest\":{\"type\":\"object\",\"properties\":{\"fullName\":{\"type\":\"string\"},\"emailAddress\":{\"type\":\"string\",\"format\":\"email\"},\"title\":{\"type\":\"string\"},\"approvalLimit\":{\"type\":\"number\",\"format\":\"double\"},\"phoneNumber\":{\"type\":\"string\"}},\"description\":\"All fields optional. Omit a field to leave it unchanged. Send at least one field; empty object is rejected.\\n\"},\"CreateSignatorySuccessResponse\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"Signatory identifier.\",\"format\":\"int64\"},\"status\":{\"type\":\"string\",\"description\":\"Status from downstream legal-entity payload (if present).\"},\"message\":{\"type\":\"string\",\"description\":\"User-facing success message from Open Banking layer.\",\"example\":\"Signatory created successfully.\"}},\"description\":\"Returned for a successful create (HTTP **201**).\"},\"UpdateSignatorySuccessResponse\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"Signatory identifier.\",\"format\":\"int64\"},\"status\":{\"type\":\"string\",\"description\":\"Status from downstream legal-entity payload (if present).\"},\"message\":{\"type\":\"string\",\"description\":\"User-facing success message from Open Banking layer.\",\"example\":\"Signatory updated successfully.\"}},\"description\":\"Returned for a successful partial update (HTTP **200**). Field names and types match the create success\\nbody; `message` reflects the update flow (see example).\\n\"},\"ListSignatoriesResponse\":{\"type\":\"object\",\"properties\":{\"signatories\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SignatoryListItem\"}},\"message\":{\"type\":\"string\",\"description\":\"Success message when one or more rows exist, or empty-state message when `signatories` is empty.\\n\",\"example\":\"Signatories fetched successfully.\"}}},\"SignatoryListItem\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"format\":\"int64\"},\"fullName\":{\"type\":\"string\"},\"emailAddress\":{\"type\":\"string\"},\"title\":{\"type\":\"string\"},\"approvalLimit\":{\"type\":\"string\",\"description\":\"Exposed as string in list responses (matches downstream formatting).\"},\"phoneNumber\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}},\"DeleteSignatorySuccessResponse\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}}},\"V4Error\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"code\":{\"type\":\"string\",\"description\":\"Machine-readable code (domain `SIG_*`, `PHONE_SERVICECALL_FAILED`, or `WebServiceException` enum name).\"}}},\"SignatoryErrorResponse\":{\"required\":[\"errors\"],\"type\":\"object\",\"properties\":{\"errors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/V4Error\"}}},\"description\":\"Error envelope for signatory endpoints. Populated by `SignatoryControllerAdvice` for handled failures\\n(**HTTP 400**): validation, `CustomException`, `WebServiceException`, and malformed JSON body.\\n\",\"example\":{\"errors\":[{\"message\":\"Partner identifier is required in the security context.\",\"code\":\"SIG_PARTNERID_REQUIRED\"}]}},\"V3CreateAccountRequest_accountFeatures_fedWireFeature\":{\"type\":\"object\",\"properties\":{\"enableWire\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable FedWire functionality for this account.\\n\\nIf set to `true`, at least one of `enableDomesticWire` or `enableInternationalWire` must also be `true`.\\n\\nIf set to `false`, both `enableDomesticWire` and `enableInternationalWire` must also be `false`.                 \\n\",\"example\":true},\"enableInternationalWire\":{\"type\":\"boolean\",\"description\":\"Indicates whether international FedWire transfers are enabled for the account.\\n\\nMust be set to `false` if `enableWire` is `false`.                  \\n\",\"example\":true},\"enableDomesticWire\":{\"type\":\"boolean\",\"description\":\"Indicates whether domestic FedWire transfers are enabled for the account.\\n\\nMust be set to `false` if `enableWire` is `false`.                  \\n\",\"example\":true},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Enables callback notifications for wire transactions.\\n\\nRequires `enableDomesticWire` to be `true`. If enabled, a valid `callbackLimit` can also be provided.\\n\",\"example\":true},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Defines the maximum transaction limit that triggers a callback when `enableCallbacks` is `true`.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.                  \\n\",\"format\":\"BigDecimal\",\"example\":1220.55}},\"description\":\"Configuration settings related to FedWire capabilities for the account.\"},\"V3CreateAccountRequest_accountFeatures_fedNowFeature\":{\"type\":\"object\",\"properties\":{\"enableFedNow\":{\"type\":\"boolean\",\"description\":\"Master flag to enable or disable FedNow® services for the account.\\n- When set to true: FedNow is active. Receive capabilities are enabled by default `(fednowReceiveOnly = true, fednowRfpReceive = true)`. Send capabilities `(fednowSend, fednowRfpSend)` must be explicitly set to true. Deprecated fields `(fednowSendOrReceive, fednowReceiveOnly, fednowRfpReceive)` are supported for backward compatibility but new fields take precedence.  \\n- When set to false: FedNow is disabled; all related operations, including send and deprecated fields, are considered false.\\n\",\"example\":true},\"fednowSend\":{\"type\":\"boolean\",\"description\":\"Enables sending payments via FedNow.\\n- Only effective when enableFedNow = true.\\n- Overrides deprecated fednowSendOrReceive if both are provided.\\n\",\"example\":true},\"fednowRfpSend\":{\"type\":\"boolean\",\"description\":\"Enables the capability to **send Request for Payment (RFP)** messages through FedNow.\\n\\nRFP allows the account to initiate payment requests to other FedNow participants.\\n\",\"example\":true}},\"description\":\"Configuration settings related to FedNow® instant payment capabilities for the account.\\n\\n **Deprecated Fields**:\\n   - `fednowSendOrReceive` `(Boolean)` → Use `fednowSend` instead.\\n   - `fednowReceiveOnly` `(Boolean)` → Receive is now enabled automatically via `enableFedNow`.\\n   - `fednowRfpReceive` `(Boolean)` → Receive RFP is now enabled automatically via `enableFedNow`.\\n\\n \\n Notes: \\n   - Deprecated fields are supported for backward compatibility.\\n   - They will be removed in version `7.0.0.0`.\\n   - When both new and deprecated fields are provided, new fields take precedence.\\n   - For updates, only explicitly provided fields are modified; omitted fields remain unchanged.\\n\"},\"V3CreateAccountRequest_accountFeatures_rtpFeature\":{\"type\":\"object\",\"properties\":{\"enableRtp\":{\"type\":\"boolean\",\"description\":\"Master flag to enable or disable Rtp® services for the account.\\n- When set to true: Rtp is active. Receive capabilities are enabled by default `(rtpReceiveOnly = true, rtpRfpReceive = true)`. Send capabilities `(rtpSend, rtpRfpSend)` must be explicitly set to true. Deprecated fields `(rtpSendOrReceive, rtpReceiveOnly, rtpRfpReceive)` are supported for backward compatibility but new fields take precedence.  \\n- When set to false: Rtp is disabled; all related operations, including send and deprecated fields, are considered false.                 \\n\",\"example\":true},\"rtpSend\":{\"type\":\"boolean\",\"description\":\"Enables sending payments via Rtp.\\n- Only effective when enableRtp = true.\\n- Overrides deprecated rtpSendOrReceive if both are provided.       \\n\",\"example\":false},\"rtpRfpSend\":{\"type\":\"boolean\",\"description\":\"Enables the capability to **send Request for Payment (RFP)** messages through Rtp.\\n\\nRFP allows the account to initiate payment requests to other Rtp participants.                \\n\",\"example\":true}},\"description\":\"Configuration settings related to RTP (Real-Time Payments) capabilities for the account.\\n\\n**Deprecated Fields**:\\n  - `rtpSendOrReceive` `(Boolean)` → Use `rtpSend` instead.\\n  - `rtpReceiveOnly` `(Boolean)` → Receive is now enabled automatically via `enableRtp`.\\n  - `rtpRfpReceive` `(Boolean)` → Receive RFP is now enabled automatically via `enableRtp`.\\n\\nNotes: \\n  - Deprecated fields are supported for backward compatibility.\\n  - They will be removed in version `7.0.0.0`.\\n  - When both new and deprecated fields are provided, new fields take precedence.\\n  - For updates, only explicitly provided fields are modified; omitted fields remain unchanged.\\n\"},\"V3CreateAccountRequest_accountFeatures_achFeature\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable ACH functionality for this account.  \\n\\nThis field is required to be enabled if ACH features are active.\\n\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Indicates whether offset functionality is enabled for the ACH account.\",\"example\":true},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Marks this account as the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'. \\n\",\"example\":true},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Enables \\\"Underwritten\\\" mode for the ACH account, allowing controlled credit and debit exposure limits.\\n\\nThis option cannot be enabled if `enableAchPrefund` is set to `true`.\\n\\nRequired in order to define `debitExposureLimit` and `creditExposureLimit`.                 \\n\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed debit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable either when `enableUnderWritten` or `enableAchPrefund` is set to `true`.                  \\n\",\"format\":\"BigDecimal\",\"example\":1677},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed credit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                 \\n\",\"format\":\"BigDecimal\",\"example\":2000},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Enables ACH prefunding for the account.\\n\\nPrefunding ensures sufficient funds are reserved for ACH Credit payments before they are processed.\\n\\nCannot be enabled if `enableUnderWritten` is also enabled.\\n\\nRequired in order to define `debitExposureLimit`.\\n\",\"example\":false},\"achCompanyId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH Company ID assigned to the originator by the financial institution or the ACH operator.  \\nThis field is required when `enableACH` is set to true.\\n\",\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"A list of valid Standard Entry Class (SEC) codes associated with the ACH account.\\n\",\"example\":[\"WEB\",\"CCD\",\"PPD\",\"TEL\",\"IAT\",\"ARC\",\"BOC\",\"RCK\",\"POP\",\"XCK\"],\"items\":{\"type\":\"string\"}}},\"description\":\"Configuration settings related to ACH (Automated Clearing House) payment capabilities.\"},\"V3UpdateAccountRequest_accountFeatures_achFeature\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable ACH functionality for this account.\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Indicates whether offset functionality is enabled for the ACH account.\",\"example\":true},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Marks this account as the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'. \\n\",\"example\":true},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Enables \\\"Underwritten\\\" mode for the ACH account, allowing controlled credit and debit exposure limits.\\n\\nThis option cannot be enabled if `enableAchPrefund` is set to `true`.\\n\\nRequired in order to define `debitExposureLimit` and `creditExposureLimit`.                 \\n\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed debit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                  \\n\",\"format\":\"BigDecimal\",\"example\":1677},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed credit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                 \\n\",\"format\":\"BigDecimal\",\"example\":2000},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Enables ACH prefunding for the account.\\n\\nPrefunding ensures sufficient funds are reserved for ACH Credit payments before they are processed.\\n\\nCannot be enabled if `enableUnderWritten` is also enabled.\\n\",\"example\":false},\"achCompanyId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH Company ID assigned to the originator by the financial institution or the ACH operator.\\nThis field is required when `enableACH` is set to true.\\n\",\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"A list of valid Standard Entry Class (SEC) codes associated with the ACH account.\\n\",\"example\":[\"WEB\",\"CCD\",\"PPD\",\"TEL\",\"IAT\",\"ARC\",\"BOC\",\"RCK\",\"POP\",\"XCK\"],\"items\":{\"type\":\"string\"}}},\"description\":\"Configuration settings related to ACH (Automated Clearing House) payment capabilities.\"},\"V3GetAccountResponse_accountFeatures_fedWireFeature\":{\"type\":\"object\",\"properties\":{\"enableWire\":{\"type\":\"boolean\",\"description\":\"Whether wire transfer is enabled\",\"example\":true},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Callback limit for wire transactions\",\"format\":\"double\",\"example\":980.99},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Whether callback notifications are enabled\",\"example\":true},\"enableInternationalWire\":{\"type\":\"boolean\",\"description\":\"Whether international wire is enabled\",\"example\":true},\"enableDomesticWire\":{\"type\":\"boolean\",\"description\":\"Whether domestic wire is enabled\",\"example\":true}},\"description\":\"Features related to FedWire payments\"},\"V3GetAccountResponse_accountFeatures_fedNowFeature\":{\"type\":\"object\",\"properties\":{\"enableFedNow\":{\"type\":\"boolean\",\"description\":\"Whether FedNow is enabled\",\"example\":false},\"fednowReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Whether only receiving is enabled for FedNow\",\"example\":false},\"fednowSendOrReceive\":{\"type\":\"boolean\",\"description\":\"Whether send/receive is allowed for FedNow\",\"example\":false},\"fednowRfpSend\":{\"type\":\"boolean\",\"description\":\"Whether RFP send is allowed via FedNow\",\"example\":false},\"fednowSend\":{\"type\":\"boolean\",\"description\":\"Whether send is allowed via FedNow\",\"example\":false},\"fednowRfpReceive\":{\"type\":\"boolean\",\"description\":\"Whether RFP receive is allowed via FedNow\",\"example\":false}},\"description\":\"Features related to FedNow instant payment service\"},\"V3GetAccountResponse_accountFeatures_rtpFeature\":{\"type\":\"object\",\"properties\":{\"enableRtp\":{\"type\":\"boolean\",\"description\":\"Whether RTP is enabled\",\"example\":false},\"rtpReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Whether only receiving is enabled for RTP\",\"example\":false},\"rtpSendOrReceive\":{\"type\":\"boolean\",\"description\":\"Whether sending/receiving is allowed for RTP\",\"example\":false},\"rtpRfpSend\":{\"type\":\"boolean\",\"description\":\"Whether RFP send is allowed via RTP\",\"example\":false},\"rtpSend\":{\"type\":\"boolean\",\"description\":\"Whether send is allowed via RTP\",\"example\":false},\"rtpRfpReceive\":{\"type\":\"boolean\",\"description\":\"Whether RFP receive is allowed via RTP\",\"example\":false}},\"description\":\"Features related to RTP (Real-Time Payments)\"},\"V3GetAccountResponse_accountFeatures_achFeature\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Whether ach is enabled for the account\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Whether offset is enabled for ACH\",\"example\":false},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Whether this account is a default offset account\",\"example\":false},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Whether the account is underwritten\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"Allowed debit exposure limit\",\"format\":\"double\",\"example\":989.33},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"Allowed credit exposure limit\",\"format\":\"double\",\"example\":100.33},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Whether ACH prefunding is enabled\",\"example\":false},\"achCompanyId\":{\"type\":\"string\",\"description\":\"ACH company ID for the account\",\"nullable\":true,\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"List of allowed SEC codes (e.g., WEB, TEL)\",\"items\":{\"type\":\"string\",\"example\":\"WEB\"}}},\"description\":\"ACH (Automated Clearing House) related capabilities\"},\"GetAccountSweepsResponse_sweepFrom_frequency\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Frequency at which the sweep-in is executed.\",\"example\":\"Weekly\",\"enum\":[\"Daily\",\"Weekly\",\"Monthly\"]},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-in is executed.\",\"example\":\"Monday\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"dayOfMonth\":{\"type\":\"number\",\"description\":\"Day of the month when the sweep-in is executed.\",\"format\":\"int\",\"example\":6}},\"description\":\"Frequency configuration for sweep-in execution.\"},\"GetAccountSweepsResponse_sweepTo_frequency\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Frequency at which the sweep-out is executed.\",\"example\":\"Monthly\",\"enum\":[\"Daily\",\"Weekly\",\"Monthly\"]},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-out is executed.\",\"example\":\"Monday\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"dayOfMonth\":{\"type\":\"number\",\"description\":\"Day of the month when the sweep-out is executed.\",\"format\":\"int\",\"example\":12}},\"description\":\"Frequency configuration for sweep-out execution.\"},\"GetAccountSweepsResponse_sweepTo\":{\"type\":\"object\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Unique identifier of the sweep-out beneficiary.\",\"example\":\"1234\"},\"paymentMethod\":{\"type\":\"string\",\"description\":\"Payment method used to execute the sweep-out.\",\"example\":\"AchCredit\",\"enum\":[\"AchCredit\",\"WirePayment\",\"InstantPayment\"]},\"frequency\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_sweepTo_frequency\"}},\"description\":\"Configuration for sweeping funds out of the account.\"},\"CustomerLookUpResponse_additionalAttributes\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"example\":\"1196\"},\"level\":{\"type\":\"string\",\"example\":\"Customer\"},\"attributeName\":{\"type\":\"string\",\"example\":\"ACCOUNT_TYPE\"},\"value\":{\"type\":\"string\",\"example\":\"Checking\"},\"entityType\":{\"type\":\"string\",\"example\":\"Customer\"}}},\"inline_response_400\":{\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message indicating an issue in the API call.\",\"example\":\"Requested feeTier (Gold) is invalid or not found in the system.\"}}},\"accounts_accountUID_body\":{\"required\":[\"action\",\"reason\"],\"type\":\"object\",\"properties\":{\"action\":{\"type\":\"string\",\"description\":\"The action to be performed on the bank account. Allowed values are Activate or Close.\"},\"reason\":{\"type\":\"string\",\"description\":\"The reason for performing the action\"}}},\"inline_response_200\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Response code indicating success or failure.\"},\"message\":{\"type\":\"string\",\"description\":\"Detailed response message.\"}}},\"inline_response_200_1\":{\"type\":\"object\",\"properties\":{\"data\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse\"}}},\"customerId_limits_body\":{\"required\":[\"paymentRail\"],\"type\":\"object\",\"properties\":{\"paymentAmount\":{\"type\":\"number\",\"description\":\"Specifies the amount to be used for the payment. It is used to determine whether the payment exceeds any defined limits based on the value provided during payment initiation. If not specified, the amount defaults to zero.\",\"format\":\"double\",\"example\":100.55},\"deliveryDate\":{\"type\":\"string\",\"description\":\"Format: String with valid format as: MM-DD-YYYY.\\n\\nThe date on which the payment is scheduled to be initiated. This is used to validate the customer's payment limits. If not provided, the current date will be used as the payment date.\\n\",\"example\":\"06-30-2025\"},\"paymentRail\":{\"type\":\"string\",\"description\":\"The delivery method for the payment.\\n\\nAcceptable values:\\n  - FEDWIRE: Fedwire payment\\n  - FEDNOW: FedNow real-time payment\\n  - RTP: Real-Time Payments\\n  - ACH: Automated Clearing House payment\\n  \\n\",\"example\":\"FEDNOW\",\"enum\":[\"FEDWIRE\",\"FEDNOW\",\"RTP\",\"ACH\"]},\"secCode\":{\"maxLength\":3,\"minLength\":3,\"type\":\"string\",\"description\":\"An SEC code (Standard Entry Class Code) is a three-letter code that describes how a payment was authorized by the consumer or business receiving an ACH transaction.\\n\\nThis is an optional field and is applicable only when the delivery method is set to \\\"ACH\\\".\\n\",\"example\":\"CCD\",\"enum\":[\"POP\",\"CCD\",\"PPD\",\"WEB\",\"CTX\"]},\"entryType\":{\"type\":\"string\",\"description\":\"Specifies the entry type of the ACH transaction. It defines the direction of funds movement.\\n\\nThis field is required **only if**:\\n  - `secCode` is provided, **and**\\n  - `paymentRail` is set to \\\"ACH\\\".\\n\\nAllowed values:\\n  - CREDIT\\n  - DEBIT\\n\",\"example\":\"CREDIT\",\"enum\":[\"CREDIT\",\"DEBIT\"]}}},\"inline_response_200_2\":{\"type\":\"object\",\"properties\":{\"limits\":{\"type\":\"array\",\"description\":\"A list of relevant limits for the given request.\",\"items\":{\"$ref\":\"#/components/schemas/inline_response_200_2_limits\"}}}},\"inline_response_400_1\":{\"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\":{\"$ref\":\"#/components/schemas/inline_response_400_1_errors\"}}}},\"inline_response_403\":{\"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\":{\"$ref\":\"#/components/schemas/inline_response_403_errors\"}}}},\"inline_response_500\":{\"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\":{\"$ref\":\"#/components/schemas/inline_response_500_errors\"}}}},\"GetCustomerDetailResponse_additionalAttributes\":{\"type\":\"object\",\"properties\":{\"attributeName\":{\"type\":\"string\",\"description\":\"Name of the custom attribute\",\"example\":\"CUSTOMER_LEGACY_ID\"},\"value\":{\"type\":\"string\",\"description\":\"Value of the custom attribute\",\"example\":\"AGHJ66786KLM\"}}},\"V3CreateAccountRequest_accountFeatures_fedWireFeature_1\":{\"type\":\"object\",\"properties\":{\"enableWire\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable FedWire functionality for this account.\\n\\nIf set to `true`, at least one of `enableDomesticWire` or `enableInternationalWire` must also be `true`.\\n\\nIf set to `false`, both `enableDomesticWire` and `enableInternationalWire` must also be `false`.                 \\n\",\"example\":true},\"enableInternationalWire\":{\"type\":\"boolean\",\"description\":\"Indicates whether international FedWire transfers are enabled for the account.\\n\\nMust be set to `false` if `enableWire` is `false`.                  \\n\",\"example\":true},\"enableDomesticWire\":{\"type\":\"boolean\",\"description\":\"Indicates whether domestic FedWire transfers are enabled for the account.\\n\\nMust be set to `false` if `enableWire` is `false`.                  \\n\",\"example\":true},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Enables callback notifications for wire transactions.\\n\\nRequires `enableDomesticWire` to be `true`. If enabled, a valid `callbackLimit` can also be provided.\\n\",\"example\":true},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Defines the maximum transaction limit that triggers a callback when `enableCallbacks` is `true`.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.                  \\n\",\"format\":\"BigDecimal\",\"example\":1220.55}},\"description\":\"Configuration settings related to FedWire capabilities for the account.\"},\"V3CreateAccountRequest_accountFeatures_fedNowFeature_1\":{\"type\":\"object\",\"properties\":{\"enableFedNow\":{\"type\":\"boolean\",\"description\":\"Master flag to enable or disable FedNow® services for the account.\\n- When set to true: FedNow is active. Receive capabilities are enabled by default `(fednowReceiveOnly = true, fednowRfpReceive = true)`. Send capabilities `(fednowSend, fednowRfpSend)` must be explicitly set to true. Deprecated fields `(fednowSendOrReceive, fednowReceiveOnly, fednowRfpReceive)` are supported for backward compatibility but new fields take precedence.  \\n- When set to false: FedNow is disabled; all related operations, including send and deprecated fields, are considered false.\\n\",\"example\":true},\"fednowSend\":{\"type\":\"boolean\",\"description\":\"Enables sending payments via FedNow.\\n- Only effective when enableFedNow = true.\\n- Overrides deprecated fednowSendOrReceive if both are provided.\\n\",\"example\":true},\"fednowRfpSend\":{\"type\":\"boolean\",\"description\":\"Enables the capability to **send Request for Payment (RFP)** messages through FedNow.\\n\\nRFP allows the account to initiate payment requests to other FedNow participants.\\n\",\"example\":true}},\"description\":\"Configuration settings related to FedNow® instant payment capabilities for the account.\\n\\n **Deprecated Fields**:\\n   - `fednowSendOrReceive` `(Boolean)` → Use `fednowSend` instead.\\n   - `fednowReceiveOnly` `(Boolean)` → Receive is now enabled automatically via `enableFedNow`.\\n   - `fednowRfpReceive` `(Boolean)` → Receive RFP is now enabled automatically via `enableFedNow`.\\n\\n \\n Notes: \\n   - Deprecated fields are supported for backward compatibility.\\n   - They will be removed in version `7.0.0.0`.\\n   - When both new and deprecated fields are provided, new fields take precedence.\\n   - For updates, only explicitly provided fields are modified; omitted fields remain unchanged.\\n\"},\"V3CreateAccountRequest_accountFeatures_rtpFeature_1\":{\"type\":\"object\",\"properties\":{\"enableRtp\":{\"type\":\"boolean\",\"description\":\"Master flag to enable or disable Rtp® services for the account.\\n- When set to true: Rtp is active. Receive capabilities are enabled by default `(rtpReceiveOnly = true, rtpRfpReceive = true)`. Send capabilities `(rtpSend, rtpRfpSend)` must be explicitly set to true. Deprecated fields `(rtpSendOrReceive, rtpReceiveOnly, rtpRfpReceive)` are supported for backward compatibility but new fields take precedence.  \\n- When set to false: Rtp is disabled; all related operations, including send and deprecated fields, are considered false.                 \\n\",\"example\":true},\"rtpSend\":{\"type\":\"boolean\",\"description\":\"Enables sending payments via Rtp.\\n- Only effective when enableRtp = true.\\n- Overrides deprecated rtpSendOrReceive if both are provided.       \\n\",\"example\":false},\"rtpRfpSend\":{\"type\":\"boolean\",\"description\":\"Enables the capability to **send Request for Payment (RFP)** messages through Rtp.\\n\\nRFP allows the account to initiate payment requests to other Rtp participants.                \\n\",\"example\":true}},\"description\":\"Configuration settings related to RTP (Real-Time Payments) capabilities for the account.\\n\\n**Deprecated Fields**:\\n  - `rtpSendOrReceive` `(Boolean)` → Use `rtpSend` instead.\\n  - `rtpReceiveOnly` `(Boolean)` → Receive is now enabled automatically via `enableRtp`.\\n  - `rtpRfpReceive` `(Boolean)` → Receive RFP is now enabled automatically via `enableRtp`.\\n\\nNotes: \\n  - Deprecated fields are supported for backward compatibility.\\n  - They will be removed in version `7.0.0.0`.\\n  - When both new and deprecated fields are provided, new fields take precedence.\\n  - For updates, only explicitly provided fields are modified; omitted fields remain unchanged.\\n\"},\"V3CreateAccountRequest_accountFeatures_achFeature_1\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable ACH functionality for this account.  \\n\\nThis field is required to be enabled if ACH features are active.\\n\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Indicates whether offset functionality is enabled for the ACH account.\",\"example\":true},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Marks this account as the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'. \\n\",\"example\":true},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Enables \\\"Underwritten\\\" mode for the ACH account, allowing controlled credit and debit exposure limits.\\n\\nThis option cannot be enabled if `enableAchPrefund` is set to `true`.\\n\\nRequired in order to define `debitExposureLimit` and `creditExposureLimit`.                 \\n\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed debit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable either when `enableUnderWritten` or `enableAchPrefund` is set to `true`.                  \\n\",\"format\":\"BigDecimal\",\"example\":1677},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed credit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                 \\n\",\"format\":\"BigDecimal\",\"example\":2000},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Enables ACH prefunding for the account.\\n\\nPrefunding ensures sufficient funds are reserved for ACH Credit payments before they are processed.\\n\\nCannot be enabled if `enableUnderWritten` is also enabled.\\n\\nRequired in order to define `debitExposureLimit`.\\n\",\"example\":false},\"achCompanyId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH Company ID assigned to the originator by the financial institution or the ACH operator.  \\nThis field is required when `enableACH` is set to true.\\n\",\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"A list of valid Standard Entry Class (SEC) codes associated with the ACH account.\\n\",\"example\":[\"WEB\",\"CCD\",\"PPD\",\"TEL\",\"IAT\",\"ARC\",\"BOC\",\"RCK\",\"POP\",\"XCK\"],\"items\":{\"type\":\"string\"}}},\"description\":\"Configuration settings related to ACH (Automated Clearing House) payment capabilities.\"},\"V3CreateAccountRequest_accountFeatures\":{\"type\":\"object\",\"properties\":{\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Whether account analysis is enabled.\",\"example\":true},\"feeAccount\":{\"type\":\"string\",\"description\":\"Whether the account is a fee account (Yes/No).\",\"example\":\"No\"},\"returnAccount\":{\"type\":\"string\",\"description\":\"Whether the account is a return account (Yes/No).\",\"example\":\"Yes\"},\"fedWireFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_fedWireFeature_1\"},\"fedNowFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_fedNowFeature_1\"},\"rtpFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_rtpFeature_1\"},\"achFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_achFeature_1\"}},\"description\":\"Account-level feature toggles and capabilities.\"},\"V3CreateAccountRequest_additionalAttributes\":{\"type\":\"object\",\"properties\":{\"attributeName\":{\"type\":\"string\",\"description\":\"Custom attribute name.\",\"example\":\"isRequired\"},\"value\":{\"type\":\"string\",\"description\":\"Value for the custom attribute.\",\"example\":\"true\"}}},\"V3UpdateAccountRequest_accountFeatures_achFeature_1\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Master switch to enable or disable ACH functionality for this account.\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Indicates whether offset functionality is enabled for the ACH account.\",\"example\":true},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Marks this account as the default offset account. \\nPossible values are 'Yes' or 'No'. \\nIf no account exists for the given `achCompanyId` and it is unique, the system will automatically set the default offset value to 'Yes'. \\n\",\"example\":true},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Enables \\\"Underwritten\\\" mode for the ACH account, allowing controlled credit and debit exposure limits.\\n\\nThis option cannot be enabled if `enableAchPrefund` is set to `true`.\\n\\nRequired in order to define `debitExposureLimit` and `creditExposureLimit`.                 \\n\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed debit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                  \\n\",\"format\":\"BigDecimal\",\"example\":1677},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"The maximum allowed credit exposure amount for the ACH account under underwritten mode.\\n\\nMust be a non-negative value (≥ 0.00) and must not exceed 999,999,999.99.\\n\\nThis field is applicable only when `enableUnderWritten` is set to `true`.                 \\n\",\"format\":\"BigDecimal\",\"example\":2000},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Enables ACH prefunding for the account.\\n\\nPrefunding ensures sufficient funds are reserved for ACH Credit payments before they are processed.\\n\\nCannot be enabled if `enableUnderWritten` is also enabled.\\n\",\"example\":false},\"achCompanyId\":{\"maxLength\":10,\"type\":\"string\",\"description\":\"ACH Company ID assigned to the originator by the financial institution or the ACH operator.\\nThis field is required when `enableACH` is set to true.\\n\",\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"A list of valid Standard Entry Class (SEC) codes associated with the ACH account.\\n\",\"example\":[\"WEB\",\"CCD\",\"PPD\",\"TEL\",\"IAT\",\"ARC\",\"BOC\",\"RCK\",\"POP\",\"XCK\"],\"items\":{\"type\":\"string\"}}},\"description\":\"Configuration settings related to ACH (Automated Clearing House) payment capabilities.\"},\"V3UpdateAccountRequest_accountFeatures\":{\"type\":\"object\",\"properties\":{\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Whether account analysis is enabled.\",\"example\":true},\"feeAccount\":{\"type\":\"string\",\"description\":\"Whether the account is a fee account (Yes/No).\",\"example\":\"Yes\"},\"returnAccount\":{\"type\":\"string\",\"description\":\"Whether the account is a return account (Yes/No).\",\"example\":\"No\"},\"fedWireFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_fedWireFeature_1\"},\"fedNowFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_fedNowFeature_1\"},\"rtpFeature\":{\"$ref\":\"#/components/schemas/V3CreateAccountRequest_accountFeatures_rtpFeature_1\"},\"achFeature\":{\"$ref\":\"#/components/schemas/V3UpdateAccountRequest_accountFeatures_achFeature_1\"}},\"description\":\"Account-level feature toggles and capabilities.\"},\"V3GetAccountResponse_accountFeatures_fedWireFeature_1\":{\"type\":\"object\",\"properties\":{\"enableWire\":{\"type\":\"boolean\",\"description\":\"Whether wire transfer is enabled\",\"example\":true},\"callbackLimit\":{\"type\":\"number\",\"description\":\"Callback limit for wire transactions\",\"format\":\"double\",\"example\":980.99},\"enableCallbacks\":{\"type\":\"boolean\",\"description\":\"Whether callback notifications are enabled\",\"example\":true},\"enableInternationalWire\":{\"type\":\"boolean\",\"description\":\"Whether international wire is enabled\",\"example\":true},\"enableDomesticWire\":{\"type\":\"boolean\",\"description\":\"Whether domestic wire is enabled\",\"example\":true}},\"description\":\"Features related to FedWire payments\"},\"V3GetAccountResponse_accountFeatures_fedNowFeature_1\":{\"type\":\"object\",\"properties\":{\"enableFedNow\":{\"type\":\"boolean\",\"description\":\"Whether FedNow is enabled\",\"example\":false},\"fednowReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Whether only receiving is enabled for FedNow\",\"example\":false},\"fednowSendOrReceive\":{\"type\":\"boolean\",\"description\":\"Whether send/receive is allowed for FedNow\",\"example\":false},\"fednowRfpSend\":{\"type\":\"boolean\",\"description\":\"Whether RFP send is allowed via FedNow\",\"example\":false},\"fednowSend\":{\"type\":\"boolean\",\"description\":\"Whether send is allowed via FedNow\",\"example\":false},\"fednowRfpReceive\":{\"type\":\"boolean\",\"description\":\"Whether RFP receive is allowed via FedNow\",\"example\":false}},\"description\":\"Features related to FedNow instant payment service\"},\"V3GetAccountResponse_accountFeatures_rtpFeature_1\":{\"type\":\"object\",\"properties\":{\"enableRtp\":{\"type\":\"boolean\",\"description\":\"Whether RTP is enabled\",\"example\":false},\"rtpReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Whether only receiving is enabled for RTP\",\"example\":false},\"rtpSendOrReceive\":{\"type\":\"boolean\",\"description\":\"Whether sending/receiving is allowed for RTP\",\"example\":false},\"rtpRfpSend\":{\"type\":\"boolean\",\"description\":\"Whether RFP send is allowed via RTP\",\"example\":false},\"rtpSend\":{\"type\":\"boolean\",\"description\":\"Whether send is allowed via RTP\",\"example\":false},\"rtpRfpReceive\":{\"type\":\"boolean\",\"description\":\"Whether RFP receive is allowed via RTP\",\"example\":false}},\"description\":\"Features related to RTP (Real-Time Payments)\"},\"V3GetAccountResponse_accountFeatures_achFeature_1\":{\"type\":\"object\",\"properties\":{\"enableACH\":{\"type\":\"boolean\",\"description\":\"Whether ach is enabled for the account\",\"example\":true},\"enableOffset\":{\"type\":\"boolean\",\"description\":\"Whether offset is enabled for ACH\",\"example\":false},\"defaultOffset\":{\"type\":\"boolean\",\"description\":\"Whether this account is a default offset account\",\"example\":false},\"enableUnderWritten\":{\"type\":\"boolean\",\"description\":\"Whether the account is underwritten\",\"example\":true},\"debitExposureLimit\":{\"type\":\"number\",\"description\":\"Allowed debit exposure limit\",\"format\":\"double\",\"example\":989.33},\"creditExposureLimit\":{\"type\":\"number\",\"description\":\"Allowed credit exposure limit\",\"format\":\"double\",\"example\":100.33},\"enableAchPrefund\":{\"type\":\"boolean\",\"description\":\"Whether ACH prefunding is enabled\",\"example\":false},\"achCompanyId\":{\"type\":\"string\",\"description\":\"ACH company ID for the account\",\"nullable\":true,\"example\":\"1234567890\"},\"secCodes\":{\"type\":\"array\",\"description\":\"List of allowed SEC codes (e.g., WEB, TEL)\",\"items\":{\"type\":\"string\",\"example\":\"WEB\"}}},\"description\":\"ACH (Automated Clearing House) related capabilities\"},\"V3GetAccountResponse_accountFeatures\":{\"type\":\"object\",\"properties\":{\"rfpReceive\":{\"type\":\"boolean\",\"description\":\"Whether Request-for-Pay (RFP) receive is allowed\",\"example\":false},\"rfpSend\":{\"type\":\"boolean\",\"description\":\"Whether Request-for-Pay (RFP) send is allowed\",\"example\":false},\"accountAnalysis\":{\"type\":\"boolean\",\"description\":\"Indicates whether account analysis is enabled\",\"example\":false},\"feeAccount\":{\"type\":\"string\",\"description\":\"Whether the account is marked as a fee account\",\"example\":\"false\"},\"returnAccount\":{\"type\":\"string\",\"description\":\"Whether the account is a return account\",\"example\":\"false\"},\"fedWireFeature\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_accountFeatures_fedWireFeature_1\"},\"fedNowFeature\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_accountFeatures_fedNowFeature_1\"},\"rtpFeature\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_accountFeatures_rtpFeature_1\"},\"achFeature\":{\"$ref\":\"#/components/schemas/V3GetAccountResponse_accountFeatures_achFeature_1\"}},\"description\":\"Features and capabilities enabled for the account\"},\"V3GetAccountResponse_additionalAttributes\":{\"type\":\"object\",\"properties\":{\"attributeName\":{\"type\":\"string\",\"description\":\"Name of the custom attribute\",\"example\":\"IsRequired\"},\"value\":{\"type\":\"string\",\"description\":\"Value of the custom attribute\",\"example\":\"true\"}}},\"V3AccountBadResponse_errors\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Error message describing the issue.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code for identifying the issue.\"}}},\"CustomerBankAccount_accountFeatures\":{\"type\":\"object\",\"properties\":{\"rfpReceive\":{\"type\":\"boolean\",\"description\":\"Is receiving a Request for Pay allowed from the account.\",\"example\":true},\"rfpSend\":{\"type\":\"boolean\",\"description\":\"Is sending a Request for Pay allowed from the account.\",\"example\":true}}},\"CustomerBankAccount_additionalAttributes\":{\"type\":\"object\",\"properties\":{\"attributeName\":{\"type\":\"string\",\"description\":\"Name of the custom attribute\"},\"value\":{\"type\":\"string\",\"description\":\"Value of the custom attribute\"}}},\"CustomerContact_address\":{\"properties\":{\"addressLine1\":{\"type\":\"string\",\"description\":\"Address line 1\",\"example\":\"111 My Street\"},\"addressLine2\":{\"type\":\"string\",\"description\":\"Address Line 2\",\"example\":\"Suite 210\"},\"city\":{\"type\":\"string\",\"description\":\"City\",\"example\":\"Charlotte\"},\"state\":{\"type\":\"string\",\"description\":\"State\",\"example\":\"North Carolina\"},\"postalCode\":{\"type\":\"string\",\"description\":\"Postal code\",\"example\":\"28269\"},\"countryCode\":{\"type\":\"string\",\"description\":\"ISO country code\",\"example\":\"US\"}}},\"GetAccountSweepsResponse_range\":{\"type\":\"object\",\"properties\":{\"fromAmount\":{\"type\":\"number\",\"description\":\"Specifies the minimum amount for sweep-in.\",\"format\":\"double\",\"example\":100.22},\"toAmount\":{\"type\":\"number\",\"description\":\"Specifies the maximum amount for sweep-out.\",\"format\":\"double\",\"example\":100.22}},\"description\":\"Defines the sweep amount range for sweep-in and sweep-out.\"},\"GetAccountSweepsResponse_sweepFrom_frequency_1\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Frequency at which the sweep-in is executed.\",\"example\":\"Weekly\",\"enum\":[\"Daily\",\"Weekly\",\"Monthly\",\"INTRADAY\"]},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-in is executed.\",\"example\":\"Monday\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"dayOfMonth\":{\"type\":\"number\",\"description\":\"Day of the month when the sweep-in is executed.\",\"format\":\"int\",\"example\":6},\"scheduleType\":{\"type\":\"string\",\"description\":\"Type of sweep schedule configuration.\",\"example\":\"Interval\"},\"intervalTime\":{\"type\":\"string\",\"description\":\"Defines how frequently the sweep runs within the day when scheduleType is INTERVAL.\",\"example\":\"Every 30 minutes\",\"enum\":[\"Every 30 minutes\",\"Every 1 hour\",\"Every 2 hours\",\"Every 3 hours\",\"Every 4 hours\"]},\"specificTimes\":{\"type\":\"array\",\"description\":\"Specific times when the sweep should execute when scheduleType is SPECIFIC_TIMES.\",\"example\":[\"10:00\",\"12:00\",\"21:00\"],\"items\":{\"type\":\"string\",\"format\":\"time\"}}},\"description\":\"Frequency configuration for sweep-in execution.\"},\"GetAccountSweepsResponse_sweepFrom\":{\"type\":\"object\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Unique identifier of the sweep-in beneficiary.\",\"example\":\"1234\"},\"paymentMethod\":{\"type\":\"string\",\"description\":\"Payment method used to execute the sweep-in.\",\"example\":\"InstantRFP\",\"enum\":[\"AchDebit\",\"WireDrawdown\",\"InstantRFP\"]},\"frequency\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_sweepFrom_frequency_1\"}},\"description\":\"Configuration for sweeping funds into the account.\"},\"GetAccountSweepsResponse_sweepTo_1_frequency\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Frequency at which the sweep-out is executed.\",\"example\":\"Monthly\",\"enum\":[\"Daily\",\"Weekly\",\"Monthly\"]},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-out is executed.\",\"example\":\"Monday\",\"enum\":[\"MONDAY\",\"TUESDAY\",\"WEDNESDAY\",\"THURSDAY\",\"FRIDAY\",\"SATURDAY\",\"SUNDAY\"]},\"dayOfMonth\":{\"type\":\"number\",\"description\":\"Day of the month when the sweep-out is executed.\",\"format\":\"int\",\"example\":12},\"scheduleType\":{\"type\":\"string\",\"description\":\"Type of sweep schedule configuration.\",\"example\":\"Interval\"},\"intervalTime\":{\"type\":\"string\",\"description\":\"Defines how frequently the sweep runs within the day when scheduleType is INTERVAL.\",\"example\":\"Every 30 minutes\",\"enum\":[\"Every 30 minutes\",\"Every 1 hour\",\"Every 2 hours\",\"Every 3 hours\",\"Every 4 hours\"]},\"specificTimes\":{\"type\":\"array\",\"description\":\"Specific times when the sweep should execute when scheduleType is SPECIFIC_TIMES.\",\"example\":[\"10:00\",\"12:00\",\"21:00\"],\"items\":{\"type\":\"string\",\"format\":\"time\"}}},\"description\":\"Frequency configuration for sweep-out execution.\"},\"GetAccountSweepsResponse_sweepTo_1\":{\"type\":\"object\",\"properties\":{\"contactId\":{\"type\":\"string\",\"description\":\"Unique identifier of the sweep-out beneficiary.\",\"example\":\"1234\"},\"paymentMethod\":{\"type\":\"string\",\"description\":\"Payment method used to execute the sweep-out.\",\"example\":\"AchCredit\",\"enum\":[\"AchCredit\",\"WirePayment\",\"InstantPayment\"]},\"frequency\":{\"$ref\":\"#/components/schemas/GetAccountSweepsResponse_sweepTo_1_frequency\"}},\"description\":\"Configuration for sweeping funds out of the account.\"},\"CustomerLookUpResponse_additionalAttributes_1\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"example\":\"1196\"},\"level\":{\"type\":\"string\",\"example\":\"Customer\"},\"attributeName\":{\"type\":\"string\",\"example\":\"ACCOUNT_TYPE\"},\"value\":{\"type\":\"string\",\"example\":\"Checking\"},\"entityType\":{\"type\":\"string\",\"example\":\"Customer\"}}},\"CustomerLookUpResponse_accountFeatures_sweepOut\":{\"type\":\"object\",\"properties\":{\"targetAmount\":{\"type\":\"string\",\"description\":\"Target amount to maintain in the sweep-out account.\",\"example\":\"100\"},\"toAccount\":{\"type\":\"string\",\"description\":\"Account number where excess funds are swept out.\",\"example\":\"50100037342446\"},\"frequency\":{\"type\":\"string\",\"description\":\"Frequency of sweep-out (e.g., DAILY, WEEKLY, MONTHLY).\",\"example\":\"WEEKLY\"},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-out occurs.\",\"example\":\"Monday\"},\"speed\":{\"type\":\"string\",\"description\":\"Sweep-out transfer speed (e.g., Express, Economy).\",\"example\":\"Express\"},\"nextSweepDate\":{\"type\":\"string\",\"description\":\"Date of the next scheduled sweep-out.\",\"format\":\"date\",\"example\":\"2025-10-06\"}},\"description\":\"Details for automatic sweep-out setup.\"},\"CustomerLookUpResponse_accountFeatures_sweepIn\":{\"type\":\"object\",\"properties\":{\"targetAmount\":{\"type\":\"string\",\"description\":\"Target amount to maintain in the source account.\",\"example\":\"10\"},\"fromAccount\":{\"type\":\"string\",\"description\":\"Account number from which funds are swept in.\",\"example\":\"0987654\"},\"frequency\":{\"type\":\"string\",\"description\":\"Frequency of sweep-in (e.g., DAILY, WEEKLY, MONTHLY).\",\"example\":\"WEEKLY\"},\"dayOfWeek\":{\"type\":\"string\",\"description\":\"Day of the week when the sweep-in occurs.\",\"example\":\"Monday\"},\"speed\":{\"type\":\"string\",\"description\":\"Sweep-in transfer speed (e.g., Express, Economy).\",\"example\":\"Economy\"},\"nextSweepDate\":{\"type\":\"string\",\"description\":\"Date of the next scheduled sweep-in.\",\"format\":\"date\",\"example\":\"2025-10-06\"}},\"description\":\"Details for automatic sweep-in setup.\"},\"CustomerLookUpResponse_accountFeatures\":{\"type\":\"object\",\"properties\":{\"sweepOut\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse_accountFeatures_sweepOut\"},\"sweepIn\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse_accountFeatures_sweepIn\"},\"rfpSend\":{\"type\":\"boolean\",\"description\":\"Indicates if Request for Payment (RFP) sending is enabled.\",\"example\":true},\"rfpReceive\":{\"type\":\"boolean\",\"description\":\"Indicates if Request for Payment (RFP) receiving is enabled.\",\"example\":true},\"rtpReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Indicates if RTP (Real-Time Payments) receive-only mode is enabled.\",\"example\":true},\"rtpSendAndReceive\":{\"type\":\"boolean\",\"description\":\"Indicates if RTP send and receive functionality is enabled.\",\"example\":false},\"rtpRfpSend\":{\"type\":\"boolean\",\"description\":\"Indicates if RTP Request for Payment sending is enabled.\",\"example\":false},\"rtpRfpReceive\":{\"type\":\"boolean\",\"description\":\"Indicates if RTP Request for Payment receiving is enabled.\",\"example\":false},\"fednowReceiveOnly\":{\"type\":\"boolean\",\"description\":\"Indicates if FedNow receive-only mode is enabled.\",\"example\":false},\"fednowSendAndReceive\":{\"type\":\"boolean\",\"description\":\"Indicates if FedNow send and receive functionality is enabled.\",\"example\":true},\"fednowRfpSend\":{\"type\":\"boolean\",\"description\":\"Indicates if FedNow Request for Payment sending is enabled.\",\"example\":true},\"fednowRfpReceive\":{\"type\":\"boolean\",\"description\":\"Indicates if FedNow Request for Payment receiving is enabled.\",\"example\":true}},\"description\":\"Account-level feature configurations and sweep details.\"},\"CustomerLookUpResponse_profiles\":{\"type\":\"object\",\"properties\":{\"lookupType\":{\"type\":\"string\",\"example\":\"DDA\"},\"lookupId\":{\"type\":\"string\",\"example\":\"108760001200\"},\"legalEntityId\":{\"type\":\"string\",\"example\":\"984\"},\"legalEntityStatus\":{\"type\":\"string\",\"example\":\"Active\"},\"fullName\":{\"type\":\"string\",\"example\":\"Aaron Smith\"},\"processingOrgId\":{\"type\":\"string\"},\"processingOrg\":{\"type\":\"string\"},\"shortName\":{\"type\":\"string\"},\"companyId\":{\"type\":\"string\",\"example\":\"173488\"},\"customerType\":{\"type\":\"string\",\"example\":\"CORPORATE\"},\"customerId\":{\"type\":\"string\",\"example\":\"173487\"},\"costCenter\":{\"type\":\"string\",\"example\":\"38\"},\"addressLine1\":{\"type\":\"string\",\"example\":\"12345 Main Street\"},\"addressLine2\":{\"type\":\"string\",\"example\":\"Apt 4B\"},\"city\":{\"type\":\"string\",\"example\":\"New York\"},\"state\":{\"type\":\"string\",\"example\":\"NY\"},\"zip\":{\"type\":\"string\",\"example\":\"12345678\"},\"accountAnalysis\":{\"type\":\"boolean\",\"example\":false},\"countryISOCode\":{\"type\":\"string\",\"example\":\"US\"},\"partnerOrg\":{\"type\":\"string\",\"example\":\"Partner\"},\"transactionAccountId\":{\"type\":\"string\"},\"transactionAccountNumber\":{\"type\":\"string\",\"example\":\"108760001200\"},\"transactionAccountRoutingNumber\":{\"type\":\"string\",\"example\":\"071212128\"},\"transactionAccountName\":{\"type\":\"string\",\"example\":\"test 108760001200\"},\"transactionAccountType\":{\"type\":\"string\",\"example\":\"Deposit\"},\"transactionAccountSubType\":{\"type\":\"string\",\"example\":\"DDA\"},\"bankAccountStatus\":{\"type\":\"string\",\"example\":\"Active\"},\"status\":{\"type\":\"string\",\"example\":\"SUCCESS\"},\"errorDescription\":{\"type\":\"string\"},\"transactionAccountCostcenter\":{\"type\":\"string\",\"example\":\"38\"},\"bankAccountAlias\":{\"type\":\"string\",\"example\":\"DDA account\"},\"legalEntityAlias\":{\"type\":\"string\",\"example\":\"bank account\"},\"emailAddress\":{\"type\":\"string\",\"example\":\"test@finzly.com\"},\"additionalAttributes\":{\"type\":\"array\",\"description\":\"List of additional attributes for the customer\",\"items\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse_additionalAttributes_1\"}},\"country\":{\"type\":\"string\",\"example\":\"UNITED STATES OF AMERICA\"},\"systemOfRecords\":{\"type\":\"string\"},\"currency\":{\"type\":\"string\"},\"enableWires\":{\"type\":\"boolean\",\"example\":false},\"enableSwift\":{\"type\":\"boolean\",\"example\":false},\"enableRTP\":{\"type\":\"boolean\",\"example\":false},\"enableFednow\":{\"type\":\"boolean\",\"example\":false},\"enableWirePayment\":{\"type\":\"boolean\",\"example\":false},\"enableACH\":{\"type\":\"boolean\",\"example\":false},\"accountFeatures\":{\"$ref\":\"#/components/schemas/CustomerLookUpResponse_accountFeatures\"},\"detailsOfCharges\":{\"type\":\"string\",\"description\":\"Indicates how charges are handled (e.g., SHA for shared, BEN for beneficiary, OUR for sender).\",\"example\":\"SHA\"},\"prefunded\":{\"type\":\"boolean\",\"example\":false}}},\"inline_response_200_2_limits\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"Code representing the specific type of limit (e.g., per-month or per-transaction).\",\"example\":\"INSTANT_PAYMENT_LIMIT_PER_MONTH\"},\"currentLimit\":{\"type\":\"number\",\"description\":\"The configured maximum allowed value for the given limit type.\",\"format\":\"double\",\"example\":15000.55},\"usedAmount\":{\"type\":\"number\",\"description\":\"Amount already used from the current limit.\",\"format\":\"double\",\"example\":5000.35},\"remainingLimit\":{\"type\":\"number\",\"description\":\"Amount remaining for use under the current limit.\",\"format\":\"double\",\"example\":10000.25},\"displayName\":{\"type\":\"string\",\"description\":\"User-friendly label for the limit type.\",\"example\":\"Instant Payment Monthly Limit\"},\"message\":{\"type\":\"string\",\"description\":\"Message providing details about the limit status or any exceedance. This can include how much the limit has been exceeded by.\\n\",\"example\":\"Monthly transaction with $10,000.00 limit has exceeded by $1,690,000.00 for lrx\"}}},\"inline_response_400_1_errors\":{\"required\":[\"code\",\"message\"],\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\",\"description\":\"Human-readable message describing the error.\",\"example\":\"Account number exceeds the maximum limit of 35 characters.\"},\"code\":{\"type\":\"string\",\"description\":\"Error code identifier.\",\"example\":\"LKUP_ACCNUM_MAX\"}}},\"inline_response_403_errors\":{\"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\":\"LKUP_ACCESS_DENIED\"}}},\"inline_response_500_errors\":{\"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\":\"LKUP_INTERNAL_ERROR\"}}}},\"responses\":{\"SignatoryBadRequest\":{\"description\":\"**HTTP 400 — Bad Request**\\n\\nThis response is returned when the request is invalid or cannot be processed.\\n\\nThe response includes a list of errors, where each error contains:\\n- `code`: A unique identifier for the error\\n- `message`: A description of the issue\\n\\n**Possible reasons include:**\\n- Missing or invalid input values\\n- Incorrect request format\\n- Invalid email or phone number\\n- Invalid approval limit values\\n- Missing required identifiers\\n- Customer not found or access not allowed\\n- Issues while processing the request\\n\\n**Common error codes:**\\n`SIG_FULLNAME_REQUIRED`, `SIG_EMAIL_REQUIRED`, `SIG_EMAIL_INVALID`,\\n`SIG_PHONE_REQUIRED`, `SIG_PHONE_INVALID`,\\n`SIG_APPROVALLIMIT_MIN`, `SIG_APPROVALLIMIT_INVALID`,\\n`SIG_PARTNERID_REQUIRED`, `SIG_CUSTOMERNOTFOUND`,\\n`SIG_CUSTOMERACCESS_DENIED`, `SIG_VALIDATION_ERROR`,\\n`SIG_SERVICECALL_FAILED`, `SIG_SIGNATORYNOTFOUND`,\\n`PHONE_SERVICECALL_FAILED`\\n\\n**Note:**\\n- Some scenarios such as \\\"not found\\\" or \\\"access denied\\\" may still return HTTP 400.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SignatoryErrorResponse\"},\"examples\":{\"validationErrors\":{\"summary\":\"Multiple input errors\",\"value\":{\"errors\":[{\"message\":\"Signatory full name is required.\",\"code\":\"SIG_FULLNAME_REQUIRED\"},{\"message\":\"Signatory email address must be a valid email address.\",\"code\":\"SIG_EMAIL_INVALID\"}]}},\"businessRule\":{\"summary\":\"Invalid request data\",\"value\":{\"errors\":[{\"message\":\"No customer information exists for the requested identifier.\",\"code\":\"SIG_CUSTOMERNOTFOUND\"}]}},\"invalidRequest\":{\"summary\":\"Invalid request format\",\"value\":{\"errors\":[{\"message\":\"Invalid request body.\",\"code\":\"SIG_VALIDATION_ERROR\"}]}}}}}},\"SignatoryUnhandledServerError\":{\"description\":\"**HTTP 500 — Internal Server Error**\\n\\nThis response is returned when an unexpected error occurs while processing the request.\\n\\nThe response includes:\\n- `code`: A standard error identifier\\n- `message`: A general message describing the failure\\n\\n**Note:**\\n- Errors related to invalid input or request data will return HTTP 400, not 500.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SignatorySimpleErrorResponse\"},\"examples\":{\"internal\":{\"summary\":\"Generic internal error response\",\"value\":{\"code\":\"SIGNATORY_INTERNAL_ERROR\",\"message\":\"An unexpected error occurred while processing the signatory request. Please try again later.\"}}}}}},\"OpenBankingUnauthorized\":{\"description\":\"**HTTP 401 — Unauthorized**\\n\\nThis response is returned when authentication is missing or invalid.\\n\\nThe response includes:\\n- `code`: A standard error identifier\\n- `message`: A message indicating that authorization is required\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SignatorySimpleErrorResponse\"},\"examples\":{\"unauthorized\":{\"summary\":\"Unauthorized request\",\"value\":{\"code\":\"SIGNATORY_UNAUTHORIZED_REQUEST\",\"message\":\"The user is not authorized to perform this operation. Please contact support.\"}}}}}},\"OpenBankingForbidden\":{\"description\":\"**HTTP 403 — Forbidden**\\n\\nThis response is returned when the request is understood but not allowed.\\n\\nThe response includes:\\n- `code`: A standard error identifier\\n- `message`: A message indicating that access is denied\\n\\n**Note:**\\n- This is different from request validation errors, which return HTTP 400.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SignatorySimpleErrorResponse\"},\"examples\":{\"forbidden\":{\"summary\":\"Access denied\",\"value\":{\"code\":\"SIGNATORY_ACCESS_FORBIDDEN\",\"message\":\"Access denied\"}}}}}}},\"securitySchemes\":{\"oAuth2\":{\"type\":\"oauth2\",\"description\":\"BankOS OpenBanking 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/customerapi/overview/","redocItemId":"tag/Customer-Signatories/operation/deleteCustomerSignatory","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"}]}},"requestLogin":false,"lastModified":"2026-04-09T12:14:41.000Z"},"seo":{"title":"Delete a signatory for a customer"}}},"pageContext":{"id":"32d54797-cb16-5bba-b1b8-db46d1e801e5operation/deleteCustomerSignatory__redocly content/openapi/customerapi/operation/deleteCustomerSignatory/","seo":{"title":"Delete a signatory for a customer","description":"Deletes the signatory identified by `signatoryId` under the given customer.\n\n**Access and authorization**\n\n- Appropriate Open Banking access is required (e.g. `mCust` in the implementation).\n- The caller's **partner identifier** must be present (`SIG_PARTNERID_REQUIRED` if missing).\n- The **customer** must exist (`SIG_CUSTOMERNOTFOUND`) and be allowed for the caller's token\n  (`SIG_CUSTOMERACCESS_DENIED`).\n\n**Validation**\n\n- No request body. Failures from missing signatory, downstream constraints, or integration issues are\n  returned as errors with appropriate codes and messages.\n","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/customerAPI.page.yaml#operation/deleteCustomerSignatory","pageBaseUrl":"/openapi/customerapi","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/customerapi/operation/deleteCustomerSignatory/","sidebarName":"training","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"customerApi","id":"customerApi","title":"customerApi","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}