> ## 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 Payment Mean > Update an existing payment method or account for financial transactions. This endpoint supports partial updates to payment means including bank accounts (IBAN/SWIFT), credit/debit cards, digital wallets, and other payment instruments. ## OpenAPI ````yaml PATCH /v1/payment-means/{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/payment-means/{id}: patch: tags: - Payment Means summary: Update an existing payment means description: >- Update an existing payment method or account for financial transactions. This endpoint supports partial updates to payment means including bank accounts (IBAN/SWIFT), credit/debit cards, digital wallets, and other payment instruments. operationId: updatePaymentMeans parameters: - $ref: '#/components/parameters/AuthorizationHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PaymentMeansPatch' examples: bank_account_sepa: summary: SEPA Bank Account value: type: payment_means attributes: type: account_details scheme: SEPA status: active account_details: iban: FR7612345678901234567890123 bic: BNPAFRPP currency: EUR bank_details: bank_name: BNP Paribas bank_code: BNPA branch_name: Paris Central branch_code: '001' nickname: Main Business Account description: Primary operating account for SEPA payments tags: - business - primary - eur is_primary: true relationships: holder: data: type: company id: 550e8400-e29b-41d4-a716-446655440000 account_location: data: type: location id: 550e8400-e29b-41d4-a716-446655440001 holder_location: data: type: location id: 550e8400-e29b-41d4-a716-446655440002 credit_card: summary: Credit Card value: data: type: payment_means attributes: type: card_details scheme: VISA status: active card_details: masked_pan: '****-****-****-1234' brand: visa card_type: credit expiry_month: 12 expiry_year: 2027 cardholder_name: John Doe nickname: Corporate Credit Card description: Main corporate card for business expenses tags: - corporate - expenses is_primary: false relationships: holder: data: type: people id: 550e8400-e29b-41d4-a716-446655440003 holder_location: data: type: location id: 550e8400-e29b-41d4-a716-446655440004 digital_wallet: summary: Digital Wallet (PayPal) value: data: type: payment_means attributes: type: wallet_details scheme: PAYPAL status: active digital_wallet: provider: paypal wallet_id: user@example.com wallet_type: business nickname: Business PayPal description: PayPal account for online payments tags: - online - paypal is_primary: false relationships: holder: data: type: company id: 550e8400-e29b-41d4-a716-446655440005 us_bank_account: summary: US Bank Account (ACH) - Complete Example value: data: type: payment_means attributes: type: account_details scheme: ACH status: active account_details: account_number: '1234567890' routing_number: '021000021' account_type: checking currency: USD bank_details: bank_name: JPMorgan Chase Bank, N.A. bank_code: CHASUS33 branch_name: New York Main Branch branch_code: NY001 compliance: kyc_status: verified aml_status: cleared nickname: US Operating Account description: Primary USD account for US operations tags: - usd - operating - us - primary relationships: holder: data: type: company id: holder-company-1 account_location: data: type: location id: bank-location-1 holder_location: data: type: location id: holder-location-1 bank: data: type: company id: bank-company-1 intermediary_banks: data: - type: company id: intermediary-bank-1 ultimate_beneficiary: data: type: people id: beneficiary-person-1 created_by: data: type: people id: creator-person-1 documents: data: - type: document id: bank-statement-1 - type: document id: verification-letter-1 transactions: data: - type: transaction id: recent-transaction-1 linked_payment_means: data: - type: payment_means id: corporate-card-1 included: - type: company id: holder-company-1 attributes: name: ACME Corporation description: Technology solutions provider registration: registered_name: ACME Corporation Inc. trade_name: ACME tax_id: value: 12-3456789 type: EIN - type: location id: bank-location-1 attributes: street: 270 Park Avenue city: New York state: NY postal_code: '10017' country: US is_primary: true - type: location id: holder-location-1 attributes: street: 123 Business Avenue city: New York state: NY postal_code: '10001' country: US is_primary: true - type: company id: bank-company-1 attributes: name: JPMorgan Chase Bank description: Major US financial institution registration: registered_name: JPMorgan Chase Bank, N.A. tax_id: value: 13-2624428 type: EIN - type: company id: intermediary-bank-1 attributes: name: Wells Fargo Bank description: Intermediary bank for routing registration: registered_name: Wells Fargo Bank, N.A. - type: people id: beneficiary-person-1 attributes: first_name: Jane last_name: Doe full_name: Jane Doe date_of_birth: '1980-05-15' - type: people id: creator-person-1 attributes: first_name: John last_name: Smith full_name: John Smith - type: document id: bank-statement-1 attributes: name: Bank Statement January 2025.pdf file_size: 245678 content_type: application/pdf - type: document id: verification-letter-1 attributes: name: Account Verification Letter.pdf file_size: 123456 content_type: application/pdf - type: transaction id: recent-transaction-1 attributes: amount: value: 5000 currency: USD description: Monthly supplier payment transaction_date: '2025-01-15T00:00:00.000Z' status: completed - type: payment_means id: corporate-card-1 attributes: type: card scheme: visa status: active card_details: last_four: '1234' expiry_month: 12 expiry_year: 2026 cardholder_name: ACME CORPORATION nickname: Corporate Visa Card responses: '201': description: Payment means created successfully content: application/json: schema: $ref: '#/components/schemas/PaymentMeansPostResponse' example: data: type: payment_means id: pm-550e8400-e29b-41d4-a716-446655440099 attributes: type: account_details scheme: ACH status: active account_details: account_number: '1234567890' routing_number: '021000021' account_type: checking currency: USD bank_details: bank_name: JPMorgan Chase Bank, N.A. bank_code: CHASUS33 branch_name: New York Main Branch branch_code: NY001 compliance: kyc_status: verified aml_status: cleared sanctions_check: passed last_compliance_check: '2025-01-15T10:00:00.000Z' metadata: source: api external_id: null last_used_at: null usage_count: 0 nickname: US Operating Account description: Primary USD account for US operations tags: - usd - operating - us - primary is_primary: true is_verified: true created_at: '2025-01-15T10:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' relationships: holder: data: type: company id: 550e8400-e29b-41d4-a716-446655440001 account_location: data: type: location id: 550e8400-e29b-41d4-a716-446655440101 holder_location: data: type: location id: 550e8400-e29b-41d4-a716-446655440102 bank: data: type: company id: 550e8400-e29b-41d4-a716-446655440103 intermediary_banks: data: - type: company id: 550e8400-e29b-41d4-a716-446655440104 ultimate_beneficiary: data: type: people id: 550e8400-e29b-41d4-a716-446655440201 created_by: data: type: people id: 550e8400-e29b-41d4-a716-446655440202 documents: data: - type: document id: 550e8400-e29b-41d4-a716-446655440301 - type: document id: 550e8400-e29b-41d4-a716-446655440302 transactions: data: - type: transaction id: 550e8400-e29b-41d4-a716-446655440401 linked_payment_means: data: - type: payment_means id: 550e8400-e29b-41d4-a716-446655440501 included: - type: company id: 550e8400-e29b-41d4-a716-446655440001 attributes: name: ACME Corporation description: Technology solutions provider registration: registered_name: ACME Corporation Inc. trade_name: ACME tax_id: value: 12-3456789 type: EIN created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: location id: 550e8400-e29b-41d4-a716-446655440101 attributes: street: 270 Park Avenue city: New York state: NY postal_code: '10017' country: US is_primary: true created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: location id: 550e8400-e29b-41d4-a716-446655440102 attributes: street: 123 Business Avenue city: New York state: NY postal_code: '10001' country: US is_primary: true created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: company id: 550e8400-e29b-41d4-a716-446655440103 attributes: name: JPMorgan Chase Bank description: Major US financial institution registration: registered_name: JPMorgan Chase Bank, N.A. tax_id: value: 13-2624428 type: EIN created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: company id: 550e8400-e29b-41d4-a716-446655440104 attributes: name: Wells Fargo Bank description: Intermediary bank for routing registration: registered_name: Wells Fargo Bank, N.A. created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: people id: 550e8400-e29b-41d4-a716-446655440201 attributes: first_name: Jane last_name: Doe full_name: Jane Doe date_of_birth: '1980-05-15' created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: people id: 550e8400-e29b-41d4-a716-446655440202 attributes: first_name: John last_name: Smith full_name: John Smith created_at: '2024-01-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' - type: document id: 550e8400-e29b-41d4-a716-446655440301 attributes: name: Bank Statement January 2025.pdf file_size: 245678 content_type: application/pdf created_at: '2025-01-15T09:00:00.000Z' updated_at: '2025-01-15T09:00:00.000Z' - type: document id: 550e8400-e29b-41d4-a716-446655440302 attributes: name: Account Verification Letter.pdf file_size: 123456 content_type: application/pdf created_at: '2025-01-15T09:30:00.000Z' updated_at: '2025-01-15T09:30:00.000Z' - type: transaction id: 550e8400-e29b-41d4-a716-446655440401 attributes: amount: value: 5000 currency: USD description: Monthly supplier payment transaction_date: '2025-01-15T00:00:00.000Z' status: completed created_at: '2025-01-15T08:00:00.000Z' updated_at: '2025-01-15T08:30:00.000Z' - type: payment_means id: 550e8400-e29b-41d4-a716-446655440501 attributes: type: card scheme: visa status: active card_details: last_four: '1234' expiry_month: 12 expiry_year: 2026 cardholder_name: ACME CORPORATION nickname: Corporate Visa Card is_primary: false created_at: '2024-06-01T00:00:00.000Z' updated_at: '2025-01-15T10:00:00.000Z' '400': description: Bad request - invalid payment means data content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '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: Not found - related entity does not exist content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errors: - id: holder_not_found status: '404' code: HOLDER_NOT_FOUND title: Holder Not Found detail: The specified holder company or person does not exist source: pointer: /data/relationships/holder/data/id components: parameters: AuthorizationHeader: name: Authorization in: header required: true schema: type: string description: Bearer token for authentication schemas: PaymentMeansPatch: type: object properties: data: type: object properties: type: type: string const: payment_means attributes: type: object 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 relationships: $ref: '#/components/schemas/PaymentMeansRelationsShipPost' included: $ref: '#/components/schemas/PaymentMeansCreateImcluded' PaymentMeansPostResponse: type: object properties: data: type: object properties: type: type: string const: payment_means id: type: string format: uuid attributes: $ref: '#/components/schemas/PaymentMeansAttributes' relationships: type: object properties: holder: type: object description: Account/payment method owner properties: data: type: object properties: type: type: string enum: - company - people id: type: string format: uuid account_location: type: object description: Bank branch or account location properties: data: type: object properties: type: type: string const: location id: type: string format: uuid holder_location: type: object description: Account holder's address properties: data: type: object properties: type: type: string const: location id: type: string format: uuid bank: type: object description: Banking institution properties: data: type: object properties: type: type: string const: company id: type: string format: uuid intermediary_banks: type: object description: Correspondent/intermediary banks for routing properties: data: type: array items: type: object properties: type: type: string const: company id: type: string format: uuid ultimate_beneficiary: type: object description: Ultimate beneficial owner if different from holder properties: data: type: object properties: type: type: string enum: - company - people id: type: string format: uuid created_by: type: object description: User who created this record properties: data: type: object properties: type: type: string const: people id: type: string format: uuid documents: type: object description: Supporting documents (statements, verifications) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid transactions: type: object description: Related transactions using this payment means properties: data: type: array items: type: object properties: type: type: string const: transaction id: type: string format: uuid linked_payment_means: type: object description: Related payment methods (e.g., cards linked to account) properties: data: type: array items: type: object properties: type: type: string const: payment_means id: type: string format: uuid included: type: object properties: holder: type: object oneOf: - type: object description: Account/payment method owner (required) properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: UUID of the person attributes: $ref: '#/components/schemas/PeopleAttributes' - type: object description: Account/payment method owner (required) properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: UUID of the parent company attributes: $ref: '#/components/schemas/CompanyAttributes' account_location: type: object description: Locations/addresses associated of the account properties: data: type: array items: type: object properties: type: type: string const: location id: type: string format: uuid description: ID of the location attributes: $ref: '#/components/schemas/LocationAttributes' holder_location: type: object description: Locations/addresses associated of the holder properties: data: type: array items: type: object properties: type: type: string const: location id: type: string format: uuid description: ID of the location attributes: $ref: '#/components/schemas/LocationAttributes' bank: type: object description: bank properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: UUID of the parent company attributes: $ref: '#/components/schemas/CompanyAttributes' intermediary_banks: type: object description: Correspondent/intermediary banks for routing (optional) properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: UUID of the parent company attributes: $ref: '#/components/schemas/CompanyAttributes' ultimate_beneficiary: type: object oneOf: - type: object description: >- Ultimate beneficial owner if different from holder (optional) properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: UUID of the person attributes: $ref: '#/components/schemas/PeopleAttributes' - type: object description: Parent company of this company properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: UUID of the parent company attributes: $ref: '#/components/schemas/CompanyAttributes' created_by: type: object description: Person who created this company properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: UUID of the person attributes: $ref: '#/components/schemas/PeopleAttributes' documents: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: UUID of the document attributes: $ref: '#/components/schemas/DocumentAttributes' transaction: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: UUID of the document attributes: $ref: '#/components/schemas/TransactionAttributes' linked_payment_means: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: UUID of the document attributes: $ref: '#/components/schemas/PaymentMeansAttributes' 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 PaymentMeansRelationsShipPost: type: object properties: holder: type: object description: Account/payment method owner (required) properties: data: type: object properties: type: type: string enum: - company - people id: type: string description: >- UUID of an existing company or person, or temp-id that references an entity defined in the included array account_location: type: object description: Bank branch or account location (optional) properties: data: type: object properties: type: type: string const: location id: type: string format: uuid description: >- UUID of an existing location or temp-id that references a location defined in the included array holder_location: type: object description: Account holder's address (optional) properties: data: type: object properties: type: type: string const: location id: type: string format: uuid description: >- UUID of an existing location or temp-id that references a location defined in the included array bank: type: object description: Banking institution (optional) properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: >- UUID of an existing company or temp-id that references a company defined in the included array intermediary_banks: type: object description: Correspondent/intermediary banks for routing (optional) properties: data: type: array items: type: object properties: type: type: string const: company id: type: string format: uuid description: >- UUID of an existing company or temp-id that references a company defined in the included array ultimate_beneficiary: type: object description: Ultimate beneficial owner if different from holder (optional) properties: data: type: object properties: type: type: string enum: - company - people 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 created_by: type: object description: User who created this record (optional) 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 documents: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: >- UUID of an existing document or temp-id that references a document defined in the included array transactions: type: object description: Related transactions using this payment means (optional) properties: data: type: array items: type: object properties: type: type: string const: transaction id: type: string format: uuid description: >- UUID of an existing transaction or temp-id that references a transaction defined in the included array linked_payment_means: type: object description: Related payment methods (e.g., cards linked to account) (optional) properties: data: type: array items: 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 PaymentMeansCreateImcluded: type: object properties: holder: type: object oneOf: - type: object description: Account/payment method owner (required) properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: >- Temp-id that references a holder defined in the included array attributes: $ref: '#/components/schemas/PeopleCreateAttributes' required: - type - id - attributes - type: object description: Account/payment method owner (required) properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: >- Temp-id that references a holder defined in the included array attributes: $ref: '#/components/schemas/CompanyCreateAttributes' required: - type - id - attributes account_location: type: object description: Locations/addresses associated of the account properties: data: type: array items: type: object properties: type: type: string const: location id: type: string format: uuid description: >- Temp-id that references a account location defined in the included array attributes: $ref: '#/components/schemas/LocationCreateAttributes' required: - type - id - attributes holder_location: type: object description: Locations/addresses associated of the holder properties: data: type: array items: type: object properties: type: type: string const: location id: type: string format: uuid description: >- Temp-id that references a holder location defined in the included array attributes: $ref: '#/components/schemas/LocationCreateAttributes' required: - type - id - attributes bank: type: object description: bank properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: Temp-id that references a bank defined in the included array attributes: $ref: '#/components/schemas/CompanyCreateAttributes' required: - type - id - attributes intermediary_banks: type: object description: Correspondent/intermediary banks for routing (optional) properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: >- Temp-id that references a intermediary bank defined in the included array attributes: $ref: '#/components/schemas/CompanyCreateAttributes' required: - type - id - attributes ultimate_beneficiary: type: object oneOf: - type: object description: Ultimate beneficial owner if different from holder (optional) properties: data: type: object properties: type: type: string const: people id: type: string format: uuid description: >- Temp-id that references a ultimate beneficiary defined in the included array attributes: $ref: '#/components/schemas/PeopleCreateAttributes' required: - type - id - attributes - type: object description: Parent company of this company properties: data: type: object properties: type: type: string const: company id: type: string format: uuid description: >- Temp-id that references a ultimate beneficiary defined in the included array attributes: $ref: '#/components/schemas/CompanyCreateAttributes' required: - type - id - attributes documents: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: >- Temp-id that references a document defined in the included array attributes: $ref: '#/components/schemas/DocumentCreateAttributes' required: - type - id - attributes transaction: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: >- Temp-id that references a transaction defined in the included array attributes: $ref: '#/components/schemas/TransactionAttributesPost' required: - type - id - attributes linked_payment_means: type: object description: Supporting documents (statements, verifications) (optional) properties: data: type: array items: type: object properties: type: type: string const: document id: type: string format: uuid description: >- Temp-id that references the linked payment means defined in the included array attributes: $ref: '#/components/schemas/PaymentMeansCreateAttributes' required: - type - id - attributes 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 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 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 LocationAttributes: type: object properties: full_address: type: string description: Complete formatted address address_line1: type: string description: Primary address line address_line2: type: string description: Secondary address line city: type: string description: City name region: type: string description: State, province, or region postal_code: type: string description: Postal or ZIP code country: type: string description: Two-letter ISO country code latitude: type: number format: float description: Geographic latitude coordinate longitude: type: number format: float description: Geographic longitude coordinate is_primary: type: boolean description: Whether this is the primary location is_registered: type: boolean description: Whether this is a registered business address label: type: string description: Custom label for the location created_at: type: string format: date-time description: Date and time when the location was created updated_at: type: string format: date-time description: Date and time when the location was last updated 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 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 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 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 LocationCreateAttributes: type: object properties: address_line1: type: string description: Primary address line address_line2: type: string description: Secondary address line (optional) city: type: string description: City name region: type: string description: State, province, or region postal_code: type: string description: Postal or ZIP code country: type: string description: Two-letter ISO country code (e.g., 'US', 'GB') latitude: type: number format: float description: Geographic latitude coordinate longitude: type: number format: float description: Geographic longitude coordinate is_primary: type: boolean description: Whether this is the primary location default: false is_registered: type: boolean description: Whether this is a registered business address default: false label: type: string enum: - work - personal - other - ... description: >- Email label type. See [all available labels](/enums/label) for complete list. required: - address_line1 - country DocumentCreateAttributes: type: object properties: file_name: type: string status: type: string file_type: type: string size_bytes: type: integer TransactionAttributesPost: type: object properties: scheme: type: string enum: - sepa - swift - ach - ... description: >- Payment scheme used. See [payment schemes documentation](/enums/scheme-type) for complete list. 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 required: - currency - amount 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 enum: - provider - market - custom 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 - ... description: >- Type of transaction. See [transaction types documentation](/enums/transaction) for complete list. status: type: string enum: - pending - completed - failed - ... description: >- Current status of the transaction. See [transaction status documentation](/enums/details-banking-transaction-status) for complete list. 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 - ... 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 required: - type - amount - currency required: - instructed_amount - scheme - executed_at 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 ````