# Shared

## Domain Types

### Customer Details V1

- `CustomerDetailsV1 = object { id, customer_type, email, 2 more }`

  Information about the customer associated with the charge or payout.

  - `id: string`

    Unique identifier for the customer

  - `customer_type: "individual" or "business"`

    The type of customer

    - `"individual"`

    - `"business"`

  - `email: string`

    The customer's email address

  - `name: string`

    The name of the customer

  - `phone: string`

    The customer's phone number in E.164 format

### Device Info V1

- `DeviceInfoV1 = object { ip_address }`

  - `ip_address: string`

    The IP address of the device used when the customer authorized the charge or payout. Use `0.0.0.0` to represent an offline consent interaction.

### Paged Response Metadata

- `PagedResponseMetadata = object { api_request_id, api_request_timestamp, max_page_size, 6 more }`

  Metadata about the API request, including an identifier, timestamp, and pagination details.

  - `api_request_id: string`

    Unique identifier for this API request, useful for troubleshooting.

  - `api_request_timestamp: string`

    Timestamp for this API request, useful for troubleshooting.

  - `max_page_size: number`

    Maximum allowed page size for this endpoint.

  - `page_number: number`

    Page number for paginated results.

  - `page_size: number`

    Number of items per page in this response.

  - `sort_by: string`

    The field that the results were sorted by.

  - `sort_order: "asc" or "desc"`

    - `"asc"`

    - `"desc"`

  - `total_items: number`

    Total number of items returned in this response.

  - `total_pages: number`

    The number of pages available.

### Paykey Details V1

- `PaykeyDetailsV1 = object { id, customer_id, label, balance }`

  - `id: string`

    Unique identifier for the paykey.

  - `customer_id: string`

    Unique identifier for the customer associated with the paykey.

  - `label: string`

    Human-readable label that combines the bank name and masked account number to help easility represent this paykey in a UI

  - `balance: optional number`

    The most recent balance of the bank account associated with the paykey in dollars.

### Response Metadata

- `ResponseMetadata = object { api_request_id, api_request_timestamp }`

  Metadata about the API request, including an identifier and timestamp.

  - `api_request_id: string`

    Unique identifier for this API request, useful for troubleshooting.

  - `api_request_timestamp: string`

    Timestamp for this API request, useful for troubleshooting.

### Status Details V1

- `StatusDetailsV1 = object { changed_at, message, reason, 2 more }`

  - `changed_at: string`

    The time the status change occurred.

  - `message: string`

    A human-readable description of the current status.

  - `reason: "insufficient_funds" or "closed_bank_account" or "invalid_bank_account" or 24 more`

    A machine-readable identifier for the specific status, useful for programmatic handling.

    - `"insufficient_funds"`

    - `"closed_bank_account"`

    - `"invalid_bank_account"`

    - `"invalid_routing"`

    - `"disputed"`

    - `"payment_stopped"`

    - `"owner_deceased"`

    - `"frozen_bank_account"`

    - `"risk_review"`

    - `"fraudulent"`

    - `"duplicate_entry"`

    - `"invalid_paykey"`

    - `"payment_blocked"`

    - `"amount_too_large"`

    - `"too_many_attempts"`

    - `"internal_system_error"`

    - `"user_request"`

    - `"ok"`

    - `"other_network_return"`

    - `"payout_refused"`

    - `"cancel_request"`

    - `"failed_verification"`

    - `"require_review"`

    - `"blocked_by_system"`

    - `"watchtower_review"`

    - `"validating"`

    - `"auto_hold"`

  - `source: "watchtower" or "bank_decline" or "customer_dispute" or 2 more`

    Identifies the origin of the status change (e.g., `bank_decline`, `watchtower`). This helps in tracking the cause of status updates.

    - `"watchtower"`

    - `"bank_decline"`

    - `"customer_dispute"`

    - `"user_action"`

    - `"system"`

  - `code: optional string`

    The status code if applicable.