### Solid API: v2 Getting Started

Source: https://docs.solidfi.com/changelog

Endpoints related to the v2 API's getting started guide, covering introduction, environments, authentication, and idempotency.

```APIDOC
v2/api-reference/getting-started/introduction
```

```APIDOC
v2/api-reference/getting-started/environments
```

```APIDOC
v2/api-reference/getting-started/authentication
```

```APIDOC
v2/api-reference/getting-started/idempotency
```

```APIDOC
v2/api-reference/getting-started/metadata
```

--------------------------------

### Getting Started API Reference

Source: https://docs.solidfi.com/changelog

Documentation for initial API setup and usage guidelines, including introduction, environments, authentication, idempotency, metadata, attachments, errors, rate limiting, and pagination.

```APIDOC
v2/api-reference/getting-started/introduction
v2/api-reference/getting-started/environments
v2/api-reference/getting-started/authentication
v2/api-reference/getting-started/idempotency
v2/api-reference/getting-started/metadata
v2/api-reference/getting-started/attachments
v2/api-reference/getting-started/errors
v2/api-reference/getting-started/rate-limiting
v2/api-reference/getting-started/pagination
v2/api-reference/getting-started/simulation
```

--------------------------------

### SolidFi API: Getting Started

Source: https://docs.solidfi.com/changelog

Guides users through the initial steps of integrating with the SolidFi API, covering essential topics like API introduction, environment setup, authentication methods, idempotency, metadata usage, error handling, rate limiting, pagination, and testing strategies.

```APIDOC
API Reference: Getting Started

Introduction:
  Overview of the SolidFi API and its capabilities.

Environments:
  Details on different API environments (e.g., sandbox, production).

Authentication:
  Methods for authenticating API requests, including API keys or OAuth.

Idempotency:
  Explanation of how to ensure requests are processed exactly once.

Metadata:
  Information on using metadata for tracking and categorization.

Errors:
  Common error codes and their meanings.

Rate Limiting:
  Details on API rate limits and how to manage them.

Pagination:
  Strategies for handling paginated API responses.

Testing:
  Guidelines for testing API integrations.
```

--------------------------------

### SolidFi API: Getting Started (v1)

Source: https://docs.solidfi.com/changelog

API endpoints for getting started with SolidFi v1, including environments, authentication, idempotency, metadata, errors, rate limiting, and pagination.

```APIDOC
SolidFi API Reference - Getting Started (v1):

Environments:
  GET /v1/api-reference/getting-started/environments
  Description: Information about available API environments.

Authentication:
  GET /v1/api-reference/getting-started/authentication
  Description: Details on how to authenticate API requests.

Idempotency:
  GET /v1/api-reference/getting-started/idempotency
  Description: Explanation of idempotency keys for safe request retries.

Metadata:
  GET /v1/api-reference/getting-started/metadata
  Description: Information about metadata handling in API requests.

Errors:
  GET /v1/api-reference/getting-started/errors
  Description: Standard error codes and formats returned by the API.

Rate Limiting:
  GET /v1/api-reference/getting-started/rate-limiting
  Description: Details on API rate limits and how they are enforced.

Pagination:
  GET /v1/api-reference/getting-started/pagination
  Description: How to paginate through large result sets.

Testing:
  GET /v1/api-reference/getting-started/testing
  Description: Guidelines and endpoints for testing API integrations.
```

--------------------------------

### SolidFi API: Getting Started (v2)

Source: https://docs.solidfi.com/changelog

API endpoints for getting started with SolidFi v2, covering environments, authentication, idempotency, metadata, attachments, errors, rate limiting, and simulation.

```APIDOC
SolidFi API Reference - Getting Started (v2):

Introduction:
  GET /v2/api-reference/getting-started/introduction
  Description: An overview of the SolidFi API v2.

Environments:
  GET /v2/api-reference/getting-started/environments
  Description: Information about available API environments for v2.

Authentication:
  GET /v2/api-reference/getting-started/authentication
  Description: Details on how to authenticate API requests for v2.

Idempotency:
  GET /v2/api-reference/getting-started/idempotency
  Description: Explanation of idempotency keys for safe request retries in v2.

Metadata:
  GET /v2/api-reference/getting-started/metadata
  Description: Information about metadata handling in v2 API requests.

Attachments:
  GET /v2/api-reference/getting-started/attachments
  Description: Information regarding attachment handling in v2.

Errors:
  GET /v2/api-reference/getting-started/errors
  Description: Standard error codes and formats returned by the v2 API.

Rate Limiting:
  GET /v2/api-reference/getting-started/rate-limiting
  Description: Details on v2 API rate limits and how they are enforced.

Pagination:
  GET /v2/api-reference/getting-started/pagination
  Description: How to paginate through large result sets in v2.

Simulation:
  GET /v2/api-reference/getting-started/simulation
  Description: Information on simulating API scenarios in v2.
```

