openapi: 3.2.0 info: title: Monite Counterpart bank accounts API contact: name: Monite team url: https://monite.com/about/ email: developers@monite.com termsOfService: https://monite.com/terms version: '1.0' description: 'Operations tagged Counterpart bank accounts across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment tags: - name: Counterpart bank accounts paths: /counterparts/{counterpart_id}/bank_accounts: get: tags: - Counterpart bank accounts summary: Get a counterpart's bank accounts operationId: get_counterparts_id_bank_accounts parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CounterpartBankAccountResourceList' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] post: tags: - Counterpart bank accounts summary: Create a counterpart bank account operationId: post_counterparts_id_bank_accounts parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCounterpartBankAccount' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CounterpartBankAccountResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}: get: tags: - Counterpart bank accounts summary: Get a counterpart's bank account operationId: get_counterparts_id_bank_accounts_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: bank_account_id in: path - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CounterpartBankAccountResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: tags: - Counterpart bank accounts summary: Update a counterpart's bank account operationId: patch_counterparts_id_bank_accounts_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: bank_account_id in: path - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCounterpartBankAccount' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CounterpartBankAccountResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] delete: tags: - Counterpart bank accounts summary: Delete a counterpart's bank account operationId: delete_counterparts_id_bank_accounts_id parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: bank_account_id in: path - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '204': description: Successful Response '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/make_default: post: tags: - Counterpart bank accounts summary: Set a counterpart's bank account as default for its currency operationId: post_counterparts_id_bank_accounts_id_make_default parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: bank_account_id in: path - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: {} '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment /counterparts/{counterpart_id}/bank_accounts/{bank_account_id}/verify: post: tags: - Counterpart bank accounts summary: Verify a counterpart bank account operationId: post_counterparts_id_bank_accounts_id_verify parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header - required: true schema: type: string format: uuid name: bank_account_id in: path - required: true schema: type: string format: uuid name: counterpart_id in: path - description: The ID of the entity that owns the requested resource. required: true schema: type: string format: uuid examples: - 9d2b4c8f-2087-4738-ba91-7359683c49a4 name: x-monite-entity-id in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CounterpartBankAccountResponse' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '409': description: Business logic error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment components: schemas: CounterpartBankAccountResourceList: properties: data: items: $ref: '#/components/schemas/CounterpartBankAccountResponse' type: array type: object required: - data CreateCounterpartBankAccount: properties: account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default: type: boolean default: false name: type: string maxLength: 200 partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' additionalProperties: false type: object required: - country - currency UpdateCounterpartBankAccount: properties: account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 name: type: string maxLength: 200 partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' additionalProperties: false type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array type: object ErrorSchema: properties: message: type: string type: object required: - message AllowedCountries: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - IC - CV - KY - CF - EA - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - SZ - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - SS - GS - ES - LK - SD - SR - SJ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - BL - BQ - CW - MF - SX OpenBankingVerificationStatusEnum: type: string enum: - not_verified - verified - failed - expired - pending - not_applicable ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array msg: type: string type: type: string type: object required: - loc - msg - type ErrorSchemaResponse: properties: error: $ref: '#/components/schemas/ErrorSchema' type: object required: - error CounterpartBankAccountResponse: properties: id: type: string format: uuid account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX counterpart_id: type: string format: uuid country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default: type: boolean default: false name: type: string maxLength: 200 open_banking_verification_error: type: string description: Last verification error message open_banking_verification_status: allOf: - $ref: '#/components/schemas/OpenBankingVerificationStatusEnum' description: Open banking verification status partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' type: object required: - id - counterpart_id - country - currency - open_banking_verification_status CurrencyEnum: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SOS - SRD - SSP - SVC - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW CreateCounterpartBankAccount_2: properties: account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default_for_currency: type: boolean default: false name: type: string maxLength: 200 partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' additionalProperties: false type: object required: - country - currency CounterpartBankAccountResponse_2: properties: id: type: string format: uuid account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX counterpart_id: type: string format: uuid country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default_for_currency: type: boolean default: false name: type: string maxLength: 200 open_banking_verification_error: type: string description: Last verification error message open_banking_verification_status: allOf: - $ref: '#/components/schemas/OpenBankingVerificationStatusEnum' description: Open banking verification status partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' type: object required: - id - counterpart_id - country - currency - open_banking_verification_status CreateCounterpartBankAccount_3: properties: account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default_for_currency: type: boolean default: false name: type: string maxLength: 200 partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' additionalProperties: false type: object required: - country - currency CounterpartBankAccountResponse_3: properties: id: type: string format: uuid account_holder_name: type: string description: The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. example: Bob Jones account_number: type: string description: The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. example: '12345678' bic: type: string maxLength: 11 description: The BIC/SWIFT code of the bank. example: DEUTDEFFXXX counterpart_id: type: string format: uuid country: $ref: '#/components/schemas/AllowedCountries' currency: $ref: '#/components/schemas/CurrencyEnum' iban: type: string maxLength: 34 description: The IBAN of the bank account. example: DE74500700100100000900 is_default_for_currency: type: boolean default: false name: type: string maxLength: 200 open_banking_verification_error: type: string description: Last verification error message open_banking_verification_status: allOf: - $ref: '#/components/schemas/OpenBankingVerificationStatusEnum' description: Open banking verification status partner_metadata: type: object description: Metadata for partner needs. routing_number: type: string description: The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. sort_code: type: string description: The bank's sort code. example: '123456' type: object required: - id - counterpart_id - country - currency - open_banking_verification_status securitySchemes: HTTPBearer: type: http scheme: bearer x-refined-from: - monite-openapi-2023-09-01.json - monite-openapi-2024-05-25.json - monite-openapi.yml