{"openapi":"3.1.0","info":{"title":"Counterparties","description":"Automate payments across banks with a single API","version":"1","contact":{"name":"API Support","email":"dev@numeral.io"}},"tags":[{"name":"Account Holders","description":"Account holder endpoints"},{"name":"External Accounts","description":"External accounts endpoints"},{"name":"Internal Accounts","description":"Internal accounts endpoints"},{"name":"Direct Debit Mandates","description":"Direct debit mandates endpoints"},{"name":"Correspondent banks","description":"Correspondent bank endpoints"},{"name":"Correspondent bank accounts","description":"Correspondent bank account (nostro account) endpoints"},{"name":"Correspondent banking rules","description":"Per-currency routing rules linking a correspondent bank (and optionally a specific account) to a payment currency"}],"servers":[{"url":"https://sandbox.numeral.io/v1"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","name":"x-api-key"}},"parameters":{"list.common_parameters.sort_order":{"name":"sort_order","in":"query","description":"Order is based on attribute `created_at`. If `asc`, results are fetched in chronological order. If `desc`, results are fetched in reversed chronological order. Default order is `desc`.\n","schema":{"type":"string","enum":["asc","desc"]}},"list.common_parameters.limit":{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},"list.common_parameters.starting_after":{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}}},"responses":{"errors.400.validation":{"description":"Validation Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.404.not_found":{"description":"The specified resource was not found."},"errors.409.conflict":{"description":"Conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"errors.415.unsupported_media_type":{"description":"Unsupported Media Type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"type":"object","properties":{"error":{"type":"string","example":"validation_error"},"message":{"type":"string","example":"validation errors occurred while processing request"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}}}},"correlation_id":{"type":"string","format":"uuid"}}},"common.metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"common.custom_fields":{"type":"object","description":"Custom fields in JSON `key:value` format. See [Custom fields](ref:custom-fields)."},"accountholders.create_account_holder":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the account holder.","example":"PartnerCo SAS"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}}}},"accountholders.update_account_holder":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}}}},"accountholders.account_holder":{"type":"object","required":["id","name","object","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the account holder."},"name":{"type":"string","example":"EndCustomerCo","description":"The name of the account holder"},"object":{"type":"string","description":"Type of the object, `account_holder`.","default":"account_holder","example":"account_holder"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of this account holder."},"disabled_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the disabling of this account holder."},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}}}},"accountholders.search_result":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/accountholders.account_holder"}}}},"external_accounts.status":{"type":"string","description":"The status of this external account.","enum":["pending_approval","approved","denied","disabled"]},"external_accounts.organization_identification":{"type":"object","description":"The organization identification of the external account. See more [here](ref:organization-identifications).","properties":{"legal_entity_identifier":{"type":"string","minLength":20,"maxLength":20,"description":"The legal entity identifier (LEI) of the external account.","example":"529900T8BM49AURSDO55"},"business_identification_code":{"type":"string","minLength":8,"maxLength":11,"description":"The business identification code of the external account.","example":"SOMEBIC0XXX"},"default_other_identifier_type":{"type":"string","description":"The identification in `others` to be taken into account when creating a payment with this external account.","enum":["bank_identification","central_bank_identification","clearing_house_identification","company_incorporation_number","company_identification","customer_number","duns_number","employee_number","global_location_number","siren","siret","tax_number","telephone_number","business_domain_identification","other_identification"],"example":"siren"},"others":{"type":"array","description":"The list of other organization identifications of the external account.","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of the identification. See supported types [here](ref:organization-identifications).","enum":["bank_identification","central_bank_identification","clearing_house_identification","company_incorporation_number","company_identification","customer_number","duns_number","employee_number","global_location_number","siren","siret","tax_number","telephone_number","business_domain_identification","other_identification"],"example":"siren"},"value":{"type":"string","description":"The value of the identification.","example":"901250746"}}}}}},"external_accounts.holder_address":{"type":"object","description":"The address of the account holder, as an address object.","properties":{"line_1":{"type":"string","description":"Line 1.","example":"1, rue de la Bourse"},"line_2":{"type":"string","description":"Line 2."},"building_number":{"type":"string","description":"Building number.","example":"1"},"street_name":{"type":"string","description":"Street name.","example":"rue de la Bourse"},"postal_code":{"type":"string","description":"Postal / zip code.","example":"59000"},"region_state":{"type":"string","description":"Region or state."},"city":{"type":"string","example":"Lille","description":"City."},"country":{"type":"string","example":"FR","description":"ISO 3166 alpha-2 country code."},"department":{"type":["string","null"],"description":"Department name or code.","example":"Marketing"},"sub_department":{"type":["string","null"],"description":"Sub-department name.","example":"Content team"},"building_name":{"type":["string","null"],"description":"Name of the building.","example":"Bat. 4"},"floor":{"type":["string","null"],"description":"Floor number or identifier.","example":"3"},"postal_box":{"type":["string","null"],"description":"Postal box.","example":"67b"},"room":{"type":["string","null"],"description":"Room number.","example":"47"},"city_location_name":{"type":["string","null"],"description":"Specific city location or landmark.","example":"Confluences"},"district_name":{"type":["string","null"],"description":"District name or administrative region.","example":"District 9"}}},"external_accounts.account_verification":{"type":"object","description":"The result of the latest verification ran against the external account.","required":["result"],"properties":{"result":{"type":"string","enum":["valid","invalid","pending_verification"],"description":"The overall result of the specific verification.","example":"valid"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp the verification was performed at."},"valid_account_number":{"$ref":"#/components/schemas/external_accounts.account_verification_item","description":"Result of the validation performed on the account number."},"matching_account_number_and_bank_code":{"$ref":"#/components/schemas/external_accounts.account_verification_item","description":"Result of the validation performed on the match between account number and bank code."},"matching_account_holder":{"$ref":"#/components/schemas/external_accounts.account_verification_item","description":"Result of the validation performed on the account holder."},"active_account":{"$ref":"#/components/schemas/external_accounts.account_verification_item","description":"Result of the validation performed on the account status."}}},"external_accounts.account_verification_item":{"type":"object","description":"The result of a specific verification.","required":["result"],"properties":{"result":{"type":"string","enum":["valid","invalid","impossible_to_verify","not_verified"],"description":"The result of this specific verification.","example":"valid"},"details":{"$ref":"#/components/schemas/external_accounts.account_verification_item_details","description":"In case of error, an object that gives additional information."}}},"external_accounts.account_verification_item_details":{"type":"object","description":"The details of a specific verification.","properties":{"reason":{"type":"string","description":"A specific code that gives additional information on what caused the failure.","example":"unauthorized_characters"},"expected_value":{"type":"string","description":"When available, the value that was expected in order to pass the validation.","example":"SOMEBIC0XXX"},"message":{"type":"string","description":"A user friendly message describing the failure.","example":"IBAN contains unauthorized characters"}}},"external_accounts.create_external_account":{"type":"object","required":["holder_name","account_number","bank_code"],"properties":{"type":{"type":"string","description":"The type of the external account.","enum":["individual","legal_entity"]},"name":{"type":"string","description":"The name of the external account."},"holder_name":{"type":"string","description":"The name of the legal entity or individual holding the account.","example":"PartnerCo SAS"},"account_number":{"type":"string","description":"The account number.","example":"FR7601234567891127967100082"},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`.","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code":{"type":"string","description":"The bank code, for instance BIC / Swift code, UK sort code, or US routing number.","example":"BNPAFRPPXXX"},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`.","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"account_holder_id":{"type":"string","description":"The ID of the related account holder. It must not be disabled.","example":"0b441172-4945-11ed-b878-0242ac120002"},"organization_identification":{"$ref":"#/components/schemas/external_accounts.organization_identification"},"company_registration_number":{"type":"string","description":"The company registration number of the external account, when `type` = `legal_entity`."},"company_registration_number_type":{"type":"string","description":"The type of the external account's company registration number, when `type` = `legal_entity`.","enum":["eu_vat","fr_siren","fr_siret","nl_kvk","nl_kvk_branch","other","uk_crn"]},"holder_address":{"$ref":"#/components/schemas/external_accounts.holder_address"},"bank_name":{"type":"string","example":"BankCo","description":"The name of the bank holding the account."},"bank_address":{"$ref":"#/components/schemas/common.address","description":"The address of the bank holding the account."},"accept_duplicate_account_number":{"type":"boolean","default":false,"description":"Controls whether duplicate account detection includes the account holder's name as part of the uniqueness check.\n- If `false` (default), the API will return an error if an active `external_account` already exists with the same `account_number` and `bank_code`.\n- If `true`, the error is only triggered when an active `external_account` matches on `account_number`, `bank_code`, and `holder_name`, allowing duplicate account numbers across different holders.\n"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"external_accounts.external_account":{"type":"object","required":["id","object","status","status_details","holder_name","account_number","bank_code","holder_address","account_holder_id","custom_fields","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the external account."},"object":{"type":"string","description":"Type of the object, `external_account`.","default":"external_account","example":"external_account"},"type":{"type":"string","description":"The type of the external account.","enum":["individual","legal_entity"]},"name":{"type":"string","description":"The name of the external account."},"holder_name":{"type":"string","description":"The name of the legal entity or individual holding the account.","example":"Joe Black"},"account_number":{"type":"string","description":"The account number.","example":"FR1420041010050500013M02606"},"account_number_format":{"type":"string","description":"The format of the account number.","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"account_holder_id":{"type":"string","description":"The ID of the related account holder."},"organization_identification":{"$ref":"#/components/schemas/external_accounts.organization_identification"},"company_registration_number":{"type":"string","description":"The company registration number of the external account, when `type` = `legal_entity`."},"company_registration_number_type":{"type":"string","description":"The type of the external account's company registration number, when `type` = `legal_entity`.","enum":["eu_vat","fr_siren","fr_siret","nl_kvk","nl_kvk_branch","other","uk_crn"]},"bank_code":{"type":"string","description":"The bank code. For example, a BIC or SWIFT code.","example":"BNPAFRPPXXX"},"bank_code_format":{"type":"string","description":"The format of the bank code.","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"holder_address":{"$ref":"#/components/schemas/external_accounts.holder_address"},"bank_name":{"type":"string","example":"BankCo","description":"The name of the bank holding the account."},"bank_address":{"$ref":"#/components/schemas/common.address","description":"The address of the bank holding the account."},"status":{"$ref":"#/components/schemas/external_accounts.status"},"status_details":{"type":"string","description":"The details of the status of this external account."},"account_verification":{"$ref":"#/components/schemas/external_accounts.account_verification"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of this external account."},"disabled_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the disabling of this external account."},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"external_accounts.update_external_account":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"external_accounts.deny_external_account":{"type":"object","properties":{"reason":{"type":"string","description":"The reason for the denial.","maximum":100}}},"external_accounts.search_result":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"internal_accounts.organization_identification":{"type":"object","description":"The organization identification of the internal account. See more [here](ref:organization-identifications).","properties":{"legal_entity_identifier":{"type":"string","minLength":20,"maxLength":20,"description":"The legal entity identifier (LEI) of the internal account.","example":"529900T8BM49AURSDO55"},"business_identification_code":{"type":"string","minLength":8,"maxLength":11,"description":"The business identification code of the internal account.","example":"SOMEBIC0XXX"},"default_other_identifier_type":{"type":"string","description":"The identification in `others` to be taken into account when creating a payment with this internal account.","enum":["bank_identification","central_bank_identification","clearing_house_identification","company_incorporation_number","company_identification","customer_number","duns_number","employee_number","global_location_number","siren","siret","tax_number","telephone_number","business_domain_identification","other_identification"],"example":"siren"},"others":{"type":"array","description":"The list of other organization identifications of the internal account.","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"The type of the identification. See supported types [here](ref:organization-identifications).","enum":["bank_identification","central_bank_identification","clearing_house_identification","company_incorporation_number","company_identification","customer_number","duns_number","employee_number","global_location_number","siren","siret","tax_number","telephone_number","business_domain_identification","other_identification"],"example":"siren"},"value":{"type":"string","description":"The value of the identification.","example":"901250746"}}}}}},"internal_accounts.create_internal_account":{"type":"object","required":["type","name","account_number","holder_name"],"properties":{"connected_account_ids":{"type":"array","items":{"format":"uuid","description":"The ID(s) of the connected accounts to which the internal account refers. If the type passed is `own` any number of connected account IDs is allowed: they may belong to financial institution accounts, and to corporate accounts as long as at least one financial institution account is among them. If the type passed is `virtual` multiple connected account IDs are allowed and they must belong to a corporate account.\n"}},"type":{"type":"string","description":"The type of the internal account.","enum":["own","virtual"]},"name":{"type":"string","maxLength":100,"description":"The name of the internal account.","example":"PartnerCo Main Account"},"holder_name":{"type":"string","maxLength":100,"description":"The name of the internal account holder.","example":"PartnerCo SAS"},"alternative_holder_names":{"type":"array","maxItems":100,"items":{"type":"string","maxLength":100},"description":"Alternative account holder names, for instance if the account is a joint account."},"account_number":{"type":"string","description":"The account number of the internal account. Own internal accounts accept IBANs and UK domestic account numbers, and virtual internal accounts accept any alphanumerical account numbers up to 35 characters.","example":"FR4217569000705838477329D20"},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`.","enum":["iban","uk_account_number","us_account_number","tokenized","other"],"example":"iban"},"bank_code":{"type":"string","description":"The bank code. Mandatory for internal accounts of type = `own`.","example":"SOMEBIC0XXX"},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`.","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"],"example":"bic"},"organization_identification":{"$ref":"#/components/schemas/internal_accounts.organization_identification"},"account_holder_id":{"type":"string","format":"uuid","description":"The ID of the account holder to which the internal account belongs to. It must not be disabled."},"holder_address":{"$ref":"#/components/schemas/common.address"},"bank_name":{"type":"string","example":"BankCo","description":"The name of the bank holding the account."},"bank_address":{"$ref":"#/components/schemas/common.address","description":"The address of the bank holding the account."},"creditor_identifier":{"type":"string","description":"The unique reference for organisations collecting payments by SEPA Direct Debit.","example":"FR12ZZZ123456"},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"cbs_source":{"type":"string","enum":["mambu"],"description":"The CBS this internal account refers to. Only `mambu` is supported."},"cbs_account_id":{"type":"string","maxLength":100,"description":"The ID of the account in linked CBS. Must be provided if `cbs_source` is provided.","example":"ACC-ID-CBS-0000-0000"},"cbs_account_type":{"type":"string","enum":["deposit"],"description":"The type of account in linked CBS. Only `deposit` supported. Must be provided if `cbs_source` is provided."},"synchronized_with_bank":{"type":"boolean","description":"Whether the internal account is synchronized with the bank.","example":true},"generate_account_number":{"type":"boolean","description":"Whether the account number should be automatically generated by Mambu Payments. Requires exactly one of the `connected_account_ids` to belong to a financial institution account. Contact your account manager to activate this feature.","example":true},"currencies":{"type":"array","items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies of the account.\n","example":["EUR","USD"]},"customer_bic":{"type":"string","description":"BIC of the internal account. Used for Swift correspondent payments.","example":"BNPAFRPPXXX"},"distinguished_name":{"type":"string","description":"Distinguished name (DN) of the internal account. Used for Swift correspondent payments.","example":"CN=foo,OU=bar,O=baz"}}},"internal_accounts.internal_account":{"type":"object","required":["id","object","type","name","account_number","holder_name","status","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the internal account."},"object":{"type":"string","enum":["internal_account"],"description":"The object, here `internal_account`."},"status":{"type":"string","enum":["pending_creation","creation_rejected","active","blocked","disabled"],"description":"The status of the internal account."},"connected_account_ids":{"type":"array","items":{"format":"uuid","description":"The ID(s) of the connected accounts to which the internal account refers."}},"type":{"type":"string","enum":["own","virtual"],"description":"The type of the internal account."},"name":{"type":"string","maxLength":100,"description":"The name of the internal account."},"account_number":{"type":"string","description":"The associated account number."},"account_number_format":{"type":"string","description":"The format of the account number.","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code":{"type":"string","description":"The bank code of the account."},"bank_code_format":{"type":"string","description":"The format of the bank code.","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"organization_identification":{"$ref":"#/components/schemas/internal_accounts.organization_identification"},"holder_name":{"type":"string","maxLength":100,"description":"The name of the holder the account belongs to."},"alternative_holder_names":{"type":"array","maxItems":100,"items":{"type":"string"},"description":"Alternative account holder names, for instance if the account is a joint account."},"account_holder_id":{"type":["string","null"],"format":"uuid","description":"The ID of the holder to which the account refers to."},"holder_address":{"$ref":"#/components/schemas/common.address"},"bank_name":{"type":"string","example":"BankCo","description":"The name of the bank holding the account."},"bank_address":{"$ref":"#/components/schemas/common.address","description":"The address of the bank holding the account."},"creditor_identifier":{"type":"string","description":"The unique reference for organisations collecting payments by SEPA Direct Debit.","example":"FR12ZZZ123456"},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"bank_data":{"type":"object","properties":{"message_id":{"type":"string","description":"The message ID of the internal account.","example":"1gXrtKMxLJ"},"file_id":{"type":"string","format":"uuid","description":"The file ID of the internal account.","example":"4f5ab48b-9693-4292-86f6-1c2fe347d061"}}},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of this internal account."},"cbs_source":{"type":"string","enum":["mambu"],"description":"The CBS this internal account refers to. Only `mambu` is supported."},"cbs_account_id":{"type":"string","maxLength":100,"description":"The ID of the account in linked CBS. Must be provided if `cbs_source` is provided.","example":"ACC-ID-CBS-0000-0000"},"cbs_account_type":{"type":"string","enum":["deposit"],"description":"The type of account in linked CBS. Only `deposit` supported. Must be provided if `cbs_source` is provided."},"currencies":{"type":"array","items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies of the account.\n","example":["EUR","USD"]},"customer_bic":{"type":"string","description":"BIC of the internal account. Used for Swift correspondent payments.","example":"BNPAFRPPXXX"},"distinguished_name":{"type":"string","description":"Distinguished name (DN) of the internal account. Used for Swift correspondent payments.","example":"CN=foo,OU=bar,O=baz"}}},"internal_accounts.search_result":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"internal_accounts.update":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"description":"The name of the internal account.","example":"PartnerCo Main Account"},"holder_name":{"type":"string","maxLength":100,"description":"The name of the internal account holder.","example":"PartnerCo SAS"},"alternative_holder_names":{"type":"array","maxItems":100,"items":{"type":"string","maxLength":100},"description":"Alternative account holder names, for instance if the account is a joint account."},"holder_address":{"$ref":"#/components/schemas/common.address"},"organization_identification":{"$ref":"#/components/schemas/internal_accounts.organization_identification"},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"currencies":{"type":"array","items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies of the account.\n","example":["EUR","USD"]},"customer_bic":{"type":"string","description":"BIC of the internal account. Used for Swift correspondent payments.","example":"BNPAFRPPXXX"},"distinguished_name":{"type":"string","description":"Distinguished name (DN) of the internal account. Used for Swift correspondent payments.","example":"CN=foo,OU=bar,O=baz"}}},"direct_debit_mandates.create_direct_debit_mandate":{"type":"object","required":["direction","type","connected_account_id"],"properties":{"direction":{"type":"string","description":"The direction of the direct debit mandate. An outgoing mandate aims to debit a third-party account, and an incoming mandate aims to debit an internal account. It must be `outgoing` for a corporate connected account.","enum":["outgoing","incoming"],"example":"outgoing"},"type":{"type":"string","description":"The type of the direct debit mandate.","enum":["sepa_core","sepa_b2b","bacs_debit"],"example":"sepa_core"},"connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account.","example":"ff1714ae-3ec8-450d-984c-c6ee44c82a88"},"creditor_account":{"$ref":"#/components/schemas/direct_debit_mandates.creditor_account","description":"The account to be credited. This attribute is required for financial institution connected accounts, and cannot be specified if `creditor_account_id` is filled or if connected account's type is corporate."},"originating_account":{"$ref":"#/components/schemas/direct_debit_mandates.originating_account","description":"The account to be credited. This attribute is required for financial institution connected accounts, and cannot be specified if `originating_account_id` is filled or if connected account's type is corporate.","deprecated":true},"creditor_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account to be credited. It must be left empty if `creditor_account` parameter is filled. Only supported for outgoing mandates created by financial institution connected accounts.","example":"b38f5318-a389-4278-9cbe-d16116750982"},"originating_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account to be credited. It must be left empty if `originating_account` parameter is filled or if connected account's type is corporate.","example":"b38f5318-a389-4278-9cbe-d16116750982","deprecated":true},"debtor_account":{"$ref":"#/components/schemas/direct_debit_mandates.debtor_account"},"receiving_account":{"$ref":"#/components/schemas/direct_debit_mandates.receiving_account","deprecated":true},"debtor_account_id":{"type":"string","format":"uuid","description":"The ID of the account to be debited. For outgoing mandates, it can be an external account ID. For incoming mandates it can be an internal account ID, however it only applies to financial institutions. A `debtor_account_id` cannot be used if the `debtor_account` property is already filled.","example":"d95fbdf7-90a7-4026-9597-3a7ecd0e819f"},"receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the external account to be debited. It must be left empty if `receiving_account` parameter is filled.","example":"b38f5318-a389-4278-9cbe-d16116750982","deprecated":true},"sequence":{"type":"string","description":"Deprecated, use `frequency` instead.","deprecated":true,"enum":["one_off","recurring"],"example":"recurring"},"frequency":{"type":"string","description":"The frequency of the direct debit mandate. Mandatory when type is `sepa_core` or `sepa_b2b`. Not applicable for `bacs_debit` mandates.","enum":["one_off","recurring"],"example":"recurring"},"generate_mandate_reference":{"type":"boolean","description":"When `generate_mandate_reference` is `true`, Numeral automatically generates a unique mandate reference. Default value is `false`."},"reference":{"type":"string","description":"The reference of the direct debit mandate. It must be empty if `generate_mandate_reference` is `true`.","example":"some reference"},"signature_date":{"type":"string","description":"The signature date of the direct debit mandate.","example":"2023-05-31"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"}}},"direct_debit_mandates.update_direct_debit_mandate":{"type":"object","properties":{"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"signature_date":{"type":"string","description":"The signature date of the direct debit mandate.","example":"2023-05-31"},"expiry_date":{"type":["string","null"],"format":"date","description":"Manually override the expiry date of the mandate. When not provided, the expiry date is automatically computed from `last_debit_collection_date` and the applicable validity period.\n","example":"2027-03-15"}}},"direct_debit_mandates.authorize_direct_debit_mandate":{"type":"object","properties":{"new_expiry_date":{"type":"string","format":"date","description":"Optional new expiry date (YYYY-MM-DD) when authorizing. Must be between today and the maximum validity allowed for the scheme (SEPA: 36 months from today; Bacs: from the connected bank configuration).\n","example":"2027-03-15"}}},"direct_debit_mandates.direct_debit_mandate":{"type":"object","required":["id","object","direction","type","status","connected_account_id","originating_account","receiving_account","reference","metadata","created_at"],"properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the direct debit mandate."},"object":{"type":"string","description":"Type of the object, `direct_debit_mandate`.","default":"direct_debit_mandate"},"direction":{"type":"string","description":"The direction of the direct debit mandate.","enum":["outgoing","incoming"],"example":"outgoing"},"type":{"type":"string","description":"The type of the direct debit mandate.","enum":["sepa_core","sepa_b2b","bacs_debit"],"example":"sepa_core"},"status":{"type":"string","description":"The status of the direct debit mandate.","enum":["active","blocked","canceled","disabled","expired","pending_review","rejected"],"example":"active"},"connected_account_id":{"type":"string","format":"uuid","description":"The ID of the connected account.","example":"ff1714ae-3ec8-450d-984c-c6ee44c82a88"},"creditor_account":{"$ref":"#/components/schemas/direct_debit_mandates.creditor_account"},"creditor_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account to be credited. Only filled in the case of outgoing mandates created by financial institution connected accounts.","example":"2c524087-20ae-437e-948c-f673b0757821"},"creditor_account_type":{"type":"string","description":"The type of the account that `creditor_account_id` is referencing.","enum":["internal_account"],"example":"internal_account"},"debtor_account":{"$ref":"#/components/schemas/direct_debit_mandates.debtor_account"},"debtor_account_id":{"type":"string","format":"uuid","description":"The ID of the account (internal or external) to be debited.","example":"b38f5318-a389-4278-9cbe-d16116750982"},"debtor_account_type":{"type":"string","description":"The type of the account that `debtor_account_id` is referencing.","enum":["internal_account","external_account"],"example":"external_account"},"originating_account":{"$ref":"#/components/schemas/direct_debit_mandates.originating_account","deprecated":true},"originating_account_id":{"type":"string","format":"uuid","description":"The ID of the internal account to be credited.","example":"2c524087-20ae-437e-948c-f673b0757821","deprecated":true},"receiving_account":{"$ref":"#/components/schemas/direct_debit_mandates.receiving_account","deprecated":true},"receiving_account_id":{"type":"string","format":"uuid","description":"The ID of the account (internal or external) to be debited.","example":"b38f5318-a389-4278-9cbe-d16116750982","deprecated":true},"sequence":{"type":"string","description":"Deprecated, use `frequency` instead.","deprecated":true,"enum":["one_off","recurring"],"example":"recurring"},"frequency":{"type":"string","description":"The frequency of the direct debit mandate. Populated for SEPA mandates (`sepa_core`, `sepa_b2b`); not applicable for `bacs_debit` mandates.","enum":["one_off","recurring"],"example":"recurring"},"reference":{"type":"string","description":"The reference of the direct debit mandate.","example":"some reference"},"signature_date":{"type":"string","description":"The signature date of the direct debit mandate.","example":"2023-05-31"},"last_debit_collection_date":{"type":["string","null"],"format":"date","description":"The date of the last direct debit collection processed against this mandate. Updated automatically when a direct debit collection is received.","example":"2024-03-15"},"expiry_date":{"type":["string","null"],"format":"date","description":"The date after which the mandate is expired and cannot be used for subsequent direct debit collections. For SEPA mandates, this is 36 months after `last_debit_collection_date`. For Bacs mandates, this depends on the bank's mandate validity period configuration; if not configured, the value is `null` (no expiry).\n","example":"2027-03-15"},"metadata":{"type":"object","description":"Additional client data in JSON format. See [Metadata](ref:metadata).","example":{"property_a":true,"property_b":"some text"}},"custom_fields":{"$ref":"#/components/schemas/common.custom_fields"},"created_at":{"type":"string","format":"date-time","description":"The UTC timestamp of the creation of this direct debit mandate.","example":"2023-06-07T08:49:54.54422Z"},"bank_data":{"type":"object","description":"Bank data exposed for the mandate. Populated for schemes where a registration message is sent to the bank — currently Bacs (AUDDIS).","properties":{"message_id":{"type":"string","description":"ID of the message that registered the mandate at the bank.","example":"ABCDEF"}}}}},"direct_debit_mandates.search_result":{"type":"object","properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"direct_debit_mandates.originating_account":{"type":"object","description":"The account to be credited.","required":["account_number","bank_code","holder_name","creditor_identifier"],"properties":{"account_number":{"type":"string","example":"FR7601234567890627967100010","description":"The account number of the originating account. See accepted account number formats [here](ref:payment-methods). For `bacs_debit` mandates, must be a UK domestic 8-digit account number."},"bank_code":{"type":"string","example":"SOGEFRPP","description":"The bank code, for instance BIC / Swift code, UK sort code, or US routing number. For `bacs_debit` mandates, must be a UK sort code (6 digits)."},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"holder_name":{"type":"string","example":"SoftwareCo","description":"The name of the legal entity or individual holding the account."},"creditor_identifier":{"type":"string","description":"The unique reference for organisations collecting payments by SEPA Direct Debit.","example":"FR12ZZZ123456","maxLength":35},"holder_address":{"$ref":"#/components/schemas/common.address"}}},"direct_debit_mandates.receiving_account":{"type":"object","description":"The account to be debited. It must be left empty if `receiving_account_id` parameter is filled.","required":["account_number","bank_code","holder_name"],"properties":{"account_number":{"type":"string","example":"FR7601234567891127967100082","description":"The account number of the originating account. See accepted account number formats [here](ref:payment-methods). For `bacs_debit` mandates, must be a UK domestic 8-digit account number."},"bank_code":{"type":"string","example":"BNPAFRPPXXX","description":"The bank code, for instance BIC / Swift code, UK sort code, or US routing number. For `bacs_debit` mandates, must be a UK sort code (6 digits)."},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"holder_name":{"type":"string","example":"PartnerCo","description":"The name of the legal entity or individual holding the account."},"holder_address":{"$ref":"#/components/schemas/common.address"}}},"direct_debit_mandates.creditor_account":{"type":"object","description":"The account to be credited.","required":["account_number","bank_code","holder_name","creditor_identifier"],"properties":{"account_number":{"type":"string","example":"FR7601234567890627967100010","description":"The account number of the creditor account. See accepted account number formats [here](ref:payment-methods). For `bacs_debit` mandates, must be a UK domestic 8-digit account number."},"bank_code":{"type":"string","example":"SOGEFRPP","description":"The bank code, for instance BIC / Swift code, UK sort code, or US routing number. For `bacs_debit` mandates, must be a UK sort code (6 digits)."},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"holder_name":{"type":"string","example":"SoftwareCo","description":"The name of the legal entity or individual holding the account."},"creditor_identifier":{"type":"string","description":"The unique reference for organisations collecting payments by SEPA Direct Debit.","example":"FR12ZZZ123456","maxLength":35},"holder_address":{"$ref":"#/components/schemas/common.address"}}},"direct_debit_mandates.debtor_account":{"type":"object","description":"The account to be debited. It must be left empty if `debtor_account_id` parameter is filled.","required":["account_number","bank_code","holder_name"],"properties":{"account_number":{"type":"string","example":"FR7601234567891127967100082","description":"The account number of the debtor account. See accepted account number formats [here](ref:payment-methods). For `bacs_debit` mandates, must be a UK domestic 8-digit account number."},"bank_code":{"type":"string","example":"BNPAFRPPXXX","description":"The bank code, for instance BIC / Swift code, UK sort code, or US routing number. For `bacs_debit` mandates, must be a UK sort code (6 digits)."},"account_number_format":{"type":"string","description":"The format of the account number. When set, it must match `account_number` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["iban","uk_account_number","us_account_number","tokenized","other"]},"bank_code_format":{"type":"string","description":"The format of the bank code. When set, it must match `bank_code` unless the format is `other` or `tokenized`. Always present in API responses (empty string when not set).","enum":["bic","uk_sorting_code","us_aba_routing_number","tokenized","other"]},"holder_name":{"type":"string","example":"PartnerCo","description":"The name of the legal entity or individual holding the account."},"holder_address":{"$ref":"#/components/schemas/common.address"}}},"common.address":{"type":"object","description":"The address of the account holder, as an address object.","properties":{"line_1":{"type":"string","description":"Line 1.","example":"1, place de la Concorde"},"line_2":{"type":"string","description":"Line 2.","example":""},"building_number":{"type":"string","description":"Building number.","example":"1"},"street_name":{"type":"string","description":"Street name.","example":"place de la Concorde"},"postal_code":{"type":"string","description":"Postal / zip code.","example":"75008"},"region_state":{"type":"string","description":"Region or state.","example":""},"city":{"type":"string","example":"Paris","description":"City."},"country":{"type":"string","example":"FR","description":"ISO 3166 alpha-2 country code."},"department":{"type":["string","null"],"description":"Department name or code.","example":"Marketing"},"sub_department":{"type":["string","null"],"description":"Sub-department name.","example":"Content team"},"building_name":{"type":["string","null"],"description":"Name of the building.","example":"Bat. 4"},"floor":{"type":["string","null"],"description":"Floor number or identifier.","example":"3"},"postal_box":{"type":["string","null"],"description":"Postal box.","example":"67b"},"room":{"type":["string","null"],"description":"Room number.","example":"47"},"city_location_name":{"type":["string","null"],"description":"Specific city location or landmark.","example":"Confluences"},"district_name":{"type":["string","null"],"description":"District name or administrative region.","example":"District 9"}}},"status":{"type":"string","description":"Lifecycle status of the resource.","enum":["active","disabled"]},"correspondent_banks.correspondent_bank":{"type":"object","required":["id","object","status","name","bank_code","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","default":"correspondent_bank"},"status":{"$ref":"#/components/schemas/status"},"name":{"type":"string","description":"Human-readable bank name. Surfaced in dashboards and reconciliation reports.","example":"Citi Bank"},"bank_code":{"type":"string","description":"BIC (8 or 11 characters).","example":"CITIUS33XXX"},"distinguished_name":{"type":["string","null"],"description":"Swift distinguished name (DN). Optional.","example":"ou=xxx,o=citius33,o=swift"},"created_at":{"type":"string","format":"date-time"}}},"correspondent_banks.create_correspondent_bank":{"type":"object","required":["name","bank_code"],"properties":{"name":{"type":"string","maxLength":1000,"example":"Citi Bank"},"bank_code":{"type":"string","maxLength":100,"example":"CITIUS33XXX"},"distinguished_name":{"type":"string","description":"Swift distinguished name (DN). Optional.","example":"ou=xxx,o=citius33,o=swift"}}},"correspondent_banks.update_correspondent_bank":{"type":"object","required":["name","bank_code"],"properties":{"name":{"type":"string","maxLength":1000},"bank_code":{"type":"string","maxLength":100},"distinguished_name":{"type":["string","null"],"description":"Omitting the field keeps the stored value; an explicit null clears it."}}},"correspondent_banks.search_result":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"correspondent_bank_accounts.correspondent_bank_account":{"type":"object","required":["id","object","status","correspondent_bank_id","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","default":"correspondent_bank_account"},"status":{"$ref":"#/components/schemas/status"},"correspondent_bank_id":{"type":"string","format":"uuid","description":"The correspondent bank this account belongs to."},"nostro_account_number":{"type":["string","null"],"description":"Account number used to settle payments routed through this correspondent bank."},"connected_account_id":{"type":["string","null"],"format":"uuid","description":"The connected account this correspondent account is linked to. Optional."},"currencies":{"type":["array","null"],"items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies this correspondent bank account can be used for. Optional.\n","example":["EUR","USD"]},"created_at":{"type":"string","format":"date-time"}}},"correspondent_bank_accounts.create_correspondent_bank_account":{"type":"object","required":["correspondent_bank_id"],"properties":{"correspondent_bank_id":{"type":"string","format":"uuid"},"nostro_account_number":{"type":"string","maxLength":100},"connected_account_id":{"type":"string","format":"uuid"},"currencies":{"type":"array","items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies this correspondent bank account can be used for. Optional.\n","example":["EUR","USD"]}}},"correspondent_bank_accounts.update_correspondent_bank_account":{"type":"object","required":["correspondent_bank_id"],"properties":{"correspondent_bank_id":{"type":"string","format":"uuid"},"nostro_account_number":{"type":["string","null"],"maxLength":100,"description":"Omitting the field keeps the stored value; an explicit null clears it."},"connected_account_id":{"type":["string","null"],"format":"uuid","description":"Omitting the field keeps the stored value; an explicit null clears it."},"currencies":{"type":["array","null"],"items":{"type":"string"},"description":"[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currencies this correspondent bank account can be used for. Omitting the field keeps the stored value; an explicit null clears it.\n","example":["EUR","USD"]}}},"correspondent_bank_accounts.search_result":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"correspondent_banking_rules.correspondent_banking_rule":{"type":"object","required":["id","object","status","currency","correspondent_bank_id","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","default":"correspondent_banking_rule"},"status":{"$ref":"#/components/schemas/status"},"currency":{"type":"string","description":"ISO 4217 3-letter currency code (e.g. \"USD\", \"EUR\"), or \"*\" to indicate the wildcard / fallback rule used when no currency-specific rule applies.\n","example":"USD"},"correspondent_bank_id":{"type":"string","format":"uuid"},"correspondent_bank_account_id":{"type":["string","null"],"format":"uuid","description":"Specific account to use when this rule matches. Optional."},"created_at":{"type":"string","format":"date-time"}}},"correspondent_banking_rules.create_correspondent_banking_rule":{"type":"object","required":["currency","correspondent_bank_id"],"properties":{"currency":{"type":"string","maxLength":3,"example":"USD"},"correspondent_bank_id":{"type":"string","format":"uuid"},"correspondent_bank_account_id":{"type":"string","format":"uuid"}}},"correspondent_banking_rules.update_correspondent_banking_rule":{"type":"object","required":["currency","correspondent_bank_id"],"properties":{"currency":{"type":"string","maxLength":3},"correspondent_bank_id":{"type":"string","format":"uuid"},"correspondent_bank_account_id":{"type":["string","null"],"format":"uuid","description":"Omitting the field keeps the stored account link; an explicit null clears it."}}},"correspondent_banking_rules.search_result":{"type":"object","required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}}}},"security":[{"sec0":[]}],"paths":{"/account_holders":{"post":{"summary":"Create account holder","description":"Create an account holder. Once created, you can create related accounts (internal or external).","operationId":"create-account-holder","tags":["Account Holders"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.create_account_holder"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.account_holder"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List account holders","description":"List and filter account holders.","operationId":"list-account-holders","tags":["Account Holders"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the account holder.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the account holder.","schema":{"type":"string","format":"date"}},{"name":"name","in":"query","description":"The name of the account holder.","schema":{"type":"string"}},{"name":"disabled","in":"query","description":"If true, only disabled account holders will be fetched.","schema":{"type":"boolean"}},{"name":"external_account_id","in":"query","description":"The ID of the related external account.","schema":{"type":"string","format":"uuid"}},{"name":"internal_account_id","in":"query","description":"The ID of the related internal account.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/account_holders/{id}/disable":{"post":{"summary":"Disable account holder","description":"Disable an account holder. Related external and internal accounts will be disabled at the same time.","operationId":"disable-account-holder","tags":["Account Holders"],"parameters":[{"name":"id","in":"path","description":"The ID of the account holder.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.account_holder"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/account_holders/{id}":{"post":{"summary":"Update account holder","description":"Update the metadata of an account holder. See [Metadata](ref:metadata).","operationId":"update-account-holder","tags":["Account Holders"],"parameters":[{"name":"id","in":"path","description":"The ID of the account holder.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.update_account_holder"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.account_holder"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve account holder","description":"Retrieve the details of an account holder.","operationId":"retrieve-account-holder","tags":["Account Holders"],"parameters":[{"name":"id","in":"path","description":"The ID of the account holder.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accountholders.account_holder"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/external_accounts":{"post":{"summary":"Create external account","description":"Create an external account, which relates to an existing active account holder.","operationId":"create-external-account","tags":["External Accounts"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.create_external_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List external accounts","description":"List and filter external accounts.","operationId":"list-external-accounts","tags":["External Accounts"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the external account.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the external account.","schema":{"type":"string","format":"date"}},{"name":"holder_name","in":"query","description":"The holder name of the external account.","schema":{"type":"string"}},{"name":"account_number","in":"query","description":"The account number of the external account.","schema":{"type":"string"}},{"name":"bank_code","in":"query","description":"The bank code of the external account.","schema":{"type":"string"}},{"name":"country","in":"query","description":"The country of the external account.","schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of the external account.","schema":{"$ref":"#/components/schemas/external_accounts.status"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/external_accounts/{id}/approve":{"post":{"summary":"Approve external account","description":"Approve an external account in status `pending_approval`. An external account must be approved before it can be used when creating payment orders, expected payments, or direct debit mandates. Approving an external account updates its status to `approved`.","operationId":"approve-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the external account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/external_accounts/{id}/deny":{"post":{"summary":"Deny external account","description":"Deny an external account. An external account can be denied from the `pending_approval` and `approved` statuses. Denying an external account updates its status to `denied`.","operationId":"deny-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the external account.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.deny_external_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/external_accounts/{id}/disable":{"post":{"summary":"Disable external account","description":"Disable an external account. An external account can be disabled from the `approved` status. Disabling an external account updates its status to `disabled`.","operationId":"disable-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the disabled account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/external_accounts/{id}/verify":{"post":{"summary":"Verify external account","description":"Run verification for an external account.","operationId":"verify-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the external account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/external_accounts/{id}":{"post":{"summary":"Update external account","description":"Update the metadata of an external account. See [Metadata](ref:metadata).","operationId":"update-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the external account.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.update_external_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve external account","description":"Retrieve the details of an external account.","operationId":"retrieve-external-account","tags":["External Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the external account.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/external_accounts.external_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/internal_accounts":{"post":{"summary":"Create internal account","description":"Create an internal account, which can refer to an existing active account holder. This internal account will only be created in Numeral system and should be created by your bank beforehand. It will refer to either: (1) a type own account, namely a record of a financial institution connected account or (2) a type virtual account managed by your bank.\n","operationId":"create-internal-account","tags":["Internal Accounts"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.create_internal_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List internal accounts","description":"List and filter internal accounts.\n","operationId":"list-internal-accounts","tags":["Internal Accounts"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the internal account.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the internal account.","schema":{"type":"string","format":"date"}},{"name":"connected_account_id","in":"query","description":"The ID of the connected account to which the virtual account refers.","schema":{"type":"string","format":"uuid"}},{"name":"name","in":"query","description":"The name of the internal account.","schema":{"type":"string","maxLength":100}},{"name":"type","in":"query","description":"The type of the internal account.","schema":{"type":"string","enum":["own","virtual"]}},{"name":"account_number","in":"query","description":"The account number of the internal account.","schema":{"type":"string"}},{"name":"bank_code","in":"query","description":"The bank code of the internal account.","schema":{"type":"string"}},{"name":"creditor_identifier","in":"query","description":"The creditor identifier of the internal account.","schema":{"type":"string"}},{"name":"account_holder_id","in":"query","description":"The ID of the account holder to which the internal account refers to.","schema":{"type":"string","format":"uuid"}},{"name":"holder_name","in":"query","description":"The account holder name to look for. Searches through the `holder_name` and `alternative_holder_names` attributes.","schema":{"type":"string","maxLength":100}},{"name":"status","in":"query","description":"If `disabled`, only disabled internal accounts will be fetched.","schema":{"type":"string","enum":["active","blocked","disabled"]}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/internal_accounts/{id}/block":{"post":{"summary":"Block internal account","description":"Block an internal account.\n","operationId":"block-internal-account","tags":["Internal Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the internal account.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/internal_accounts/{id}/unblock":{"post":{"summary":"Unblock internal account","description":"Unblock an internal account. Bring a previously blocked internal account back to active status.\n","operationId":"unblock-internal-account","tags":["Internal Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the internal account.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/internal_accounts/{id}/disable":{"post":{"summary":"Disable internal account","description":"Disable an internal account. Disabled internal accounts cannot be enabled again.\n","operationId":"disable-internal-account","tags":["Internal Accounts"],"parameters":[{"name":"id","in":"path","description":"The ID of the internal account.","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/internal_accounts/{id}":{"parameters":[{"name":"id","in":"path","description":"The ID of the internal account.","schema":{"type":"string","format":"uuid"},"required":true}],"get":{"summary":"Retrieve internal account","description":"Retrieve the details of an internal account.\n","operationId":"retrieve-internal-account","tags":["Internal Accounts"],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}},"post":{"summary":"Update an internal account","description":"Update the attributes of an internal account.\n","operationId":"update-internal-account","tags":["Internal Accounts"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.update"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/internal_accounts.internal_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/direct_debit_mandates":{"post":{"summary":"Create direct debit mandate","description":"Create a direct debit mandate.","operationId":"create-direct-debit-mandate","tags":["Direct Debit Mandates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.create_direct_debit_mandate"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"409":{"$ref":"#/components/responses/errors.409.conflict"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List direct debit mandates","description":"List and filter direct debit mandate.","operationId":"list-direct-debit-mandates","tags":["Direct Debit Mandates"],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25,"minimum":0,"maximum":100}},{"name":"starting_after","in":"query","description":"The ID of the object from which your list request will start. It is not included in the result.","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"start_date","in":"query","description":"The creation date of the direct debit mandate.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"The creation date of the direct debit mandate.","schema":{"type":"string","format":"date"}},{"name":"start_signature_date","in":"query","description":"The minimum signature date of the direct debit mandate.","schema":{"type":"string","format":"date"}},{"name":"end_signature_date","in":"query","description":"The maximum signature date of the direct debit mandate.","schema":{"type":"string","format":"date"}},{"name":"receiving_account_id","in":"query","description":"The receiving_account_id of the direct debit mandate.","schema":{"type":"string","format":"uuid"},"deprecated":true},{"name":"originating_account_id","in":"query","description":"The originating_account_id of the direct debit mandate.","schema":{"type":"string","format":"uuid"},"deprecated":true},{"name":"debtor_account_id","in":"query","description":"The debtor_account_id of the direct debit mandate.","schema":{"type":"string","format":"uuid"}},{"name":"debtor_account_number","in":"query","description":"The account number of the debtor account of the direct debit mandate.","schema":{"type":"string"}},{"name":"creditor_account_id","in":"query","description":"The creditor_account_id of the direct debit mandate.","schema":{"type":"string","format":"uuid"}},{"name":"type","in":"query","description":"The type of the direct debit mandate.","schema":{"type":"string","enum":["sepa_core","sepa_b2b","bacs_debit"]}},{"name":"sequence","in":"query","description":"Deprecated, use `frequency` instead.","deprecated":true,"schema":{"type":"string","enum":["one_off","recurring"]}},{"name":"frequency","in":"query","description":"The frequency of the direct debit mandate.","schema":{"type":"string","enum":["one_off","recurring"]}},{"name":"reference","in":"query","description":"The reference of the direct debit mandate.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.search_result"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"}}}},"/direct_debit_mandates/{id}":{"post":{"summary":"Update direct debit mandate","description":"Update a direct debit mandate.","operationId":"update-direct-debit-mandate","tags":["Direct Debit Mandates"],"parameters":[{"name":"id","in":"path","description":"The ID of the direct debit mandate.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.update_direct_debit_mandate"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"Retrieve direct debit mandate","description":"Retrieve the details of a direct debit mandate.","operationId":"retrieve-a-direct-debit-mandate","tags":["Direct Debit Mandates"],"parameters":[{"name":"id","in":"path","description":"The ID of the direct debit mandate.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/direct_debit_mandates/{id}/disable":{"post":{"summary":"Disable direct debit mandate","description":"Disable a direct debit mandate with `direction` = `outgoing`. A disabled direct debit mandate cannot be used anymore to send direct debit payment orders.","operationId":"disable-direct-debit-mandate","tags":["Direct Debit Mandates"],"parameters":[{"name":"id","in":"path","description":"The ID of the direct debit mandate.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/direct_debit_mandates/{id}/block":{"post":{"summary":"Block direct debit mandate","description":"Block a direct debit mandate with `direction` = `incoming`. Direct debit incoming payments which relate to blocked direct debit mandates get automatically rejected.","operationId":"block-a-direct-debit-mandate","tags":["Direct Debit Mandates"],"parameters":[{"name":"id","in":"path","description":"The ID of the direct debit mandate.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/direct_debit_mandates/{id}/authorize":{"post":{"summary":"Authorize direct debit mandate","description":"Authorize an incoming direct debit mandate with `status` = `blocked`, `expired`, or `active`. When authorizing from blocked or expired, its status is set to `active`. Calling authorize on an already `active` mandate without `new_expiry_date` returns the mandate unchanged. When `new_expiry_date` is provided, the mandate expiry is updated accordingly.\n","operationId":"authorize-direct-debit-mandate","tags":["Direct Debit Mandates"],"parameters":[{"name":"id","in":"path","description":"The ID of the direct debit mandate.","schema":{"type":"string"},"required":true}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.authorize_direct_debit_mandate"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_debit_mandates.direct_debit_mandate"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_banks":{"post":{"summary":"Create correspondent bank","description":"Creates a new correspondent bank for the legal entity. The bank is created with an `active` status.","operationId":"create-correspondent-bank","tags":["Correspondent banks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.create_correspondent_bank"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List correspondent banks","description":"List and filter correspondent banks.","operationId":"list-correspondent-banks","tags":["Correspondent banks"],"parameters":[{"$ref":"#/components/parameters/list.common_parameters.limit"},{"$ref":"#/components/parameters/list.common_parameters.starting_after"},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"bank_code","in":"query","description":"Filter banks by bank_code (BIC).","schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter banks by lifecycle status.","schema":{"$ref":"#/components/schemas/status"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.search_result"}}}}}}},"/correspondent_banks/{id}":{"get":{"summary":"Get correspondent bank","description":"Returns the correspondent bank with the given ID.","operationId":"get-correspondent-bank","tags":["Correspondent banks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}},"post":{"summary":"Update correspondent bank","description":"Updates the correspondent bank with the given ID, replacing its fields with the supplied values.","operationId":"update-correspondent-bank","tags":["Correspondent banks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.update_correspondent_bank"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/correspondent_banks/{id}/enable":{"post":{"summary":"Enable correspondent bank","description":"Sets the correspondent bank's status back to `active`.","operationId":"enable-correspondent-bank","tags":["Correspondent banks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_banks/{id}/disable":{"post":{"summary":"Disable correspondent bank","description":"Disable a correspondent bank.","operationId":"disable-correspondent-bank","tags":["Correspondent banks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banks.correspondent_bank"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_bank_accounts":{"post":{"summary":"Create correspondent bank account","description":"Creates a new correspondent bank account for the legal entity. The account is created with an `active` status.","operationId":"create-correspondent-bank-account","tags":["Correspondent bank accounts"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.create_correspondent_bank_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List correspondent bank accounts","description":"List and filter correspondent bank accounts.","operationId":"list-correspondent-bank-accounts","tags":["Correspondent bank accounts"],"parameters":[{"$ref":"#/components/parameters/list.common_parameters.limit"},{"$ref":"#/components/parameters/list.common_parameters.starting_after"},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"correspondent_bank_id","in":"query","description":"Filter accounts by the correspondent bank they belong to.","schema":{"type":"string","format":"uuid"}},{"name":"connected_account_id","in":"query","description":"Filter accounts by the connected account they are linked to.","schema":{"type":"string","format":"uuid"}},{"name":"currency","in":"query","description":"The currency of the correspondent bank account.","schema":{"type":"string"}},{"name":"status","in":"query","description":"The status of the correspondent bank account.","schema":{"$ref":"#/components/schemas/status"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.search_result"}}}}}}},"/correspondent_bank_accounts/{id}":{"get":{"summary":"Get correspondent bank account","description":"Returns the correspondent bank account with the given ID.","operationId":"get-correspondent-bank-account","tags":["Correspondent bank accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}},"post":{"summary":"Update correspondent bank account","description":"Updates the correspondent bank account with the given ID, replacing its fields with the supplied values.","operationId":"update-correspondent-bank-account","tags":["Correspondent bank accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.update_correspondent_bank_account"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/correspondent_bank_accounts/{id}/enable":{"post":{"summary":"Enable correspondent bank account","description":"Sets the correspondent bank account's status back to `active`.","operationId":"enable-correspondent-bank-account","tags":["Correspondent bank accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_bank_accounts/{id}/disable":{"post":{"summary":"Disable correspondent bank account","description":"Sets the correspondent bank account's status to `disabled`. Disabled accounts remain retrievable via `status=disabled`.","operationId":"disable-correspondent-bank-account","tags":["Correspondent bank accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_bank_accounts.correspondent_bank_account"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_banking_rules":{"post":{"summary":"Create correspondent banking rule","description":"Creates a new correspondent banking rule for the legal entity. The rule is created with an `active` status.\n","operationId":"create-correspondent-banking-rule","tags":["Correspondent banking rules"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.create_correspondent_banking_rule"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"415":{"$ref":"#/components/responses/errors.415.unsupported_media_type"}}},"get":{"summary":"List correspondent banking rules","description":"List and filter correspondent banking rules.","operationId":"list-correspondent-banking-rules","tags":["Correspondent banking rules"],"parameters":[{"$ref":"#/components/parameters/list.common_parameters.limit"},{"$ref":"#/components/parameters/list.common_parameters.starting_after"},{"$ref":"#/components/parameters/list.common_parameters.sort_order"},{"name":"currency","in":"query","description":"Exact-match filter on the rule's currency code (or \"*\").","schema":{"type":"string"}},{"name":"correspondent_bank_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","description":"The status of the correspondent banking rule.","schema":{"$ref":"#/components/schemas/status"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.search_result"}}}}}}},"/correspondent_banking_rules/{id}":{"get":{"summary":"Get correspondent banking rule","description":"Returns the correspondent banking rule with the given ID.","operationId":"get-correspondent-banking-rule","tags":["Correspondent banking rules"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"}}},"post":{"summary":"Update correspondent banking rule","description":"Updates the correspondent banking rule with the given ID, replacing its fields with the supplied values.","operationId":"update-correspondent-banking-rule","tags":["Correspondent banking rules"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.update_correspondent_banking_rule"}}}},"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}},"400":{"$ref":"#/components/responses/errors.400.validation"},"404":{"$ref":"#/components/responses/errors.404.not_found"}}}},"/correspondent_banking_rules/{id}/enable":{"post":{"summary":"Enable correspondent banking rule","description":"Sets the correspondent banking rule's status back to `active`.","operationId":"enable-correspondent-banking-rule","tags":["Correspondent banking rules"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}},"/correspondent_banking_rules/{id}/disable":{"post":{"summary":"Disable correspondent banking rule","description":"Sets the correspondent banking rule's status to `disabled`. Disabled rules remain retrievable via `status=disabled`.","operationId":"disable-correspondent-banking-rule","tags":["Correspondent banking rules"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"200","content":{"application/json":{"schema":{"$ref":"#/components/schemas/correspondent_banking_rules.correspondent_banking_rule"}}}},"404":{"$ref":"#/components/responses/errors.404.not_found"},"409":{"$ref":"#/components/responses/errors.409.conflict"}}}}}}