--------------------------------

### SolidFi API Getting Started

Source: https://docs.solidfi.com/changelog

General information and guidelines for using the SolidFi API, including authentication methods, idempotency, metadata support, error handling conventions, rate limiting policies, and pagination strategies.

```APIDOC
Authentication:
  Method: API key based (Userless)
  Description: Solid offers API key based (Userless) method of authentication.

Idempotency:
  Description: The Solid Platform supports idempotency.

Metadata:
  Description: The Solid Platform supports metadata to add information to the resource.

Errors:
  Description: Solid uses conventional HTTP response codes to indicate the success or failure.

Rate Limiting:
  Description: Limiting the number of periodic requests received by an API.

Pagination:
  Description: General information on pagination in List All API calls.

Testing:
  Description: Information on functional testing of the Solid platform.
```

--------------------------------

### Getting Started API Reference

Source: https://docs.solidfi.com/changelog

Provides essential information for API integration, including introduction, environments, authentication, idempotency, metadata, error handling, rate limiting, pagination, and testing procedures.

```APIDOC
API Reference - Getting Started:
  - Introduction
  - Environments
  - Authentication
  - Idempotency
  - Metadata
  - Errors
  - Rate Limiting
  - Pagination
  - Testing
```

--------------------------------

### API Reference - Getting Started

Source: https://docs.solidfi.com/changelog

Core API reference documentation covering essential topics for developers.

```APIDOC
APIDOC:
  Group: Getting Started
  Endpoints:
    - v1/api-reference/getting-started/introduction
    - v1/api-reference/getting-started/environments
    - v1/api-reference/getting-started/authentication
    - v1/api-reference/getting-started/idempotency
    - v1/api-reference/getting-started/metadata
    - v1/api-reference/getting-started/errors
    - v1/api-reference/getting-started/rate-limiting
    - v1/api-reference/getting-started/pagination
    - v1/api-reference/getting-started/testing
  Description: Essential guides for developers to understand the SolidFi API, including setup, authentication, error handling, and best practices.
```

--------------------------------

### Getting Started API Reference

Source: https://docs.solidfi.com/changelog

Provides essential information for API integration, including environments, authentication, idempotency, metadata, attachments, error handling, rate limiting, pagination, and simulation capabilities.

```APIDOC
API Reference - Getting Started:

Introduction:
  Overview of the SolidFi API and its capabilities.

Environments:
  Details on available API environments (e.g., sandbox, production).

Authentication:
  Information on how to authenticate API requests, typically using API keys or OAuth.

Idempotency:
  Explanation of how to ensure requests are processed only once using idempotency keys.

Metadata:
  Guidelines for using metadata to tag and organize API resources.

Attachments:
  How to upload and manage attachments related to API resources.

Errors:
  List of possible API error codes, messages, and their meanings.

Rate Limiting:
  Information on API rate limits and how to handle them.

Pagination:
  Details on how to paginate through large lists of resources.

Simulation:
  Endpoints for simulating API requests for testing purposes.
```

--------------------------------

### React JSX Usage Example

Source: https://docs.solidfi.com/changelog

Example of using React's JSX syntax for rendering lists and list items, including nested structures.

```JavaScript
import React from 'react';

const MyComponent = () => {
  return (
    React.jsxs(React.components.ul, {
      children: [
        "\n",
        React.jsxs(React.components.li, {
          children: "Send a Card API now has 'bin' field so both 'credit' and 'debit' cards can be sent. Default is 'debit'"
        }),
        "\n",
        React.jsxs(React.components.li, {
          children: "Now you can Create an Intrabank Contact by accountId (in addition to accountNumber)"
        }),
        "\n",
        React.jsxs(React.components.li, {
          children: "AVAX, FTM, PAXG, AAVE, COMP, XTZ, ALGO, and AXS added to Supported Cryptocurrencies"
        })
      ]
    })
  );
};

export default MyComponent;
```

--------------------------------

### Getting Started Concepts

Source: https://context7_llms

