> ## Documentation Index > Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update Transaction > Update a financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations. This endpoint supports: **Partial updates**: All fields are optional - only provide the fields you want to update. **Status management**: Update transaction status from pending to completed, failed, or cancelled. **Relationship updates**: Modify debtor/creditor payment means, entities, documents, and workspace associations. **Financial adjustments**: Update amounts, foreign exchange rates, fees, and remittance information. **Audit trail**: Automatically updates the `updated_at` timestamp while preserving creation history. **Data integrity**: Validates business rules and maintains consistency across related entities. ## OpenAPI ````yaml PATCH /v1/transactions/{id} openapi: 3.1.0 info: title: Well Document API version: 1.0.0 description: API for uploading and managing financial documents in the Well platform servers: - url: https://api.wellapp.ai security: [] paths: /v1/transactions/{id}: patch: tags: - Transactions summary: Update an existing transaction description: >- Update a financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations. This endpoint supports: **Partial updates**: All fields are optional - only provide the fields you want to update. **Status management**: Update transaction status from pending to completed, failed, or cancelled. **Relationship updates**: Modify debtor/creditor payment means, entities, documents, and workspace associations. **Financial adjustments**: Update amounts, foreign exchange rates, fees, and remittance information. **Audit trail**: Automatically updates the `updated_at` timestamp while preserving creation history. **Data integrity**: Validates business rules and maintains consistency across related entities. operationId: updateTransaction parameters: - $ref: '#/components/parameters/AuthorizationHeader' - name: id in: path required: true description: The unique identifier of the transaction to update schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440010 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionPatch' example: type: transaction attributes: status: completed executed_at: '2024-01-15T14:35:00Z' booking_date: '2024-01-15' value_date: '2024-01-15' settlement_amount: currency: USD amount: 1355.25 foreign_exchange: currency_rate: '1.0842' currency_rate_source: ECB currency_rate_at: '2024-01-15T14:35:00Z' remittance_information: unstructured: Salary payment January 2024 - Updated structured_reference: RF18539007547034 reference_type: SCOR fees: - type: transfer_fee amount: 2.5 currency: EUR - type: exchange_fee amount: 7.5 currency: EUR relationships: documents: data: - type: invoice id: 550e8400-e29b-41d4-a716-446655440004 - type: document id: 550e8400-e29b-41d4-a716-446655440020 responses: '200': description: Transaction updated successfully content: application/json: schema: $ref: '#/components/schemas/TransactionResponse' example: data: type: transaction id: 550e8400-e29b-41d4-a716-446655440010 attributes: scheme: sepa external_ids: transaction_id: TXN_SEPA_20240115_001 payment_request_id: PAY_REQ_001 end_to_end_id: E2E_20240115_ACME_001 requested_execution_date: '2024-01-15' executed_at: '2024-01-15T14:35:00Z' booking_date: '2024-01-15' value_date: '2024-01-15' instructed_amount: currency: EUR amount: 1250 settlement_amount: currency: USD amount: 1355.25 foreign_exchange: currency_rate: '1.0842' currency_pair: EURUSD currency_rate_source: ECB currency_rate_at: '2024-01-15T14:35:00Z' transaction_type: transfer status: completed category_purpose: CBFF purpose_code: SALA remittance_information: unstructured: Salary payment January 2024 - Updated structured_reference: RF18539007547034 reference_type: SCOR fees: - type: transfer_fee amount: 2.5 currency: EUR - type: exchange_fee amount: 7.5 currency: EUR created_at: '2024-01-15T14:30:00Z' updated_at: '2024-01-15T14:40:00Z' relationships: debtor_payment_means: data: type: payment_means id: 550e8400-e29b-41d4-a716-446655440000 creditor_payment_means: data: type: payment_means id: 550e8400-e29b-41d4-a716-446655440001 debtor: data: type: company id: 550e8400-e29b-41d4-a716-446655440002 creditor: data: type: people id: 550e8400-e29b-41d4-a716-446655440003 documents: data: - type: invoice id: 550e8400-e29b-41d4-a716-446655440004 - type: document id: 550e8400-e29b-41d4-a716-446655440020 created_by: data: type: people id: 550e8400-e29b-41d4-a716-446655440005 workspaces: data: - type: workspace id: 550e8400-e29b-41d4-a716-446655440006 included: - type: payment_means id: 550e8400-e29b-41d4-a716-446655440000 attributes: type: account_details status: active nickname: Business Primary Account description: Main SEPA account for outgoing payments - type: payment_means id: 550e8400-e29b-41d4-a716-446655440001 attributes: type: account_details status: active nickname: Employee Salary Account description: Dedicated account for receiving salary payments - type: company id: 550e8400-e29b-41d4-a716-446655440002 attributes: name: Acme Corporation description: Leading technology solutions provider - type: people id: 550e8400-e29b-41d4-a716-446655440003 attributes: first_name: John last_name: Doe full_name: John Doe job_title: Software Engineer - type: invoice id: 550e8400-e29b-41d4-a716-446655440004 attributes: invoice_number: INV-2024-0115 amount: 1250 currency: EUR status: paid - type: document id: 550e8400-e29b-41d4-a716-446655440020 attributes: name: Payment Receipt filename: receipt-2024-0115.pdf content_type: application/pdf '400': description: Bad request - invalid transaction data or ID format content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - id: invalid_status_transition status: '400' code: INVALID_STATUS_TRANSITION title: Invalid Status Transition detail: >- Cannot change transaction status from 'completed' to 'pending' source: pointer: /data/attributes/status '401': description: Unauthorized - invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - id: unauthorized status: '401' code: UNAUTHORIZED title: Unauthorized detail: Valid authentication credentials are required '404': description: Transaction not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - id: transaction_not_found status: '404' code: TRANSACTION_NOT_FOUND title: Transaction Not Found detail: >- The requested transaction does not exist or you don't have permission to access it source: parameter: id components: parameters: AuthorizationHeader: name: Authorization in: header required: true schema: type: string description: Bearer token for authentication schemas: TransactionPatch: type: object properties: data: type: object properties: type: type: string const: transaction description: Resource type identifier attributes: $ref: '#/components/schemas/TransactionAttributesPatch' relationships: $ref: '#/components/schemas/TransactionRelationshipsPost' included: $ref: '#/components/schemas/TransactionIncludedPost' required: - type required: - data TransactionResponse: type: object properties: data: type: object properties: type: type: string const: transaction id: type: string format: uuid description: UUID of the created transaction example: 550e8400-e29b-41d4-a716-446655440010 attributes: $ref: '#/components/schemas/TransactionAttributes' relationships: $ref: '#/components/schemas/TransactionRelationshipsPostResponse' included: $ref: '#/components/schemas/TransactionIncludedPostResponse' ErrorResponse: type: object properties: errors: type: array items: type: object properties: status: type: string code: type: string title: type: string detail: type: string required: - status - code - title - detail TransactionAttributesPatch: type: object description: >- Partial update attributes for transaction. All fields are optional for PATCH operations. properties: status: type: string enum: - pending - processing - authorized - completed - failed - rejected - cancelled - reversed description: >- Updated transaction status. See [transaction status](/enums/details-banking-transaction-status) for details. executed_at: type: string format: date-time description: Updated execution timestamp in ISO 8601 format booking_date: type: string format: date description: Updated booking date in YYYY-MM-DD format value_date: type: string format: date description: Updated value date in YYYY-MM-DD format settlement_amount: type: object properties: currency: type: string pattern: ^[A-Z]{3}$ description: Updated settlement currency (ISO 4217 code) amount: type: number multipleOf: 0.01 description: Updated settlement amount foreign_exchange: type: object properties: currency_rate: type: string description: Updated exchange rate as string for precision currency_rate_source: type: string description: Updated source of exchange rate (e.g., ECB, Fed, manual) currency_pair: type: string pattern: ^[A-Z]{3}[A-Z]{3}$ description: Updated currency pair (e.g., EURUSD) fees: type: array items: type: object properties: type: type: string enum: - commission - service - processing - transfer - atm - overdraft - monthly - card - other description: Updated fee type currency: type: string pattern: ^[A-Z]{3}$ description: Updated fee currency amount: type: number multipleOf: 0.01 description: Updated fee amount description: type: string description: Updated fee description remittance_information: type: object properties: unstructured: type: array items: type: string description: Updated unstructured remittance information structured: type: object properties: reference: type: string description: Updated payment reference reference_type: type: string enum: - SCOR - CBFF - REMI - RADM description: Updated reference type reference_issuer: type: string description: Updated reference issuer creditor_reference_information: type: object properties: reference: type: string description: Updated creditor reference reference_type: type: string description: Updated creditor reference type reference_issuer: type: string description: Updated creditor reference issuer external_ids: type: object additionalProperties: type: string description: Updated external system identifiers metadata: type: object additionalProperties: true description: Updated additional metadata TransactionRelationshipsPost: type: object properties: debtor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: >- UUID of an existing payment means or temp-id that references a payment means defined in the included array (source account) required: - type - id required: - data creditor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: >- UUID of an existing payment means or temp-id that references a payment means defined in the included array (destination account) required: - type - id required: - data debtor: type: object properties: data: type: object properties: type: type: string enum: - company - people description: Type of debtor entity id: type: string format: uuid description: >- UUID of an existing company or person, or temp-id that references an entity defined in the included array (entity that initiated the payment) required: - type - id creditor: type: object properties: data: type: object properties: type: type: string enum: - company - people description: Type of creditor entity id: type: string format: uuid description: >- UUID of an existing company or person, or temp-id that references an entity defined in the included array (entity that received the payment) required: - type - id documents: type: object properties: data: type: array items: type: object properties: type: type: string enum: - document - invoice description: Type of document id: type: string format: uuid description: >- UUID of an existing document or invoice, or temp-id that references a document defined in the included array) required: - type - id created_by: type: object properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: >- UUID of an existing person or temp-id that references a person defined in the included array (user who created the transaction record) required: - type - id workspaces: type: object properties: data: type: array items: type: object properties: type: type: string const: workspace id: type: string format: uuid description: >- UUID of an existing workspace or temp-id that references a workspace defined in the included array required: - type - id required: - debtor_payment_means - creditor_payment_means TransactionIncludedPost: type: object properties: debtor_payment_means: type: object properties: type: type: string const: payment_means id: type: string description: Temp-id that references a payment means in the relationships attributes: $ref: '#/components/schemas/PaymentMeansCreateAttributes' creditor_payment_means: type: object properties: type: type: string const: payment_mean id: type: string description: >- Temp-id that references a creditor payment means in the relationships attributes: $ref: '#/components/schemas/PaymentMeansCreateAttributes' debtor: type: object properties: attributes: oneOf: - type: object properties: type: type: string const: - company id: type: string description: Temp-id that references a debtor in the relationships attributes: $ref: '#/components/schemas/CompanyCreateAttributes' - type: object properties: type: type: string const: - people description: Type of debtor entity id: type: string description: Temp-id that references a debtor in the relationships attributes: $ref: '#/components/schemas/PeopleCreateAttributes' creditor: type: object properties: attributes: oneOf: - type: object properties: type: type: string const: - company id: type: string description: Temp-id that references a creditor in the relationships attributes: $ref: '#/components/schemas/CompanyCreateAttributes' - type: object properties: type: type: string const: - people description: Type of debtor entity id: type: string description: Temp-id that references a creditor in the relationships attributes: $ref: '#/components/schemas/PeopleCreateAttributes' documents: type: object properties: data: type: array items: type: object properties: type: type: string enum: - document - invoice id: type: string description: Temp-id that references a documents in the relationships attributes: $ref: '#/components/schemas/DocumentCreateAttributes' created_by: type: object properties: data: type: object properties: type: type: string const: people id: type: string description: >- Temp-id that references a people who create the transaction in the relationships attributes: $ref: '#/components/schemas/PeopleCreateAttributes' workspaces: type: object properties: data: type: object properties: type: type: string const: workspace id: type: string description: Temp-id that workspaces a creditor in the relationships attributes: $ref: '#/components/schemas/WorkspaceCreateAttributes' TransactionAttributes: type: object properties: scheme: type: string enum: - sepa - swift - ach - faster_payments - instant_credit_transfer description: Payment scheme used for the transaction external_ids: type: object properties: transaction_id: type: string description: External transaction identifier from payment provider payment_request_id: type: string description: Payment request identifier end_to_end_id: type: string description: End-to-end reference for tracing the transaction requested_execution_date: type: string format: date description: Date when transaction execution was requested executed_at: type: string format: date-time description: Timestamp when transaction was executed booking_date: type: string format: date description: Date when transaction was booked value_date: type: string format: date description: Value date of the transaction instructed_amount: type: object properties: currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code amount: type: number minimum: 0 description: Amount instructed for the transaction settlement_amount: type: object properties: currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code amount: type: number minimum: 0 description: Amount settled for the transaction foreign_exchange: type: object properties: currency_rate: type: string description: Exchange rate applied currency_pair: type: string pattern: ^[A-Z]{6}$ description: Currency pair (e.g., EURUSD) currency_rate_source: type: string description: Source of the exchange rate currency_rate_at: type: string format: date-time description: Timestamp when exchange rate was applied transaction_type: type: string enum: - payment - transfer - deposit - withdrawal - card_payment - direct_debit - refund - fee - interest - other description: >- Type of transaction. See [transaction types documentation](/enums/transaction) for complete list. status: type: string enum: - pending - completed - failed - cancelled - rejected description: Current status of the transaction category_purpose: type: string description: ISO 20022 category purpose code purpose_code: type: string description: ISO 20022 purpose code remittance_information: type: object properties: unstructured: type: string description: Unstructured remittance information structured_reference: type: string description: Structured creditor reference reference_type: type: string enum: - SCOR - RADM - RPIN - FXDR - DISP - PUOR - SCNR description: >- Type of structured reference. See [remittance reference types](/enums/remittance-info-reference) for details. fees: type: array items: type: object properties: type: type: string enum: - transfer_fee - exchange_fee - processing_fee - commission description: >- Type of fee. See [banking transaction fees](/enums/banking-transaction-fee) for details. amount: type: number minimum: 0 description: Fee amount currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code created_at: type: string format: date-time description: Timestamp when transaction was created updated_at: type: string format: date-time description: Timestamp when transaction was last updated TransactionRelationshipsPostResponse: type: object properties: debtor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: UUID of the debtor payment means (source) creditor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: UUID of the creditor payment means (destination) debtor: type: object properties: data: type: object properties: type: type: string enum: - company - people description: Type of debtor entity id: type: string format: uuid description: UUID of the debtor (entity that initiated the payment) creditor: type: object properties: data: type: object properties: type: type: string enum: - company - people description: Type of creditor entity id: type: string format: uuid description: UUID of the creditor (entity that received the payment) documents: type: object properties: data: type: array items: type: object properties: type: type: string enum: - document - invoice description: Type of document id: type: string format: uuid description: UUID of the document (receipts, confirmations, invoices) created_by: type: object properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: UUID of the user who created the transaction record workspaces: type: object properties: data: type: array items: type: object properties: type: type: string const: workspace id: type: string format: uuid description: UUID of the workspace associated with this transaction TransactionIncludedPostResponse: type: object properties: debtor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: UUID of the debtor payment means (source) attributes: $ref: '#/components/schemas/PaymentMeansAttributes' creditor_payment_means: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid description: UUID of the creditor payment means (destination) attributes: $ref: '#/components/schemas/PaymentMeansAttributes' debtor: type: object properties: attributes: oneOf: - type: object properties: type: type: string const: - company id: type: string format: uuid attributes: $ref: '#/components/schemas/CompanyAttributes' - type: object properties: type: type: string const: - people description: Type of debtor entity id: type: string format: uuid attributes: $ref: '#/components/schemas/PeopleAttributes' creditor: type: object properties: attributes: oneOf: - type: object properties: type: type: string const: - company id: type: string format: uuid attributes: $ref: '#/components/schemas/CompanyAttributes' - type: object properties: type: type: string const: - people description: Type of debtor entity id: type: string format: uuid attributes: $ref: '#/components/schemas/PeopleAttributes' documents: type: object properties: data: type: array items: type: object properties: type: type: string enum: - document - invoice description: Type of document id: type: string format: uuid description: UUID of the document (receipts, confirmations, invoices) attributes: $ref: '#/components/schemas/DocumentAttributes' created_by: type: object properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: UUID of the user who created the transaction record attributes: $ref: '#/components/schemas/PeopleAttributes' workspaces: type: object properties: items: type: object properties: type: type: string const: workspace id: type: string format: uuid description: UUID of the workspace associated with this transaction attributes: $ref: '#/components/schemas/WorkspaceAttributes' PaymentMeansCreateAttributes: type: object required: - type properties: type: type: string enum: - card_details - account_details - wallet_details - ... description: >- Type of payment means. See [payment means types](/enums/payment-means) for details. scheme: type: string enum: - SEPA - SWIFT - ACH - ... description: >- Payment scheme or network. See [scheme types](/enums/sheme-type) for details. status: type: string enum: - active - inactive - pending_verification - suspended - expired - blocked description: >- Current status of the payment means. See [payment means status](/enums/payment-means-status) for details. account_details: type: object description: Bank account details for account_details type properties: iban: type: string pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]+$ description: International Bank Account Number bic: type: string pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ description: Bank Identifier Code (SWIFT) sort_code: type: string pattern: ^[0-9]{6}$ description: Bank sort code (UK) account_number: type: string description: Local account number (alternative to IBAN) routing_number: type: string description: Bank routing number (US ACH) currency: type: string pattern: ^[A-Z]{3}$ description: Currency code (ISO 4217) bank_details: type: object description: Additional bank information properties: bank_name: type: string description: Name of the bank bank_code: type: string description: Bank code or identifier branch_name: type: string description: Bank branch name branch_code: type: string description: Bank branch code card_details: type: object description: Credit/debit card details for card_details type properties: masked_pan: type: string pattern: ^\*{4}-\*{4}-\*{4}-[0-9]{4}$ description: Masked Primary Account Number (PCI DSS compliant) brand: type: string enum: - visa - mastercard - amex - discover - diners - jcb - unionpay - other description: Card brand card_type: type: string enum: - credit - debit - prepaid - charge description: Type of card expiry_month: type: integer minimum: 1 maximum: 12 description: Card expiry month expiry_year: type: integer minimum: 2024 description: Card expiry year cardholder_name: type: string description: Name as printed on card digital_wallet: type: object description: Digital wallet details for wallet_details type properties: provider: type: string enum: - paypal - applepay - googlepay - stripe - square - venmo - cashapp - other description: Digital wallet provider wallet_id: type: string description: Wallet identifier (email, phone, etc.) wallet_type: type: string enum: - personal - business - merchant description: Type of wallet account compliance: type: object description: Compliance and verification status properties: kyc_status: type: string enum: - pending - in_progress - completed - failed - not_required description: Know Your Customer verification status aml_status: type: string enum: - pending - in_progress - cleared - flagged - not_required description: Anti-Money Laundering check status nickname: type: string maxLength: 100 description: User-friendly name for the payment means description: type: string maxLength: 500 description: Additional description of the payment means tags: type: array items: type: string description: Tags for categorization CompanyCreateAttributes: type: object properties: locale: type: string pattern: ^[a-z]{2}(-[A-Z]{2})?$ description: >- Language settings.That’s the locale for the business relationship. Emails or documents can be used to identify the locale. Default EN. example: en-US domain_name_primary_link_url: type: string format: uri description: >- The domain url from the website or email address of the company. Used as unique identifier in some cases. example: https://www.techcorp.com tax_id: type: object properties: value: type: string description: Tax ID issued by local or national tax authority. example: DE123456789 type: type: string description: >- Type of tax ID, useful for applying formatting and validation rules.[all tax id types](/enums/tax-id) See all available labels for complete list. example: - VAT - TVA - IVA - ... registration: oneOf: - type: object properties: trade_name: type: string description: >- Commercial or branding name (if different from registered name). example: TechSol registered_name: type: string description: Legal company name example: TechCorp AI Solutions LLC required: - registered_name - type: object properties: trade_name: type: string description: >- Commercial or branding name (if different from registered name). example: TechSol registered_name: type: string description: Legal company name example: TechCorp AI Solutions LLC required: - trade_name registration_number: type: object properties: business_type: type: string enum: - Inc - Corp - LLC - GmbH - Ltd - SA - SAS description: >- Legal entity structure type. See [all business entity types](/enums/business-entity-by-country) for complete list. example: GmbH value: type: string description: Official company registration number. example: HRB 123456 registry_name: type: string description: >- Name of the official registration body. See [all available registry name](/enums/registry-name) for complete list. example: Handelsregister Berlin registry_country: type: string pattern: ^[A-Z]{2}$ description: |- Country of the registry authority. Must be valid ISO country code example: DE, FR, US, etc. description: type: string minLength: 1 maxLength: 500 description: Company description explaining business purpose in max 2 sentences. example: An innovative technology company focused on AI solutions required: - registration PeopleCreateAttributes: type: object properties: first_name: type: string minLength: 1 maxLength: 50 description: First name of the person example: John last_name: type: string minLength: 1 maxLength: 50 description: Last name of the person (required) example: Doe required: - first_name - last_name additionalProperties: false DocumentCreateAttributes: type: object properties: file_name: type: string status: type: string file_type: type: string size_bytes: type: integer WorkspaceCreateAttributes: type: object properties: name: type: string minLength: 1 maxLength: 255 description: Workspace name description: type: string maxLength: 1000 description: Workspace description avatar_color: type: string pattern: ^#[A-Fa-f0-9]{6}$ description: 'Avatar color in hexadecimal format (e.g., #FF5733)' external_workspace_id: type: string minLength: 1 maxLength: 255 description: External workspace identifier required: - name PaymentMeansAttributes: type: object properties: type: type: string enum: - card_details - account_details - wallet_details - cash_details - check_details - crypto_details - other description: >- Type of payment means. See [payment means types](/enums/payment-means) for details. scheme: type: string enum: - SEPA - SWIFT - ACH - FASTER_PAYMENTS - VISA - MASTERCARD - AMEX - PAYPAL - APPLEPAY - GOOGLEPAY - STRIPE - LOCAL - OTHER description: >- Payment scheme or network. See [scheme types](/enums/sheme-type) for details. status: type: string enum: - active - inactive - pending_verification - suspended - expired - blocked description: >- Current status of the payment means. See [payment means status](/enums/payment-means-status) for details. account_details: type: object description: Bank account details for account_details type properties: iban: type: string description: International Bank Account Number bic: type: string description: Bank Identifier Code (SWIFT) account_number: type: string description: Local account number (alternative to IBAN) routing_number: type: string description: Bank routing number (US ACH) currency: type: string description: Currency code (ISO 4217) bank_details: type: object description: Additional bank information properties: bank_name: type: string description: Name of the bank bank_code: type: string description: Bank code or identifier branch_name: type: string description: Bank branch name branch_code: type: string description: Bank branch code card_details: type: object description: Credit/debit card details for card_details type properties: masked_pan: type: string description: Masked Primary Account Number (PCI DSS compliant) brand: type: string enum: - visa - mastercard - amex - discover - diners - jcb - unionpay - other description: Card brand card_type: type: string enum: - credit - debit - prepaid - charge description: Type of card expiry_month: type: integer description: Card expiry month expiry_year: type: integer description: Card expiry year cardholder_name: type: string description: Name as printed on card digital_wallet: type: object description: Digital wallet details for wallet_details type properties: provider: type: string enum: - paypal - applepay - googlepay - stripe - square - venmo - cashapp - other description: Digital wallet provider wallet_id: type: string description: Wallet identifier (email, phone, etc.) wallet_type: type: string enum: - personal - business - merchant description: Type of wallet account compliance: type: object description: Compliance and verification status properties: kyc_status: type: string enum: - pending - in_progress - completed - failed - not_required description: Know Your Customer verification status aml_status: type: string enum: - pending - in_progress - cleared - flagged - not_required description: Anti-Money Laundering check status sanctions_check: type: string enum: - pending - passed - failed - not_required description: Sanctions screening status last_compliance_check: type: string format: date-time description: Last compliance check timestamp metadata: type: object description: System metadata properties: source: type: string enum: - api - dashboard - import - connector description: How the payment means was created external_id: type: string description: External system identifier nickname: type: string description: User-friendly name for the payment means description: type: string description: Additional description of the payment means tags: type: array items: type: string description: Tags for categorization created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp CompanyAttributes: type: object properties: description: type: string domain_name_primary_link_url: type: string format: url maxLength: 500 description: >- The domain url from the website or email address of the company. Used as unique identifier in some cases. examples: - acme.com tax_id: type: object properties: value: description: Tax ID issued by local or national tax authority. type: string examples: - DE123456789 type: description: >- Type of tax ID, useful for applying formatting and validation rules. type: string examples: - VAT registration: type: object properties: trade_name: description: Commercial or branding name (if different from registered name). type: string examples: - TechSol registered_name: description: Legal company name. type: string minLength: 1 maxLength: 100 examples: - Red Hat Inc. registration_number: type: object properties: business_type: description: Legal entity structure type. type: string examples: - GmbH value: description: Official company registration number. type: string examples: - HRB 123456 registry_name: description: Name of the official registration body. type: string examples: - Handelsregister Berlin registry_country: description: Country of the registry authority. (string (ISO 3166-1 alpha-2)) type: string examples: - DE workspace_id: type: string format: uuid description: UUID of the workspace associated with this company created_at: type: string format: date-time updated_at: type: string format: date-time PeopleAttributes: type: object properties: first_name: type: string description: The person's first name last_name: type: string description: The person's last name full_name: type: string description: The person's full name (typically first_name + last_name) created_at: type: string format: date-time description: Timestamp when the person was created updated_at: type: string format: date-time description: Timestamp when the person was last updated additionalProperties: false DocumentAttributes: type: object properties: file_name: type: string status: type: string uploaded_at: type: string format: date-time processed_at: type: string format: date-time file_type: type: string size_bytes: type: integer WorkspaceAttributes: type: object properties: name: type: string description: Workspace name desription: type: string description: Workspace description external_workspace_id: type: string format: uuid description: external workspace id avatar_color: type: string format: colors description: Color of the avatar created_at: type: string format: date-time description: Timestamp when the workspace was created updated_at: type: string format: date-time description: Timestamp when the workspace was last updated ````