> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List cases ## OpenAPI ````yaml openapi-v2.json get /cases openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 2.4.0 servers: - description: Production url: https://api.synctera.com/v2 - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v2 security: - bearerAuth: [] tags: - description: | Requests to create and manage Rewards name: Rewards (beta) - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: >- Testing endpoints to simulate in-store cash deposits. Available in sandbox environments only. name: In-Store Cash Deposit Simulations - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Create and manage spending controls name: Spend Controls (beta) - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Rates name: Rates - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: API for point-in-time account balances name: account_balances - description: Requests to create and manage webhooks name: Webhooks - description: > Vendor-agnostic daily snapshots of a credit account's state (balances, past-due status, per-bucket breakdown). Populated first from LoanPro, but not specific to it. Internal-only: there is no public write path, only an internal sync job. name: Credit Account Daily Snapshots - description: Tenant Config name: Tenant Config - description: Create and manage documents. name: Documents - description: Request to create and manage statements name: Statements - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: FDX authentication and data transfer using Plaid Core Exchange name: Plaid Core Exchange (beta) - description: Create and manage disputes name: Disputes - description: Requests to simulate card payments name: Card Simulations - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: >- Aggregated write-off amounts for lending accounts, computed from posted transactions. name: Write Off Amounts - description: | Manage fee products and fee configs for automated fee collection name: Fee Products - description: Apple Pay APIs name: Apple Pay - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Lending Config name: Lending Config - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Payments related to lending accounts name: Payments - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Manage negative balance processes name: Negative Balance - description: Create and manage wire transfers name: Wires - description: Configuration for mapping LoanPro events to Payola transaction parameters name: LoanPro Transaction Event Config - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Requests to generate simulated transactions name: Cash Transaction Simulations (alpha) - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Create and manage tenant-level transaction limits name: Tenant Limits (beta) - description: Create and manage transactions name: Transactions (beta) - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: Autopay payment records for billing periods name: Autopays - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: | Requests to create and manage batch payments name: Batch Payments (alpha) - description: Requests to create and manage API keys name: API Keys - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: > The fintech profile document resource is used to track the approval status of any documents which must be reviewed by a bank. This includes regulatory documents which will be presented to the fintech's end users, and also any documents that help the bank understand the fintech's fitness for duty. name: Fintech Profile - description: Billing rates name: Billing Rates - description: Bank Delinquency Configuration name: Bank Delinquency Configuration - description: >- Rules that map a posted payment transaction (bank/partner + transaction attributes) to a regulatory payment code. NULL match columns act as wildcards. name: Payment Code Configuration - description: Create and manage Synctera Pay templates name: SyncteraPay - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: | Manage reward products and reward configs for automated cashback rewards name: Reward Products - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to configure vendors. name: Vendor Configurations - description: Requests to create licenses name: Licenses - description: Requests to create and manage card disputes name: Card Disputes - description: Requests to Admins to grant permissions to user name: Request Permissions - description: >- Per bank/partner account-type mapping to FFIEC collateral codes used for regulatory call report furnishment. name: Collateral Code Configuration - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Bulk card issuance name: Bulk Issuance - description: Requests to search financial institutions name: Institutions (Beta) - description: Autopay configuration management for lending accounts name: Autopay Configs - description: Create and manage scheduled transactions name: Scheduled Transactions (internal) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: | Saved prefills for the internal transfer form name: Internal Transfer Templates - description: Create and manage barcodes for in-store cash deposits name: In-Store Cash Deposits - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Customer Service Details for disputes and billing inquiries name: Customer Service Details - description: Configuration and management of transaction monitoring rules name: Transaction Monitoring - description: Create a credit application. name: Applications (beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Billing period summaries name: Billing Period Summaries - description: Requests to initiate customer verification. name: KYC/KYB Verifications - description: Requests to grant, list, update, and revoke role bindings name: Role Bindings - description: Requests to issue and manage cards name: Cards - description: Push and pull from cards name: External Cards - description: | Requests to create and manage fees name: Fees (beta) - description: Manage credit disputes name: Credit Disputes paths: /cases: summary: Cases get: tags: - Cases operationId: getCases parameters: - in: query name: is_interest_earned_to_date_present schema: type: string - in: query name: report_end_date schema: type: string - in: query name: transaction schema: type: string - in: query name: bucket_id schema: type: string - in: query name: payment_id schema: type: string - description: name of the business to search on in all cases in: query name: entity_name schema: type: string - in: query name: transactions schema: type: string - in: query name: transaction_date schema: type: string - in: query name: receiver schema: type: string - in: query name: fintech_profile_document_id schema: type: string - in: query name: is_active schema: type: boolean - in: query name: card_uuid schema: type: string - in: query name: order schema: enum: - asc - desc type: string - in: query name: fraud_detector schema: type: string - in: query name: is_statement_period_start_present schema: type: string - in: query name: originator_account_uuid schema: type: string - in: query name: party_created_at schema: type: string - in: query name: comments schema: type: string - in: query name: outcome schema: type: string - description: >- One or more resource UUIDs related to the case as a comma-separated list. explode: false in: query name: related_resource_ids schema: items: format: uuid type: string type: array style: form - in: query name: party_name schema: type: string - in: query name: provider schema: type: string - in: query name: payment_type schema: type: string - in: query name: is_assignment_unassigned schema: type: boolean - in: query name: payee_uuid schema: type: string - description: >- array of case_types that's used to return all cases that have the same type as the ones in the array in: query name: case_types schema: type: string - in: query name: reg_e_deadline_extended_date schema: type: string - in: query name: provider_info schema: type: string - in: query name: party_email schema: type: string - in: query name: id schema: type: integer - in: query name: receiver_account_uuid schema: type: string - in: query name: status schema: type: string - in: query name: performance_test_date schema: type: string - in: query name: related_products schema: type: string - in: query name: provisional_credit_amount schema: type: string - in: query name: alert_type schema: type: string - in: query name: rule_failure_info schema: type: string - in: query name: results schema: type: string - in: query name: is_balance_present schema: type: string - in: query name: dispute_type schema: type: string - in: query name: type schema: type: string - in: query name: sender_amount schema: type: string - in: query name: party_uuids schema: type: string - in: query name: transaction_type schema: type: string - in: query name: effective_date schema: type: string - description: | Filter cases by the tenant's Ground Control enrollment. - When `true`, returns only cases for tenants enrolled in Ground Control. - When `false`, returns only cases for tenants not enrolled in Ground Control. - When omitted, no Ground Control–based filtering is applied. in: query name: is_ground_control schema: type: boolean - in: query name: report_type schema: type: string - in: query name: verification_uuid schema: type: string - in: query name: is_apy_earned_present schema: type: string - in: query name: spend_control_id schema: type: string - in: query name: is_interest_calculation_type_present schema: type: string - in: query name: verification_type schema: type: string - in: query name: query schema: type: string - in: query name: statement_system_version schema: type: string - in: query name: document_type schema: type: string - in: query name: description schema: type: string - in: query name: account_ids schema: type: string - in: query name: fraud_dispute schema: type: string - in: query name: customer_phone schema: type: string - in: query name: customer_email schema: type: string - description: >- One or more tag IDs as a comma-separated list. Example: `?tag_id=7d943c51-e4ff-4e57-9558-08cab6b963c7,6a943c25-e4ad-4e57-3325-08def2a452d6` explode: false in: query name: tag_id schema: items: format: uuid type: string type: array style: form - in: query name: is_statement_number_present schema: type: string - in: query name: party_uuid schema: type: string - in: query name: alert_uuids schema: type: string - in: query name: image_rejection_reason schema: type: string - in: query name: provisional_credit_date schema: type: string - in: query name: amount_in_beneficiary_currency schema: type: string - in: query name: beneficiary_currency schema: type: string - in: query name: partner_id schema: type: integer - in: query name: lifecycle_test_date schema: type: string - in: query name: recovery_transaction_id schema: type: string - in: query name: is_statement_availability_date_present schema: type: string - in: query name: application_id schema: type: string - in: query name: marketing_channels schema: type: string - in: query name: transaction_uuid schema: type: string - in: query name: sort_by schema: type: string - in: query name: ceo_sign_off schema: type: string - in: query name: balance_alert_reason schema: type: string - in: query name: transaction_ids schema: type: string - in: query name: statement_system_name schema: type: string - in: query name: sar_type schema: type: string - in: query name: initiator_id schema: type: string - in: query name: assignment_user_id schema: type: string - in: query name: reported_date schema: type: string - in: query name: recovery_status schema: type: string - in: query name: latest_document_version schema: type: string - in: query name: customer_id schema: type: string - in: query name: is_account_number_present schema: type: string - in: query name: disclosure_type schema: type: string - in: query name: end_date schema: type: string - in: query name: bank_id schema: type: integer - in: query name: dispute_uuid schema: type: string - in: query name: start_date schema: type: string - in: query name: alert_ids schema: type: string - in: query name: final_message_date schema: type: string - in: query name: other_suspicious_activity_type_text schema: type: string - in: query name: document_id schema: type: string - in: query name: receiving_account_id schema: type: string - in: query name: auth_dispute schema: type: string - in: query name: date_by schema: enum: - created_at - updated_at type: string - in: query name: application_type schema: type: string - in: query name: closed_at schema: type: string - in: query name: image_uuid schema: type: string - in: query name: payer_uuid schema: type: string - in: query name: is_overdraft_fees_present schema: type: string - in: query name: input_validation schema: type: string - in: query name: assignment_tenant schema: type: string - in: query name: is_case_unassigned schema: type: boolean - in: query name: is_minimum_balance_present schema: type: string - in: query name: amount schema: type: string - in: query name: merchant_name schema: type: string - in: query name: alert_threshold_id schema: type: string - in: query name: planned_production_release_date schema: type: string - in: query name: approval schema: type: string - in: query name: provider_rules schema: type: string - in: query name: support_status schema: type: string - in: query name: initiator schema: type: string - in: query name: is_interest_earned_period_present schema: type: string - in: query name: support_issue_time schema: type: string - in: query name: customer_segments schema: type: string - in: query name: customer_address schema: type: string - in: query name: partner_monitoring_schedule_uuid schema: type: string - in: query name: narrative schema: type: string - in: query name: is_interest_accrual_date_present schema: type: string - in: query name: customer_uuid schema: type: string - in: query name: resolution schema: type: string - in: query name: watchlist_name schema: type: string - in: query name: extenuating_circumstances schema: type: string - in: query name: gitlab_issue_id schema: type: string - in: query name: suspicious_activity_subtype_id schema: type: string - in: query name: reg_e_deadline_date schema: type: string - in: query name: is_system_present schema: type: string - in: query name: report_start_date schema: type: string - in: query name: is_notification_type_present schema: type: string - in: query name: page schema: minimum: 0 type: integer - in: query name: external_case_id schema: type: string - in: query name: card_exp_date schema: type: string - in: query name: international_wire_id schema: type: string - in: query name: case_type schema: type: string - in: query name: reason schema: type: string - description: email of the person/customer to search on in all cases in: query name: email schema: type: string - in: query name: dispute_amount schema: type: string - in: query name: incoming_ach_id schema: type: string - in: query name: recovery_amount schema: type: string - in: query name: uploaded_at schema: type: string - in: query name: account_id schema: type: string - in: query name: active_assignment_tenant schema: type: string - in: query name: reg_e_extended_investigation_due_date schema: type: string - in: query name: party_type schema: type: string - in: query name: receiver_party_uuid schema: type: string - in: query name: reg_e_investigation_due_date schema: type: string - in: query name: is_routing_number_present schema: type: string - in: query name: disclosure_uuid schema: type: string - in: query name: related_party_uuids schema: type: string - in: query name: limit_id schema: type: string - in: query name: pc_reversal_date schema: type: string - in: query name: business_id schema: type: string - in: query name: support_ref_link schema: type: string - description: >- current_owner is the tenant of the bank/fintech that's supposed to action the case. current_owner changes based on the case state in: query name: current_owner schema: type: string - in: query name: party_address schema: type: string - in: query name: is_transaction_fraud schema: type: string - in: query name: processing_dispute schema: type: string - in: query name: pc_reversal_amount schema: type: string - in: query name: card_last_4 schema: type: string - in: query name: rule_failure_details schema: type: string - in: query name: vendor_info schema: type: string - in: query name: per_page schema: minimum: 1 type: integer - in: query name: support_type schema: type: string - description: Filter by cases opened from the specified case identifier. in: query name: opened_from schema: example: 17214 type: integer - in: query name: case_reason schema: type: string - in: query name: state schema: type: string - in: query name: assignee_uuids schema: description: >- The array of party/group UUIDs to get all cases with overlapped assignees. items: type: string type: array - in: query name: evaluation_uuid schema: type: string - in: query name: rule_id schema: type: string - in: query name: credit_dispute_uuid schema: type: string - in: query name: failure_reason schema: type: string - in: query name: originator_party_uuid schema: type: string - in: query name: active_assignment_user_id schema: type: string - in: query name: originating_account_id schema: type: string - in: query name: transaction_amount schema: type: string - in: query name: network_reference_id schema: type: string - in: query name: sender_currency schema: type: string - in: query name: uat_test_date schema: type: string - in: query name: is_statement_period_end_present schema: type: string - in: query name: report_id schema: type: string - in: query name: card_status schema: type: string - in: query name: transaction_id schema: type: string - in: query name: recovery_date schema: type: string - in: query name: is_account_older_30_days schema: type: string - in: query name: suspicious_activity_type_id schema: type: string - in: query name: accounting_sign_off schema: type: string - in: query name: total_amount schema: type: string - in: query name: account_uuid schema: type: string - in: query name: is_total_returned_fees_present schema: type: string - in: query name: deposit_uuid schema: type: string - in: query name: planned_production_removal_date schema: type: string - in: query name: spend_control_violation_counter schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/case_list_response' description: OK components: schemas: case_list_response: allOf: - properties: results: description: The list of cases matching the request's filters. items: $ref: '#/components/schemas/CaseSchema' type: array required: - results type: object - $ref: '#/components/schemas/page_info' description: A paginated list of cases, returned by GET /cases. CaseSchema: allOf: - $ref: '#/components/schemas/case_extensions' - $ref: '#/components/schemas/case_schema_base' description: >- A case, combining the common case fields with any type-specific extension data. page_info: properties: next: description: The URL for the next page of results type: string pages: description: The total number of pages type: integer prev: description: The URL for the previous page of results type: string total: description: The total number of results type: integer required: - pages - total case_extensions: description: >- Type-specific data for a case. Only the property matching the case's case_type is expected to be populated. properties: account_closure: $ref: '#/components/schemas/AccountClosure' aml: $ref: '#/components/schemas/AML' application: $ref: '#/components/schemas/Application' balance_monitoring: $ref: '#/components/schemas/BalanceMonitoring' business_alert: $ref: '#/components/schemas/BusinessAlert' custom_card_review: $ref: '#/components/schemas/CustomCardReview' customer_alert: $ref: '#/components/schemas/CustomerAlert' disclosure: $ref: '#/components/schemas/Disclosure' dispute: $ref: '#/components/schemas/Dispute' fintech_profile_document: $ref: '#/components/schemas/FintechProfileDocument' fraud: $ref: '#/components/schemas/Fraud' information_request: $ref: '#/components/schemas/InformationRequest' interest_calculation: $ref: '#/components/schemas/InterestCalculation' international_wire: $ref: '#/components/schemas/InternationalWire' invoice: $ref: '#/components/schemas/Invoice' kyb: $ref: '#/components/schemas/KYB' kyc: $ref: '#/components/schemas/KYC' lost_card: $ref: '#/components/schemas/LostCard' marketing_material: $ref: '#/components/schemas/MarketingMaterial' partner_monitoring_request: $ref: '#/components/schemas/PartnerMonitoringRequest' payment_alert: $ref: '#/components/schemas/PaymentAlert' product_testing: $ref: '#/components/schemas/ProductTesting' program_spend_limit: $ref: '#/components/schemas/ProgramSpendLimit' purchase_verification: $ref: '#/components/schemas/PurchaseVerification' rdc: $ref: '#/components/schemas/RDC' reconciliation: $ref: '#/components/schemas/Reconciliation' risk_review: $ref: '#/components/schemas/RiskReview' rule_changes: $ref: '#/components/schemas/RuleChanges' sar: $ref: '#/components/schemas/SAR' spend_monitoring: $ref: '#/components/schemas/SpendMonitoring' statement_verification: $ref: '#/components/schemas/StatementVerification' support_request: $ref: '#/components/schemas/SupportRequest' transaction_review: $ref: '#/components/schemas/TransactionReview' watchlist_match: $ref: '#/components/schemas/WatchlistMatch' type: object case_schema_base: description: The fields common to every case, regardless of case_type. properties: assignees: description: The ids of the users or groups assigned to the case. items: type: string type: array assignments: description: The history of assignments for the case. items: $ref: '#/components/schemas/CaseAssignment' type: array attachments: description: The files attached to the case. items: $ref: '#/components/schemas/FileReference' type: array bank_id: description: The identifier of the bank associated with the case. maxLength: 80 type: string case_type: $ref: '#/components/schemas/case_type' closed_at: description: The date and time the case was closed, if applicable. format: date-time type: string created_at: description: The date and time the case was created. format: date-time type: string created_by: description: The identifier of the user or system that created the case. maxLength: 36 type: string current_assignment_id: description: The id of the current CaseAssignment for this case, if any. format: uuid type: string current_owner: description: >- The tenant of the bank/fintech that is currently responsible for actioning the case. Changes based on the case state. type: string description: description: A free-text description of the case. type: string escalated_at: description: The date and time the case was escalated, if applicable. format: date-time type: string followers: description: >- The id of the users who are following the case. They will receive notifications about updates to the case. items: type: string type: array id: description: The unique identifier of the case. type: integer last_assignment_id: description: The id of the most recent CaseAssignment for this case, if any. format: uuid type: string notes: description: The notes attached to the case. items: $ref: '#/components/schemas/Note' type: array opened_from: description: >- Stores the ID of the previous case, if applicable. Used for cases requiring follow-up actions or investigations. example: 17214 type: integer partner_id: description: The identifier of the partner associated with the case. maxLength: 80 type: string priority: $ref: '#/components/schemas/case_priority' related_resource_id: description: >- The ID of the resource this case is linked to. Useful for cases with a single related resource, eliminating the need for a case extension. format: uuid type: string related_resource_type: $ref: '#/components/schemas/related_resource_type' state: $ref: '#/components/schemas/case_state' status: $ref: '#/components/schemas/case_status' subjects: description: >- The identifiers of the parties or resources that are the subject of the case. items: type: string type: array tenant: description: The tenant that currently owns the case. maxLength: 80 type: string title: description: A short, human-readable title for the case. maxLength: 255 type: string updated_at: description: The date and time the case was last updated. format: date-time type: string updated_by: description: The identifier of the user or system that last updated the case. maxLength: 36 type: string required: - bank_id - case_type - partner_id - state - tenant - title type: object AccountClosure: properties: account_uuid: format: uuid type: string case_reason: enum: - change_of_legal_address - delayed_account_closure - draft_issuance - external_account_changes - suspended_account - transactions_posted_after_closure type: string closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_uuid: format: uuid type: string transaction_ids: items: format: uuid type: string type: array updated_at: format: date-time type: string required: - account_uuid - case_reason - party_uuid type: object AML: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_address: type: string party_created_at: format: date-time type: string party_email: format: email type: string party_name: type: string party_type: enum: - BUSINESS - CUSTOMER type: string party_uuid: format: uuid type: string related_party_uuids: items: format: uuid type: string type: array report_id: type: string report_type: enum: - US_SAR type: string rule_failure_info: items: $ref: '#/components/schemas/RuleFailureInfoAML' type: array transactions: items: $ref: '#/components/schemas/TransactionAML' type: array updated_at: format: date-time type: string type: object Application: properties: application_id: maxLength: 36 type: string application_type: enum: - RESTRICTED type: string business_id: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: format: uuid type: string id: type: integer updated_at: format: date-time type: string required: - application_id - application_type type: object BalanceMonitoring: properties: account_uuid: maxLength: 36 type: string balance_alert_reason: type: string balance_reason: enum: - CARD NETWORK CHARGEBACK - CARD NETWORK FORCE POST - CLOSED ACCOUNT - FRAUD - OTHER - SUSPENDED ACCOUNT - SYSTEM ISSUE - TIMING ISSUE type: string closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_type: enum: - BUSINESS - PERSONAL type: string party_uuid: maxLength: 36 type: string recovery_amount: type: integer recovery_date: format: date-time type: string recovery_status: enum: - FULLY RECOVERED - NOT RECOVERED - PARTIALLY RECOVERED type: string recovery_transaction_id: maxLength: 36 type: string transaction_amount: type: integer transaction_date: format: date-time type: string transaction_id: maxLength: 36 type: string transaction_type: enum: - ACH - CARD - CASH - CHECK - OTHER - WIRE type: string updated_at: format: date-time type: string type: object BusinessAlert: properties: alert_ids: items: format: uuid type: string type: array business_id: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer updated_at: format: date-time type: string required: - alert_ids - business_id type: object CustomCardReview: properties: closed_at: format: date-time type: string comments: type: string created_at: format: date-time type: string id: type: integer image_rejection_reason: enum: - BRANDED - COPYRIGHT - INAPPROPRIATE - OTHER - PROMOTIONAL - TRADEMARK type: string image_uuid: format: uuid type: string party_uuid: format: uuid type: string updated_at: format: date-time type: string required: - image_uuid - party_uuid type: object CustomerAlert: properties: alert_uuids: items: format: uuid type: string type: array closed_at: format: date-time type: string created_at: format: date-time type: string customer_uuid: format: uuid type: string id: type: integer updated_at: format: date-time type: string required: - alert_uuids - customer_uuid type: object Disclosure: properties: account_uuid: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string disclosure_type: enum: - ACH_AUTHORIZATION - CARDHOLDER_AGREEMENT - E_SIGN - KYC_DATA_COLLECTION - PRIVACY_NOTICE - REG_CC - REG_DD - REG_E - SC_ACCOUNT_AGREEMENT - SC_AUTO_PAYMENT - SC_SECURITY_AGREEMENT - TERMS_AND_CONDITIONS type: string disclosure_uuid: format: uuid type: string id: type: integer party_uuid: format: uuid type: string results: type: object updated_at: format: date-time type: string required: - disclosure_type - party_uuid type: object Dispute: properties: account_uuid: format: uuid type: string auth_dispute: $ref: '#/components/schemas/AuthorizationDispute' card_exp_date: pattern: ^\d{4}-(0[1-9]|1[0-2])$ type: string card_last_4: pattern: ^\d{4}$ type: string card_status: enum: - IN_POSSESSION - LOST_OR_STOLEN type: string card_uuid: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_address: type: string customer_email: format: email type: string customer_phone: type: string dispute_amount: type: integer dispute_type: enum: - AUTHORIZATION - CONSUMER - FRAUD - PROCESSING type: string dispute_uuid: format: uuid type: string external_case_id: type: string final_message_date: format: date type: string fraud_dispute: $ref: '#/components/schemas/FraudDispute' id: type: integer is_account_older_30_days: type: boolean is_transaction_fraud: type: boolean merchant_name: type: string party_uuid: format: uuid type: string payment_type: enum: - ACH - DEBIT_CARD - EXTERNAL_CARD type: string pc_reversal_amount: type: integer pc_reversal_date: format: date type: string processing_dispute: $ref: '#/components/schemas/ProcessingDispute' provisional_credit_amount: type: integer provisional_credit_date: format: date type: string reg_e_deadline_date: format: date type: string reg_e_deadline_extended_date: format: date type: string reg_e_extended_investigation_due_date: format: date type: string reg_e_investigation_due_date: format: date type: string reported_date: format: date type: string transaction_uuid: format: uuid type: string updated_at: format: date-time type: string type: object FintechProfileDocument: properties: closed_at: format: date-time type: string created_at: format: date-time type: string document_id: type: string document_type: enum: - ACH_AUTHORIZATION_AND_AGREEMENT_DISCLOSURE - ACH_POLICY - ADA_POLICY - ADVERSE_ACTION_REPORT - APPLICATION_AND_DATA_FLOW_DIGRAM - APPLICATION_DEVELOPMENT_AND_SECURITY - BSA_AML_OFAC_KYC_RISK_ASSESSMENT - BSA_AML_OFAC_POLICY - BSA_AML_OFAC_PROCEDURE - BSA_AUDIT_REMEDIATION_PLAN - BSA_AUDIT_RESULTS - BSA_SELF_AUDIT_REMEDIATION_PLAN - BSA_SELF_AUDIT_RESULTS - BUSINESS_CONTINUITY - CAPITALIZATION_TABLE - CARD_ART_BACK - CARD_ART_DIGITAL - CARD_ART_FINTECH_ICON - CARD_ART_FINTECH_LOGO - CARD_ART_FRONT - CARD_CARRIER_ART - CERTIFICATES_OF_GOOD_STANDING - CERT_OF_INCORPORATION_OR_NAME_CHANGE - CODE_OF_ETHICS_AND_WHISTLEBLOWER_POLICY - COMMERCIAL_CHECKING_ACCOUNT_AGREEMENT - COMMERCIAL_SMART_CARD_AGREEMENT - COMPLIANCE_ASSESSMENT - COMPLIANCE_AUDIT_REMEDIATION_PLAN - COMPLIANCE_AUDIT_RESULTS - COMPLIANCE_ISSUES_TRACKING_LOG - COMPLIANCE_MANAGEMENT_SYSTEM_POLICY - COMPLIANCE_SELF_AUDIT_REMEDIATION_PLAN - COMPLIANCE_SELF_AUDIT_RESULTS - COMPLIANCE_TRAINING_LOGS - COMPLIANCE_TRAINING_PLAN - CONSUMER_CHECKING_ACCOUNT_AGREEMENT - CONSUMER_COMPLAINT_PROCEDURE - CONSUMER_SMART_CARD_AGREEMENT - CONSUMER_SMART_CARD_AGREEMENT_ATM_FEATURE - CREDIT_AGREEMENT - CUSTOMER_COMPLAINTS - CUSTOMER_SERVICE_CONTACT_GUIDE - DEBIT_CARD_INTERCHANGE_FEES_AND_ROUTING - DEPOSIT_ACCOUNT_AGREEMENT - DESC_OWNERSHIP_STRUCTURE - DISASTER_RECOVERY_AND_FAILOVER_PLANS - DUE_DILIGENCE_ASSESSMENT - EFTA_POLICY - EIN_VERIFICATION_LETTER - ENCRYPTION_KEY_MANAGEMENT_PLAN - EQUAL_LENDING_POLICY - ERROR_RESOLUTION_PROCEDURES - EVIDENCE_OF_PERMITS_OR_LICENSES - E_SIGN_CONSENT_DISCLOSURE - E_SIGN_POLICY - FAIR_CREDIT_REPORTING_ACT_DISCLOSURE - FAIR_CREDIT_REPORTING_ACT_POLICY - FAIR_DEBT_COLLECTION_POLICY - FINANCIAL_PROJECTIONS - FRAUD_INTAKE_ASSESSMENT - FRCA_PROCEDURES - FRONT_BACK_ID_PHOTOS - GENERAL_UPLOAD - ID_THEFT_RED_FLAGS_RISK_ASSESSMENT - INCIDENT_RESPONSE_PLAN - INFORMATION_SECURITY_POLICY - INSURANCE_COVERAGE - INSURANCE_COVERAGE_SYNCTERA - KYC_DISCLOSURE - LEGAL_REGULATORY_GENERAL_UPLOAD - LINE_OF_CREDIT_AGREEMENT - MARKETING_AND_ADVERTISING_POLICY - MGMT_TEAM_BACKGROUND - MGMT_TEAM_ORG_CHART - MILITARY_LENDING_POLICY - MISC_DOCUMENTS - MOBILE_BANKING_POLICY - PENETRATION_TESTING - PITCH_DECK - PLAID_READINESS_CORE_EXCHANGE - PLAID_READINESS_LOGO - POST_REMEDIATION_PENETRATION_TESTING - PREVIOUS_FINANCIAL_STATEMENTS - PREV_THREE_MONTHS_BANK_STATEMENTS - PRIVACY_NOTICE_PROCESS - PRIVACY_NOTICE_WITHOUT_AFFILIATES_NO_OPT_OUT - PRIVACY_NOTICE_WITHOUT_AFFILIATES_OPT_OUT - PRIVACY_NOTICE_WITH_AFFILIATES_NO_OPT_OUT - PRIVACY_NOTICE_WITH_AFFILIATES_OPT_OUT - PRIVACY_POLICY - RECORD_RETENTION_POLICY - REG_B_DISCLOSURE - REG_CC_POLICY - REG_DD_POLICY - REG_E_PROCEDURE - REG_Z_TRUTH_IN_LENDING_ACT_DISCLOSURE - REG_Z_TRUTH_IN_LENDING_ACT_POLICY - REG_Z_TRUTH_IN_LENDING_ACT_PROCEDURE - RISK_ANALYSIS - SECURED_CREDIT_AGREEMENT - SOLUTIONS_SUMMARY - TCPA_POLICY - THIRD_PARTY_RISK_LIST_AND_RISK_RATING_TRACKER - THIRD_PARTY_RISK_MANAGEMENT_POLICY - THIRD_PARTY_RISK_REVIEW_REPORTS_AND_SUPPORTING_DOCUMENTS - THREE_YEAR_PROJECTION_TEMPLATES - UDAAP_POLICY - UDAAP_RISK_ASSESSMENT - ULTIMATE_BENEFICIAL_OWNERSHIP_FORM - UNCLAIMED_PROPERTY_POLICY - UNSECURED_CREDIT_AGREEMENT - USER_JOURNEY - VULNERABILITY_SCANNING - WIRE_TRANSFER_POLICY type: string fintech_profile_document_id: type: string id: type: integer latest_document_version: type: integer updated_at: format: date-time type: string required: - document_id - fintech_profile_document_id - latest_document_version type: object Fraud: properties: closed_at: format: date-time type: string created_at: format: date-time type: string fraud_detector: enum: - DISPUTE - NETWORK - SYNCTERA - VENDOR type: string id: type: integer originator_account_uuid: format: uuid type: string originator_party_uuid: format: uuid type: string outcome: type: string payment_type: enum: - ACH - AFT - AFTOCT - CARD - CASH - CASH_PICKUP - CHECK - DEBIT_CARD - EFT_CA - EXTERNAL_CARD - INTERNAL_TRANSFER - MRDC - OCT - SWIFT - WIRE type: string provider: type: string provider_info: {} provider_rules: items: type: string type: array receiver_account_uuid: format: uuid type: string receiver_party_uuid: format: uuid type: string transaction: {} transaction_uuid: format: uuid type: string updated_at: format: date-time type: string required: - outcome - payment_type - provider - provider_info - transaction - transaction_uuid type: object InformationRequest: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer initiator: pattern: \d+_\d+$ type: string receiver: pattern: \d+_\d+$ type: string updated_at: format: date-time type: string required: - initiator - receiver type: object InterestCalculation: properties: account_uuid: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string effective_date: format: date-time type: string failure_reason: type: string id: type: integer type: enum: - BACKDATED_PAYMENT - FAILURE type: string updated_at: format: date-time type: string required: - account_uuid - effective_date - type type: object InternationalWire: properties: amount_in_beneficiary_currency: type: integer beneficiary_currency: type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: format: uuid type: string id: type: integer international_wire_id: format: uuid type: string network_reference_id: type: string originating_account_id: format: uuid type: string reason: type: string receiving_account_id: format: uuid type: string sender_amount: type: integer sender_currency: type: string status: enum: - CANCELLED - COMPLETED - CONFIRMED - DECLINED - PENDING type: string transaction_id: format: uuid type: string updated_at: format: date-time type: string required: - amount_in_beneficiary_currency - beneficiary_currency - customer_id - international_wire_id - originating_account_id - receiving_account_id - sender_amount - sender_currency - transaction_id type: object Invoice: properties: accounting_sign_off: type: string approval: type: boolean ceo_sign_off: type: string closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer input_validation: type: boolean updated_at: format: date-time type: string required: - approval - input_validation type: object KYB: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_uuid: format: uuid type: string updated_at: format: date-time type: string required: - party_uuid type: object KYC: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_uuid: format: uuid type: string updated_at: format: date-time type: string required: - party_uuid type: object LostCard: properties: closed_at: format: date-time type: string created_at: format: date-time type: string description: type: string extenuating_circumstances: type: boolean id: type: integer resolution: type: string updated_at: format: date-time type: string required: - description - resolution type: object MarketingMaterial: properties: closed_at: format: date-time type: string created_at: format: date-time type: string customer_segments: items: type: string type: array id: type: integer marketing_channels: items: type: string type: array planned_production_release_date: format: date type: string planned_production_removal_date: format: date type: string related_products: items: type: string type: array updated_at: format: date-time type: string type: object PartnerMonitoringRequest: properties: closed_at: format: date-time type: string created_at: format: date-time type: string details: type: string id: type: integer partner_monitoring_schedule_uuid: format: uuid type: string updated_at: format: date-time type: string required: - details - partner_monitoring_schedule_uuid type: object PaymentAlert: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer incoming_ach_id: format: uuid type: string transaction_id: format: uuid type: string type: enum: - INCOMING_NOC type: string updated_at: format: date-time type: string type: object ProductTesting: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer lifecycle_test_date: format: date type: string performance_test_date: format: date type: string statement_system_name: type: string statement_system_version: type: integer uat_test_date: format: date type: string updated_at: format: date-time type: string uploaded_at: format: date-time type: string type: object ProgramSpendLimit: properties: alert_threshold_id: format: uuid type: string alert_type: enum: - LIMIT_EXCEEDED - LIMIT_WARNING type: string bucket_id: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string effective_date: format: date type: string id: type: integer limit_id: format: uuid type: string updated_at: format: date-time type: string required: - alert_threshold_id - alert_type - bucket_id - effective_date - limit_id type: object PurchaseVerification: properties: account_id: format: uuid type: string business_id: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: format: uuid type: string id: type: integer rule_failure_details: items: $ref: '#/components/schemas/RuleFailureDetails' type: array rule_id: format: uuid type: string transaction_id: type: string updated_at: format: date-time type: string verification_type: enum: - CANNABIS_DEPOSIT - CANNABIS_STATE_RULES type: string required: - account_id type: object RDC: properties: closed_at: format: date-time type: string created_at: format: date-time type: string deposit_uuid: format: uuid type: string id: type: integer updated_at: format: date-time type: string required: - deposit_uuid type: object Reconciliation: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer transaction_ids: items: type: string type: array updated_at: format: date-time type: string type: object RiskReview: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer party_uuid: format: uuid type: string updated_at: format: date-time type: string required: - party_uuid type: object RuleChanges: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer updated_at: format: date-time type: string type: object SAR: properties: account_ids: items: format: uuid type: string type: array business_id: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: format: uuid type: string id: type: integer narrative: type: string other_suspicious_activity_type_text: type: string report_end_date: format: date type: string report_start_date: format: date type: string sar_type: enum: - CONTINUOUS - PRIORITY - TERMINATION type: string suspicious_activity_subtype_id: type: string suspicious_activity_type_id: type: string total_amount: type: integer updated_at: format: date-time type: string type: object SpendMonitoring: properties: account_id: maxLength: 36 type: string card_id: description: The ID of the card that is violating spend limits. format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: description: The ID of the customer that is violating spend limits. format: uuid type: string id: type: integer spend_control_id: maxLength: 36 type: string spend_control_violation_counter: type: integer transaction_id: maxLength: 36 type: string updated_at: format: date-time type: string type: object StatementVerification: properties: account_uuid: format: uuid type: string closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer is_account_number_present: type: boolean is_apy_earned_present: type: boolean is_balance_present: type: boolean is_interest_accrual_date_present: type: boolean is_interest_calculation_type_present: type: boolean is_interest_earned_period_present: type: boolean is_interest_earned_to_date_present: type: boolean is_minimum_balance_present: type: boolean is_notification_type_present: type: boolean is_overdraft_fees_present: type: boolean is_routing_number_present: type: boolean is_statement_availability_date_present: type: boolean is_statement_number_present: type: boolean is_statement_period_end_present: type: boolean is_statement_period_start_present: type: boolean is_system_present: type: boolean is_total_returned_fees_present: type: boolean party_uuids: items: format: uuid type: string type: array updated_at: format: date-time type: string required: - account_uuid - party_uuids type: object SupportRequest: properties: closed_at: format: date-time type: string created_at: format: date-time type: string gitlab_issue_id: type: string id: type: integer initiator: pattern: \d+_\d+$ type: string receiver: pattern: \d+_\d+$ type: string support_issue_time: type: string support_ref_link: type: string support_status: enum: - CLOSED - INFORMATION_REQUESTED - IN_PROGRESS - IN_REVIEW - SUBMITTED type: string support_type: enum: - BUG - COMPLIANCE - FEATURE_REQUEST - GENERAL - IMPLEMENTATION_AND_ONBOARDING - TECHNICAL - T_10 type: string updated_at: format: date-time type: string required: - initiator - receiver type: object TransactionReview: properties: amount: type: integer closed_at: format: date-time type: string created_at: format: date-time type: string current_owner_groups: items: format: uuid type: string type: array description: type: string id: type: integer initiator_id: format: uuid type: string payment_id: type: string payment_subtype: enum: - BULK_DOMESTIC_OUTGOING - DOMESTIC_OUTGOING - OUTGOING_CREDIT - OUTGOING_DEBIT type: string payment_type: enum: - ACH - WIRE type: string threshold_config_snapshot: $ref: '#/components/schemas/PaymentReviewTypeConfigSchema' transaction_id: format: uuid type: string updated_at: format: date-time type: string required: - amount - payment_type type: object WatchlistMatch: properties: closed_at: format: date-time type: string created_at: format: date-time type: string id: type: integer payee_uuid: format: uuid type: string payer_uuid: format: uuid type: string updated_at: format: date-time type: string vendor_info: type: object verification_uuid: format: uuid type: string watchlist_name: enum: - US_OFAC type: string required: - watchlist_name type: object CaseAssignment: allOf: - $ref: '#/components/schemas/base_assignment_fields' - properties: case_id: description: The id of the case this assignment belongs to type: integer id: description: The unique identifier of the assignment. format: uuid type: string required: - case_id - id description: A record of a case being assigned to a user or group. type: object FileReference: description: A file attached to a case or a note on a case. properties: case_id: description: The id of the case this file is attached to. type: integer content_type: description: The MIME type of the file. type: string created_at: description: The date and time the file was uploaded. format: date-time type: string created_by: description: The identifier of the user who uploaded the file. type: string description: description: A free-text description of the file. type: string filename: description: The name of the file. type: string id: description: The unique identifier of the file reference. type: integer note_id: description: The id of the note this file is attached to, if applicable. type: integer object_metadata: {} target_object: description: >- The storage location or identifier used to retrieve the file's contents. type: string updated_at: description: The date and time the file reference was last updated. format: date-time type: string updated_by: description: The identifier of the user who last updated the file reference. type: string required: - case_id - filename - target_object type: object case_type: description: >- The category of a case, which determines which case extension (if any) contains additional type-specific data. enum: - account_closure - aml - application - balance_monitoring - business_alert - credit_dispute - custom_card_review - customer_alert - disclosure - dispute - edd - fintech_profile_document - fraud - information_request - interest_calculation - international_wire - invoice - kyb - kyc - lost_card - marketing_material - partner_monitoring_request - payment_alert - product_testing - program_spend_limit - purchase_verification - rdc - reconciliation - risk_review - rule_changes - sar - spend_monitoring - statement_verification - support_request - transaction_review - uar - watchlist_match type: string Note: description: A note added to a case, optionally with attached files. properties: author_organization: $ref: '#/components/schemas/Organization' case_id: description: The id of the case this note belongs to. type: integer content: description: Plain text content (legacy and fallback) type: string created_at: description: The date and time the note was created. format: date-time type: string created_by: description: The identifier of the user who created the note. type: string files: description: The files attached to the note. items: $ref: '#/components/schemas/FileReference' type: array id: description: The unique identifier of the note. type: integer rich_text_content: description: Markdown format for rich text content example: This is **bold** text and this is *italic* text nullable: true type: string updated_at: description: The date and time the note was last updated. format: date-time type: string updated_by: description: The identifier of the user who last updated the note. type: string user_tenant: description: The bank/partner tenant of the user who authored the note. pattern: \d+_\d+$ type: string required: - case_id - content - user_tenant type: object case_priority: description: >- The urgency assigned to a case, used to help teams triage their workload. enum: - critical - fyi - high - low - medium - urgent type: string related_resource_type: description: >- The type of resource this case is linked to. Useful for cases with a single related resource, eliminating the need for a case extension. enum: - AML - CREDIT_DISPUTE - EDD - EVALUATION - MONITORING_EVENT - RDC - SANCTIONS_SCREENING - UAR type: string case_state: description: >- The detailed state of a case within its workflow. Valid states vary by case_type; not every state applies to every case type. enum: - acknowledged - action_required - approved - cancelled - closed - complete - confirmed - decision - declined - escalated - failed - fraudulent - in_progress - info_gathered - info_requested - match - money_laundering - new - no_match - not_fraudulent - not_money_laundering - not_violation - passed - recovered - rejected - review - review_by_bank_exec - review_by_bank_risk - review_by_fintech_ops - review_by_synctera_exec - review_by_synctera_ops - review_by_synctera_risk - support_requested - support_responded - violation type: string case_status: description: The high-level lifecycle status of a case. enum: - CLOSED - NEW - ON_HOLD - REVIEW type: string RuleFailureInfoAML: properties: failure_at: type: string failure_reason: type: string rule_description: type: string rule_name: type: string type: object TransactionAML: properties: info: type: object payment_type: enum: - ACH - DEBIT_CARD type: string transaction_amount: type: integer transaction_at: type: string transaction_uuid: type: string type: object AuthorizationDispute: properties: authorized_amount: type: integer type: object FraudDispute: properties: channel: type: string is_card_present: type: boolean is_pin_present: type: boolean network: type: string processing_type: type: string subnetwork: type: string type: object ProcessingDispute: properties: acquirer_ref_data: type: string acquirer_switch_serial_number: type: integer details: type: string is_customer_participant: type: boolean processing_dispute_type: enum: - ADDENDUM - AGGREMENT_NOT_DISCLOSED - COUNTERFEIT_GOODS - CREDIT_NOT_PROCESSED - CREDIT_POSTED_PURCHASE - FAILED_TRAVEL_MERCHANT - INADEQUATE_MERCH - MERCH_NOT_PROVIDED - NO_PURCHASE_CONTROLS_GOODS_LESS_25 - NO_SHOW_CHARGE - RECURRING_TRANSACTION - TIMESHARE_CANCELLED - TRANSACTION_NOT_COMPLETE type: string processing_dispute_type_date: type: string type: object RuleFailureDetails: properties: actual: type: integer description: type: string limit: type: integer rule_name: type: string rule_subtype: enum: - MEDICAL_CANNABIS - RECREATIONAL_CANNABIS type: string unit: type: string type: object PaymentReviewTypeConfigSchema: properties: bank_id: type: string created_at: format: date-time type: string deleted_at: format: date-time type: string fintech_ops_groups: items: type: string type: array id: type: integer partner_id: type: string payment_subtype: enum: - BULK_DOMESTIC_OUTGOING - DOMESTIC_OUTGOING - OUTGOING_CREDIT - OUTGOING_DEBIT type: string payment_type: enum: - ACH - WIRE type: string tenant: type: string thresholds: items: $ref: '#/components/schemas/PaymentTypeThresholdSchema' type: array updated_at: format: date-time type: string required: - payment_type - tenant - thresholds type: object base_assignment_fields: description: Common fields shared by case assignment resources. properties: is_first_assignment: description: Indicates whether the assignment is the first assignment of the case type: boolean is_owner: description: >- Indicates whether the assigned group is the owner of the case, only owners can make the terminal action on the cases type: boolean name: description: The name of the group to which the case is assigned type: string tenant: description: The tenant to which the case is assigned. type: string user_id: description: The ID of the user to whom the case is assigned format: uuid type: string required: - is_first_assignment - is_owner - name - tenant type: object Organization: properties: name: description: The name of the organization type: string type: description: The type of the organization example: partner type: string required: - name - type type: object PaymentTypeThresholdSchema: properties: action: enum: - APPROVE - INFORM type: string bank_id: readOnly: true type: string created_at: format: date-time type: string deleted_at: format: date-time type: string id: type: integer owner_bank_id: readOnly: true type: string owner_groups: items: type: string type: array owner_partner_id: readOnly: true type: string owner_tenant: readOnly: true type: string partner_id: readOnly: true type: string payment_type_config_id: type: integer tenant: type: string threshold: type: integer threshold_level: enum: - BANK_EXEC - BANK_RISK - FINTECH_OPS - SYNCTERA_EXEC - SYNCTERA_OPS - SYNCTERA_RISK type: string updated_at: format: date-time type: string required: - action - tenant - threshold - threshold_level type: object securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````