Covers fundamental concepts for interacting with the Solid Platform API, including attachments, authentication, environments, idempotency, metadata, pagination, rate limiting, and simulation.

```APIDOC
Attachments
  Description: Solid Platform supports attachments.
  Purpose: Information on how to handle attachments within the API.

Authentication
  Description: API key based authentication.
  Purpose: Details on how to authenticate API requests using API keys.

Environments
  Description: Sandbox and Prod environments.
  Purpose: Information on available environments for testing and production.

Idempotency
  Description: Solid Platform supports idempotency.
  Purpose: Explanation of how to ensure requests are processed only once.

Metadata
  Description: Solid Platform supports metadata.
  Purpose: Details on using metadata with API resources.

Pagination
  Description: Solid Platform support cursor pagination.
  Purpose: Information on how to paginate through large result sets.

Rate Limiting
  Description: Solid Platform enforces rate limiting.
  Purpose: Understanding API request limits and how they are enforced.

Simulation
  Description: Solid Platform simulates transactions.
  Purpose: Information on how to simulate various transaction types.
```

--------------------------------

### Retrieve Master Account Endpoint

Source: https://docs.solidfi.com/v2/api-reference/master-accounts/retrieve-a-master-account

Details the GET endpoint for retrieving a specific Master Account. It outlines the successful response structure, including account details, timestamps, and attachments, along with an example payload.

```APIDOC
GET /master_accounts/{master_account_id}
  description: Retrieve a Master Account
  responses:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              pending_credits: { type: string, example: '1198.50' }
              pending_debits: { type: string, example: '390.10' }
              account_number: { type: string, example: '9545931209' }
              routing_number: { type: string, example: '123321123' }
              sponsor_bank: { type: string, example: 'Sponsor Bank' }
              currency: { type: string, example: 'usd' }
              external_reference_id: { type: string, example: 'XV-H27LGD-FX' }
              purpose: { type: string, example: 'Payment Ops Master Account' }
              attachments:
                type: array
                items: { $ref: '#/components/schemas/attachment_object' }
              metadata: { $ref: '#/components/schemas/metadata' }
              status: { type: string, example: 'open' }
              timestamps:
                type: object
                properties:
                  created_at: { type: string, example: '2024-04-01T21:00:00Z' }
                  updated_at: { type: string, example: '2024-04-02T21:00:00Z' }
                  closed_at: { type: string, example: '2024-04-03T21:00:00Z' }
        examples:
          master_account_example:
            value:
              pending_credits: '1198.50'
              pending_debits: '390.10'
              account_number: '9545931209'
              routing_number: '123321123'
              sponsor_bank: Sponsor Bank
              currency: usd
              external_reference_id: XV-H27LGD-FX
              purpose: Payment Ops Master Account
              attachments:
                - label: flow of funds doc
                  id: att_a8d2b191fa0e960d8e49a4bfd320e07b
                  created_at: '2024-04-01T21:00:00Z'
              metadata:
                master_account_code: '001'
              status: open
              timestamps:
                created_at: '2024-04-01T21:00:00Z'
                updated_at: '2024-04-02T21:00:00Z'
                closed_at: '2024-04-03T21:00:00Z'
    deprecated: false
    type: path
```

--------------------------------

### Mintlify Documentation Configuration

Source: https://docs.solidfi.com/changelog

Configuration object for Mintlify, specifying theme, project name, colors, favicon, and navigation structure including versioning, tabs, and page groups.

```json
{
  "docsConfig": {
    "$schema": "https://mintlify.com/docs.json",
    "theme": "mint",
    "name": "Solid",
    "colors": {
      "primary": "#16A34A",
      "light": "#FAFAF9",
      "dark": "#0C0A09"
    },
    "favicon": "/favicon.png",
    "navigation": {
      "versions": [
        {
          "version": "v2",
          "tabs": [
            {
              "tab": "Guides",
              "groups": [
                {
                  "group": "General Concepts",
                  "pages": [
                    "general/introduction",
                    "general/account-holders",
                    "general/card-holders",
                    "general/counterparties",
                    "general/transactions",
                    "general/flow-of-funds"
                  ]
                },
                {
                  "group": "Accounts",
                  "pages": [
                    "accounts/introduction",
                    "accounts/master-accounts",
                    "accounts/sub-accounts",
                    "accou"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
```

--------------------------------

### Mintlify Site Configuration

Source: https://docs.solidfi.com/changelog

Configuration object for the Mintlify documentation generator, defining site metadata, theming, navigation structure, and versioning.

```json
{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Solid",
  "logo": "$13:props:docsConfig:logo",
  "favicon": "/favicon.png",
  "modeToggle": {
    "default": "light",
    "isHidden": true
  },
  "versions": [
    "v2",
    "v1"
  ],
  "colors": {
    "primary": "#16A34A",
    "light": "#FAFAF9",
    "dark": "#0C0A09",
    "background": {
      "light": "#FAFAF9",
      "dark": "#0C0A09"
    }
  },
  "topbarCtaButton": {
    "name": "Contact Us",
    "url": "https://www.solidfi.com/contact"
  },
  "navigation": [
    {
      "group": "General Concepts",
      "pages": [
        "general/introduction",
        "general/account-holders",
        "general/card-holders",
        "general/counterparties",
        "general/transactions",
        "general/flow-of-funds"
      ]
    },
    {
      "group": "Accounts",
      "pages": [
        "accounts/introduction",
        "accounts/master-accounts",
        "accounts/sub-accounts",
        "accounts/reconciliation",
        "accounts/controls"
      ]
    },
    {
      "group": "Payments",
      "pages": [
        "payments/introduction",
        "payments/intra-account",
        "payments/ach",
        "payments/wire",
        "payments/check",
        "payments/controls"
      ]
    },
    {
      "group": "Card Issuance",
      "pages": [
        "card-issuance/introduction",
        "card-issuance/physical-card",
        "card-issuance/virtual-card",
        "card-issuance/wallet",
        "card-issuance/atm",
        "card-issuance/controls"
      ]
    },
    {
      "group": "Getting Started",
      "version": "v1",
      "pages": [
        "v1/api-reference/getting-started/introduction",
        "v1/api-reference/getting-started/environments",
        "v1/api-reference/getting-started/authentication",
        "v1/api-reference/getting-started/idempotency",
        "v1/api-reference/getting-started/metadata",
        "v1/api-reference/getting-started/errors",
        "v1/api-reference/getting-started/rate-limiting",
        "v1/api-reference/getting-started/pagination",
        "v1/api-reference/getting-started/testing"
      ]
    },
    {
      "group": "Getting Started",
      "version": "v2",
      "pages": [
        "v2/api-reference/getting-started/introduction",
        "v2/api-reference/getting-started/environments",
        "v2/api-reference/getting-started/authentication",
        "v2/api-reference/getting-started/idempotency",
        "v2/api-reference/getting-started/metadata",
        "v2/api-reference/getting-started/attachments",
        "v2/api-reference/getting-started/errors",
        "v2/api-reference/getting-started/rate-limiting",
        "v2/api-reference/getting-started/pagination",
        "v2/api-reference/getting-started/simulation"
      ]
    },
    {
      "group": "Master Accounts",
      "version": "v2",
      "pages": [
        "v2/api-reference/master-accounts/retrieve-a-master-account"
      ]
    }
  ]
}
```

--------------------------------

### ACH Push Transaction Example

Source: https://docs.solidfi.com/v2/api-reference/transactions/originate-an-ach-push

Provides a detailed example of an ACH push transaction, including all relevant fields for originating a payment. This example showcases the structure of a successful transaction response.

```APIDOC
APIDOC:
  path: '/transaction'
  method: 'POST'
  description: Originate an ACH Push
  responses:
    '200':
      description: Successful ACH Push Transaction
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/transaction'
          examples:
            ach_push_transaction_example:
              value:
                id: 'txn_817d2a074042bb4ec54e08fd82b1e0a8'
                client_id: 'cli_64c6c87ee9d609f36a6f390dc378a4ce'
                master_account_holder_id: 'mah_201e02c581a098a740456c5c19fcfcd6'
                master_account_id: 'mas_743fa071316bc6beaf5dddfd05f49c30'
                sub_account_holder_id: 'sah_5ccfeef0adf0cbe2aa0980d2c9505752'
                sub_account_id: 'sub_bda1e562657c41e553104b10aad3fe70'
                status: 'originated'
                amount: '4570.00'
                currency: 'usd'
                direction: 'debit'
                method: 'ach'
                type: 'push'
                message: 'outgoing'
                description: 'May Salary'
                available_balance: '500.00'
                pending_credits: '0.00'
                pending_debits: '4570.00'
                counterparty:
                  id: 'ctp_8e5541c8a9e50c3af3b0daacf9175130'
                  name: 'John Doe'
                  verification_status: 'pass'
                  account_number: '98324502'
                  routing_number: '121042882'
                  account_type: 'business_checking'
                  bank_name: 'Wells Fargo'
                  beneficiary_bank: null
                  correspondent_bank: null
                  shipping_address: null
                ach:
                  same_day: 'true'
                  effective_date: '2024-04-04'
                  company_discretionary_data: 'DIRECT DEPOSIT'
                  company_entry_description: 'PAYROLL'
                  trace_number: ''
                  return_code: ''
                  rta_id: ''
                parent_transaction_id: ''
                external_reference_id: '123-9088-2'
                purpose: 'This is May Salary'
                ofac:
                  status: 'pass'
                  last_updated_at: '2024-04-01T21:00:00Z'
                attachments: null
                metadata: null
                reconciliation:
                  status: 'not_reconciled'
                  master_account: null
                  sub_account:
                    - id: 'sub_bda1e562657c41e553104b10aad3fe70'
                      transaction_id: 'txn_817d2a074042bb4ec54e08fd82b1e0a8'
                      amount: '4570.00'
                timestamps:
                  created_at: '2024-04-04T11:06:00Z'
                  updated_at: '2024-04-04T11:06:00Z'
                  settled_at: '2024-04-04T11:06:00Z'
```

--------------------------------

### Crypto Wallet Creation and Management APIs

Source: https://docs.solidfi.com/changelog

APIs related to creating and managing cryptocurrency wallets, including support for new cryptocurrencies and retries in test environments.

```APIDOC
API: Create Crypto Wallet
Description: Requires SSN if the person has a US address.

API: Support for new cryptocurrencies
Description: Added support for Solana (SOL), Polkadot (DOT), APE, BCH, MANA, MATIC, SAND, SHIB, UNI, LINK, and XLM.

API: Retry Crypto Wallet Creation
Description: Added a retry mechanism for crypto wallet creation specifically in the Test environment.
```

--------------------------------

### SolidFi API Reference - Program Management

Source: https://docs.solidfi.com/changelog

Endpoints for retrieving and listing various program-related entities such as persons, businesses, accounts, and transactions.

```APIDOC
Endpoint Group: Program

Description: Access and manage program-level data and entities.

Endpoints:
- GET /v1/api-reference/program/retrieve-a-program
  - Retrieves details of a specific program.
- GET /v1/api-reference/program/list-all-stats
  - Lists all program statistics.
- GET /v1/api-reference/program/list-all-persons
  - Lists all persons associated with the program.
- GET /v1/api-reference/program/list-all-businesses
  - Lists all businesses associated with the program.
- GET /v1/api-reference/program/list-all-family
  - Lists all family entities within the program.
- GET /v1/api-reference/program/list-all-members
  - Lists all members within the program.
- GET /v1/api-reference/program/list-all-cards
  - Lists all cards issued under the program.
- GET /v1/api-reference/program/list-all-accounts
  - Lists all accounts managed by the program.
- GET /v1/api-reference/program/list-all-contacts
  - Lists all contacts related to the program.
- GET /v1/api-reference/program/list-all-transactions
  - Lists all transactions within the program.
- GET /v1/api-reference/program/list-all-transfers
  - Lists all transfers made through the program.
- GET /v1/api-reference/program/list-all-carddecline-txn
  - Lists all card decline transactions.
```

--------------------------------

### API Response Examples

Source: https://docs.solidfi.com/v2/api-reference/counterparties/list-all-counterparties

Provides examples of API responses, including successful listing of counterparties and unauthorized error responses. These examples illustrate the structure and content of typical API interactions.

```APIDOC
paths:
  /counterparties:
    get:
      description: List all Counterparties
      responses:
        '200':
          content:
            application/json:
              schemaArray:
                - type: any
              examples:
                list_counterparty_example:
                  value:
                    request_id: req_01900e34c96d7abfa970a9f454ab2d5d
                    client_id: ''
                    method: GET
                    status: 200
                    data:
                      object: list
                      data:
                        - id: cp_018f8613012b7e51b96c6eeeabb6dbe92
                          created_at: '2024-04-01T21:00:00Z'
                          updated_at: '2024-04-01T21:00:00Z'
                      has_more: 'true'
                      starting_after: Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
                      ending_before: Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
        '401':
          content:
            application/json:
              schemaArray:
                - type: any
              examples:
                unauthorized_error_example:
                  value:
                    request_id: req_01900e34c96d7abfa970a9f454ab2d5d
                    client_id: ''
                    method: GET
                    status: 401
                    error:
                      code: ERROR_CODE_UNAUTHORIZED
                      message: unauthorized
                      field_name: ''
                    created_at: '2024-06-12T20:47:38Z'
      deprecated: false
      type: path
```

--------------------------------

### Sell Crypto and Credit Funding Account

Source: https://docs.solidfi.com/changelog

Enables users to sell crypto from their wallet and credit the program's funding account.

```APIDOC
Crypto Functionality:
  Feature: Sell Crypto.
  Process:
    - Users can sell crypto from their wallet.
    - Proceeds are credited to the program's funding account.
```

--------------------------------

### FedNow Transaction Example

Source: https://docs.solidfi.com/v2/api-reference/transactions/originate-a-fednow-push

An example JSON object representing a FedNow transaction, illustrating the structure and data types as defined in the transaction schema.

```APIDOC
fednow_transaction_example:
  value:
    id: txn_817d2a074042bb4ec54e08fd82b1e0a8
    client_id: cli_64c6c87ee9d609f36a6f390dc378a4ce
    master_account_holder_id: mah_201e02c581a098a740456c5c19fcfcd6
    master_account_id: mas_743fa071316bc6beaf5dddfd05f49c30
    sub_account_holder_id: sah_5ccfeef0adf0cbe2aa0980d2c9505752
    sub_account_id: sub_bda1e562657c41e553104b10aad3fe70
    status: originated
    amount: '500.00'
    currency: usd
    direction: debit
    method: fednow
    type: push
    message: outgoing
    description: May office rent
    available_balance: '1900.00'
    pending_credits: '0.00'
    pending_debits: '500.00'
```

--------------------------------

### Transaction Schema and Example

Source: https://docs.solidfi.com/v2/api-reference/transactions/originate-an-intra-account-push

Defines the structure of a transaction object, including its various fields, types, and potential payment methods. Includes an example of an intra-account push transaction.

```APIDOC
Transaction Schema:
  id: string
    description: Unique identifier for the transaction.
    example: txn_817d2a074042bb4ec54e08fd82b1e0a8
  client_id: string
    description: The client ID associated with the transaction.
    example: cli_64c6c87ee9d609f36a6f390dc378a4ce
  master_account_holder_id: string
    description: ID of the master account holder.
    example: mah_201e02c581a098a740456c5c19fcfcd6
  master_account_id: string
    description: ID of the master account.
    example: mas_743fa071316bc6beaf5dddfd05f49c30
  sub_account_holder_id: string
    description: ID of the sub-account holder.
    example: sah_5ccfeef0adf0cbe2aa0980d2c9505752
  sub_account_id: string
    description: ID of the sub-account.
    example: sub_bda1e562657c41e553104b10aad3fe70
  status: string
    description: The current status of the transaction.
    example: settled
    enum: [pending, processing, settled, failed, cancelled]
  amount: string
    description: The transaction amount.
    example: '4570.00'
  currency: string
    description: The currency of the transaction.
    example: usd
  direction: string
    description: Indicates if the transaction is a debit or credit.
    example: debit
    enum: [debit, credit]
  method: string
    description: The payment method used for the transaction.
    example: intra_account
    enum: [deposit, request, auth, adjust, reverse, refund, intra_account, ach, domestic_wire, international_wire, rtp, fednow, check, card]
  type: string
    description: The type of transaction.
    example: push
  message: string
    description: Indicates if the transaction is incoming or outgoing.
    example: outgoing
    enum: [incoming, outgoing]
  description: string
    description: A description of the transaction.
    example: May Salary
  available_balance: string
    description: Available balance in the sub-account after the transaction.
    example: '500.00'
  pending_credits: string
    description: Total pending credits to the sub-account after the transaction.
    example: '0.00'
  pending_debits: string
    description: Total pending debits to the sub-account after the transaction.
    example: '4570.00'
  counterparty: object
    description: Details of the transaction counterparty.
    $ref: '#/components/schemas/transaction_counterparty'
  ach: object
    description: ACH specific details for the transaction.
    $ref: '#/components/schemas/transaction_ach'
  domestic_wire: object
    description: Domestic wire transfer specific details.
    $ref: '#/components/schemas/transaction_domestic_wire'
  international_wire: object
    description: International wire transfer specific details.
    $ref: '#/components/schemas/transaction_international_wire'
  rtp: object
    description: RTP specific details for the transaction.
    $ref: '#/components/schemas/transaction_rtp'
  fednow: object
    description: FedNow specific details for the transaction.
    $ref: '#/components/schemas/transaction_fednow'
  check: object
    description: Check specific details for the transaction.
    $ref: '#/components/schemas/transaction_check'
  card: object
    description: Card specific details for the transaction.
    $ref: '#/components/schemas/transaction_card'
  external_reference_id: string
    description: Unique ID to cross-reference records with external systems.
    example: 123-9088-2
  purpose: string
    description: Purpose of the transaction.
    example: May Invoice
  ofac: object
    description: OFAC compliance details for the transaction.
    $ref: '#/components/schemas/transaction_ofac'
  attachments: array
    description: List of attachments associated with the transaction.
    items:
      $ref: '#/components/schemas/attachment_object'
  metadata: object
    description: Additional metadata for the transaction.
    $ref: '#/components/schemas/metadata'
  reconciliation: object
    description: Reconciliation details for the transaction.
    $ref: '#/components/schemas/transaction_reconciliation'
  timestamps: object
    description: Timestamps related to the transaction lifecycle.
    $ref: '#/components/schemas/transaction_timestamp'

Intra-Account Push Transaction Example:
  id: txn_817d2a074042bb4ec54e08fd82b1e0a8
  client_id: cli_64c6c87ee9d609f36a6f390dc378a4ce
  master_account_holder_id: mah_201e02c581a098a740456c5c19fcfcd6
  master_account_id: mas_743fa071316bc6beaf5dddfd05f49c30
  sub_account_holder_id: sah_5ccfeef0adf0cbe2aa0980d2c9505752
  sub_account_id: sub_bda1e562657c41e553104b10aad3fe70
  status: settled
  amount: '4570.00'
  currency: usd
  direction: debit
  method: intra_account
  type: push
  message: outgoing
  description: May Salary
  available_balance: '500.00'
  pending_credits: '0.00'
  pending_debits: '4570.00'
  counterparty:
    id: ctp_8e5541c8a9e50c3af3b0daacf9175130
    name: John Doe
    verification_status: pass
    account_number: '9542450298324502'
    routing_number: ''
    account_type: ''
```

--------------------------------

### Send a Card API and Cryptocurrencies

Source: https://docs.solidfi.com/changelog

Enhancements to the 'Send a Card' API with a 'bin' field and addition of new supported cryptocurrencies.

```APIDOC
Send a Card API:
  - bin: New field added, allowing both 'credit' and 'debit' cards to be sent. Default is 'debit'.

Supported Cryptocurrencies:
  - Added: AVAX, FTM, PAXG, AAVE, COMP, XTZ, ALGO, AXS.
```

--------------------------------

### Transaction Object Schema and Example

Source: https://docs.solidfi.com/v2/api-reference/transactions/originate-a-domestic-wire

Defines the structure of a transaction object, including all possible fields and their types. Also provides a concrete example of a domestic wire transaction.

```APIDOC
Transaction Object:
  Represents a financial transaction within the SolidFi system.

  Properties:
    id: string
      Unique identifier for the transaction.
      Example: txn_817d2a074042bb4ec54e08fd82b1e0a8
    client_id: string
      Identifier for the client associated with the transaction.
      Example: cli_64c6c87ee9d609f36a6f390dc378a4ce
    master_account_holder_id: string
      Identifier for the master account holder.
      Example: mah_201e02c581a098a740456c5c19fcfcd6
    master_account_id: string
      Identifier for the master account.
      Example: mas_743fa071316bc6beaf5dddfd05f49c30
    sub_account_holder_id: string
      Identifier for the sub-account holder.
      Example: sah_5ccfeef0adf0cbe2aa0980d2c9505752
    sub_account_id: string
      Identifier for the sub-account.
      Example: sub_bda1e562657c41e553104b10aad3fe70
    status: string
      Current status of the transaction (e.g., 'originated').
      Example: originated
    amount: string
      The transaction amount.
      Example: '2500.00'
    currency: string
      The currency of the transaction (e.g., 'usd').
      Example: usd
    direction: string
      Direction of the transaction ('debit' or 'credit').
      Example: debit
    method: string
      The method used for the transaction (e.g., 'domestic_wire').
      Example: domestic_wire
    type: string
      Type of transaction (e.g., 'push').
      Example: push
    message: string
      Indicates if the transaction is 'incoming' or 'outgoing'.
      Enum: [incoming, outgoing]
      Example: outgoing
    description: string
      A description of the transaction.
      Example: Escrow Deposit
    available_balance: string
      The available balance in the sub-account after the transaction.
      Example: '9500.00'
    pending_credits: string
      Total pending credits to the sub-account after the transaction.
      Example: '0.00'
    pending_debits: string
      Total pending debits to the sub-account after the transaction.
      Example: '2500.00'
    counterparty: object
      Details of the transaction counterparty.
      $ref: '#/components/schemas/transaction_counterparty'
    ach: object
      ACH transaction details.
      $ref: '#/components/schemas/transaction_ach'
    domestic_wire: object
      Domestic wire transaction details.
      $ref: '#/components/schemas/transaction_domestic_wire'
    international_wire: object
      International wire transaction details.
      $ref: '#/components/schemas/transaction_international_wire'
    rtp: object
      RTP transaction details.
      $ref: '#/components/schemas/transaction_rtp'
    fednow: object
      FedNow transaction details.
      $ref: '#/components/schemas/transaction_fednow'
    check: object
      Check transaction details.
      $ref: '#/components/schemas/transaction_check'
    card: object
      Card transaction details.
      $ref: '#/components/schemas/transaction_card'
    external_reference_id: string
      Unique ID for cross-referencing with external systems.
      Example: 123-9088-2
    purpose: string
      The purpose of the transaction.
      Example: May Invoice
    ofac: object
      OFAC compliance details.
      $ref: '#/components/schemas/transaction_ofac'
    attachments: array
      List of attachments associated with the transaction.
      items: $ref: '#/components/schemas/attachment_object'
    metadata: object
      Additional metadata for the transaction.
      $ref: '#/components/schemas/metadata'
    reconciliation: object
      Reconciliation details for the transaction.
      $ref: '#/components/schemas/transaction_reconciliation'
    timestamps: object
      Timestamp information for the transaction.
      $ref: '#/components/schemas/transaction_timestamp'

  Example: domestic_wire_transaction_example
    id: txn_817d2a074042bb4ec54e08fd82b1e0a8
    client_id: cli_64c6c87ee9d609f36a6f390dc378a4ce
    master_account_holder_id: mah_201e02c581a098a740456c5c19fcfcd6
    master_account_id: mas_743fa071316bc6beaf5dddfd05f49c30
    sub_account_holder_id: sah_5ccfeef0adf0cbe2aa0980d2c9505752
    sub_account_id: sub_bda1e562657c41e553104b10aad3fe70
    status: originated
    amount: '2500.00'
    currency: usd
    direction: debit
    method: domestic_wire
    type: push
    message: outgoing
    description: Escrow Deposit
    available_balance: '9500.00'
    pending_credits: '0.00'
    pending_debits: '2500.00'
    counterparty:
      id: ctp_8e5541c8a9e50c3af3b0daacf9175130
      name: John Doe
      verification_status: pass
      account_number: '98324502'
      routing_number: '121042882'
```

--------------------------------

### SolidFi API: Counterparties (v2)

Source: https://docs.solidfi.com/changelog

API endpoints for managing Counterparties in SolidFi v2, including listing, creation, retrieval, updates, and retrieving bank information.

```APIDOC
SolidFi API Reference - Counterparties (v2):

List All Counterparties:
  GET /v2/counterparties
  Description: Retrieves a list of all counterparties.
  Returns: An array of counterparty objects.

Create a Counterparty:
  POST /v2/counterparties
  Description: Creates a new counterparty.
  Request Body: Details of the counterparty to create.
  Returns: The newly created counterparty object.

Retrieve a Counterparty:
  GET /v2/counterparties/{counterpartyId}
  Description: Retrieves details for a specific counterparty.
  Parameters:
    - counterpartyId (path): The unique identifier for the counterparty.
  Returns: A single counterparty object.

Update a Counterparty:
  PUT /v2/counterparties/{counterpartyId}
  Description: Updates an existing counterparty.
  Parameters:
    - counterpartyId (path): The unique identifier for the counterparty.
  Request Body: Updated details for the counterparty.
  Returns: The updated counterparty object.

Retrieve Bank Info:
  GET /v2/counterparties/{counterpartyId}/bank-info
  Description: Retrieves bank information associated with a counterparty.
  Parameters:
    - counterpartyId (path): The unique identifier for the counterparty.
  Returns: Bank information for the counterparty.
```