### GET Surcharge Response Sample (200 OK)

Source: https://docs.accept.blue/index

This snippet illustrates a successful response (200 OK) from the GET /surcharge endpoint. It details the surcharge type and value, along with the detected card type and payment type. This information is useful for understanding applicable surcharges.

```json
{
  "surcharge": {
    "type": "percent",
    "value": 0
  },
  "bin_type": "C",
  "payment_type": "card"
}
```

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

### GET Surcharge Settings Response Sample (200 OK)

Source: https://docs.accept.blue/index

This snippet represents a successful response (200 OK) from the GET /surcharge endpoint when retrieving surcharge settings. It outlines the surcharge configuration for different payment types, such as 'card' and 'check', including their respective types and values.

```json
{
  "card": {
    "type": "percent",
    "value": 0
  },
  "check": {
    "type": "percent",
    "value": 0
  }
}
```

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

### GET Batches Response Sample (200 OK)

Source: https://docs.accept.blue/index

This snippet displays a successful response (200 OK) from the GET /batches endpoint, which returns a paginated list of batches. Each batch object contains details such as its ID, status, sums and counts for charges and credits, and transaction counts.

```json
[
  {
    "id": 1,
    "opened_at": null,
    "auto_close_date": null,
    "closed_at": null,
    "platform": "north",
    "charges_sum": 0.01,
    "charges_count": 1,
    "credits_sum": 0.01,
    "credits_count": 1,
    "transactions_count": 1
  }
]
```

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

### GET /products/{id}

Source: https://docs.accept.blue/index

Retrieves a specific product by its ID.

```APIDOC
## GET /products/{id}

### Description
Returns the requested product by its unique identifier.

### Method
GET

### Endpoint
/api/v2/products/{id}

### Path Parameters
- **id** (integer) - Required - The product ID. Must be >= 1.

### Responses
#### Success Response (200)
- **Product details** (object) - The details of the requested product.

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.
- **404** - The product was not found.

### Response Example (200)
```json
{
  "id": 0,
  "quantity_on_order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "name": "string",
  "manufacturer": "string",
  "model": "string",
  "sku": "string",
  "upc": "string",
  "weight": "string",
  "url": "string",
  "description": "string",
  "price": 0.0001,
  "category_id": 0,
  "enabled_from_date": "2019-08-24",
  "ship_weight": "string",
  "sale_price": 0.0001,
  "quantity_on_hand": 0,
  "min_quantity": 1
}
```
```

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

### GET /products

Source: https://docs.accept.blue/index

Retrieves a list of all products with options for sorting, filtering, and pagination.

```APIDOC
## GET /products

### Description
Returns a list of all products. Supports filtering, sorting, and field selection.

### Method
GET

### Endpoint
/api/v2/products

### Query Parameters
- **order** (string) - Optional - The sort order. Enum: "asc", "desc". Defaults to "asc".
- **limit** (integer) - Optional - The maximum number of results to return. Max: 100. Defaults to 10.
- **offset** (integer) - Optional - The 0-based offset to start from.
- **selected_fields** (Array of strings) - Optional - An array of fields to return. Defaults to all available fields.
- **filter_fields** (Array of strings) - Optional - An array of fields to search, used together with `filter_string`. Defaults to all selected fields.
- **filter_string** (string) - Optional - The string to search for in all fields specified in `filter_fields`.
- **category_id** (Array of integers) - Optional - An array of category ids to filter products by. Defaults to all categories.

### Responses
#### Success Response (200)
- **Product list** (Array of objects) - A list of product objects.

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.

### Response Example (200)
```json
[
  {
    "id": 0,
    "quantity_on_order": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "enabled": true,
    "name": "string",
    "manufacturer": "string",
    "model": "string",
    "sku": "string",
    "upc": "string",
    "weight": "string",
    "url": "string",
    "description": "string",
    "price": 0.0001,
    "category_id": 0,
    "enabled_from_date": "2019-08-24",
    "ship_weight": "string",
    "sale_price": 0.0001,
    "quantity_on_hand": 0,
    "min_quantity": 1
  }
]
```
```

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

### GET /webhooks

Source: https://docs.accept.blue/index

Retrieves a list of all webhooks configured for the account.

```APIDOC
## GET /webhooks

### Description
Retrieves a list of all webhooks configured for the account.

### Method
GET

### Endpoint
/api/v2/webhooks

### Response
#### Success Response (200)
Webhook list was retrieved successfully.

#### Response Example
```json
[
  {
    "id": 0,
    "signature": "string",
    "webhook_url": "string",
    "description": "string",
    "active": true
  }
]
```

#### Error Responses
- **400**: The request was invalid or missing required fields.
- **401**: Credentials are missing or invalid.
```

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

### GET Single Batch Response Sample (200 OK)

Source: https://docs.accept.blue/index

This snippet shows a successful response (200 OK) from the GET /batches/{id} endpoint, which retrieves details for a specific batch. The response includes the batch ID, timestamps for opening and closing, platform information, and aggregated financial data.

```json
{
  "id": 1,
  "opened_at": null,
  "auto_close_date": null,
  "closed_at": null,
  "platform": "north",
  "charges_sum": 0.01,
  "charges_count": 1,
  "credits_sum": 0.01,
  "credits_count": 1,
  "transactions_count": 1
}
```

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

### GET /surcharge

Source: https://docs.accept.blue/index

Retrieves the general surcharge settings configured for the account. This endpoint provides an overview of how surcharges are applied.

```APIDOC
## GET /surcharge

### Description
Retrieves the general surcharge settings configured for the account. This endpoint provides an overview of how surcharges are applied.

### Method
GET

### Endpoint
/api/v2/surcharge

### Response
#### Success Response (200)
- **card** (object) - Surcharge settings for card payments.
  - **type** (string) - The type of surcharge (e.g., "percent").
  - **value** (number) - The value of the surcharge.
- **check** (object) - Surcharge settings for check payments.
  - **type** (string) - The type of surcharge (e.g., "percent").
  - **value** (number) - The value of the surcharge.

#### Response Example
```json
{
  "card": {
    "type": "percent",
    "value": 0
  },
  "check": {
    "type": "percent",
    "value": 0
  }
}
```
```

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

### Get All Categories

Source: https://docs.accept.blue/index

Retrieves a list of all product categories. Supports sorting and pagination.

```APIDOC
## GET /products/categories

### Description
Returns a list of all product categories. You can control the sort order, limit the number of results, and specify an offset for pagination. You can also filter by parent category to retrieve subcategories.

### Method
GET

### Endpoint
`/api/v2/products/categories`

### Parameters
#### Query Parameters
- **order** (string) - Optional - The sort order. Allowed values: "asc", "desc". Defaults to "asc".
- **limit** (integer) - Optional - The maximum number of results to return. Between 1 and 100. Defaults to 10.
- **offset** (integer) - Optional - The 0-based offset to start from for pagination. Defaults to 0.
- **parent_id** (integer) - Optional - For subcategories, set this field to the parent category ID to retrieve its direct children.

### Responses
#### Success Response (200)
- **id** (integer) - The category ID.
- **name** (string) - The name of the category.
- **parent_id** (integer or null) - The ID of the parent category. Null if it's a top-level category.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Electronics",
    "parent_id": null
  },
  {
    "id": 2,
    "name": "Computers",
    "parent_id": 1
  }
]
```

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.
```

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

### Create New Product - API

Source: https://docs.accept.blue/index

Creates a new product in the Accept Blue system. Requires a JSON payload with product details and Basic Authentication. Returns the created product details upon success.

```http
POST https://api.accept.blue/api/v2/products
Content-Type: application/json

{
  "enabled": true,
  "name": "string",
  "manufacturer": "string",
  "model": "string",
  "sku": "string",
  "upc": "string",
  "weight": "string",
  "url": "string",
  "description": "string",
  "price": 0.0001,
  "category_id": 0,
  "enabled_from_date": "2019-08-24",
  "ship_weight": "string",
  "sale_price": 0.0001,
  "quantity_on_hand": 0,
  "min_quantity": 1
}

```

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

### POST /products

Source: https://docs.accept.blue/index

Creates a new product with the provided details.

```APIDOC
## POST /products

### Description
Creates a new product in the system.

### Method
POST

### Endpoint
/api/v2/products

### Request Body
- **price** (number) - Required - The price of the product. Range: [0.0001 .. 20000000].
- **enabled** (boolean) - Optional - If the product is currently enabled. Defaults to true.
- **name** (string) - Required - The name of the product. Max: 255 characters.
- **manufacturer** (string) - Optional - The name of the manufacturer. Length: [1 .. 255] characters.
- **model** (string) - Optional - The model name. Length: [1 .. 255] characters.
- **sku** (string) - Optional - A SKU for the product. Length: [1 .. 255] characters.
- **upc** (string) - Optional - A UPC for the product. Length: [1 .. 255] characters.
- **weight** (string) - Optional - The product's weight. Length: [1 .. 255] characters.
- **url** (string) - Optional - A web url for the product. Length: [1 .. 255] characters.
- **description** (string) - Optional - The product description. Length: [1 .. 255] characters.
- **category_id** (integer) - Optional - The category that this product belongs in.
- **enabled_from_date** (string) - Optional - The date that this product is available. Format: <date>.
- **ship_weight** (string) - Optional - The product's shipping weight. Length: [1 .. 255] characters.
- **sale_price** (number) - Optional - The sale price of the product. Range: [0.0001 .. 20000000].
- **quantity_on_hand** (integer or null) - Optional - How many of this product still remains in stock. Set to `null` for unlimited.
- **min_quantity** (integer) - Optional - Minimum purchase quantity. Defaults to 1.

### Request Example
```json
{
  "enabled": true,
  "name": "string",
  "manufacturer": "string",
  "model": "string",
  "sku": "string",
  "upc": "string",
  "weight": "string",
  "url": "string",
  "description": "string",
  "price": 0.0001,
  "category_id": 0,
  "enabled_from_date": "2019-08-24",
  "ship_weight": "string",
  "sale_price": 0.0001,
  "quantity_on_hand": 0,
  "min_quantity": 1
}
```

### Responses
#### Success Response (201)
- **Product details** (object) - The details of the newly created product.

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.

### Response Example (201)
```json
{
  "id": 0,
  "quantity_on_order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "name": "string",
  "manufacturer": "string",
  "model": "string",
  "sku": "string",
  "upc": "string",
  "weight": "string",
  "url": "string",
  "description": "string",
  "price": 0.0001,
  "category_id": 0,
  "enabled_from_date": "2019-08-24",
  "ship_weight": "string",
  "sale_price": 0.0001,
  "quantity_on_hand": 0,
  "min_quantity": 1
}
```
```

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

### Get Product Response Sample (JSON)

Source: https://docs.accept.blue/index

This is a sample JSON response when retrieving product information. It includes details such as ID, quantity, creation date, name, manufacturer, price, and stock information.

```json
{
  "id": 0,
  "quantity_on_order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "name": "string",
  "manufacturer": "string",
  "model": "string",
  "sku": "string",
  "upc": "string",
  "weight": "string",
  "url": "string",
  "description": "string",
  "price": 0.0001,
  "category_id": 0,
  "enabled_from_date": "2019-08-24",
  "ship_weight": "string",
  "sale_price": 0.0001,
  "quantity_on_hand": 0,
  "min_quantity": 1
}
```

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

### Get Products List - API

Source: https://docs.accept.blue/index

Retrieves a list of all products from the Accept Blue API. Supports filtering, sorting, and pagination via query parameters. Requires Basic Authentication.

```http
GET https://api.accept.blue/api/v2/products?order=asc&limit=10&offset=0&selected_fields=id,name&filter_fields=name&filter_string=example&category_id=1

```

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

### Get Single Webhook

Source: https://docs.accept.blue/index

Retrieves the details of a single webhook by its ID.

```APIDOC
## GET /webhooks/{id}

### Description
Retrieves the details of a single webhook by its ID.

### Method
GET

### Endpoint
/webhooks/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the webhook to retrieve. Must be greater than or equal to 1.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the webhook.
- **signature** (string) - The signature key used to verify webhook requests.
- **webhook_url** (string) - The URL of the webhook.
- **description** (string) - The description of the webhook.
- **active** (boolean) - The active status of the webhook.

#### Response Example
```json
{
  "id": 123,
  "signature": "a1b2c3d4e5f6",
  "webhook_url": "https://example.com/webhook",
  "description": "My test webhook",
  "active": true
}
```

#### Error Responses
- **400**: The request was invalid or missing required fields.
- **401**: Credentials are missing or invalid.
- **404**: The webhook was not found.
```

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

### GET /api/v2/products/categories/{id}

Source: https://docs.accept.blue/index

Retrieves a single product category by its ID.

```APIDOC
## GET /api/v2/products/categories/{id}

### Description
Retrieves a single product category by its ID.

### Method
GET

### Endpoint
https://api.accept.blue/api/v2/products/categories/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The category ID. Must be >= 1.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the category.
- **name** (string) - The name of the category.
- **parent_id** (integer or null) - The parent ID of the category.

#### Response Example
```json
{
  "id": 0,
  "name": "string",
  "parent_id": null
}
```

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.
- **404** - The category was not found.
```

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

### Get Single Product by ID - API

Source: https://docs.accept.blue/index

Retrieves a specific product by its unique ID from the Accept Blue API. Requires Basic Authentication. Returns the product details or a 404 if not found.

```http
GET https://api.accept.blue/api/v2/products/{id}

```

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

### GET /api/v2/transactions/{id}

Source: https://docs.accept.blue/index

Retrieves a single transaction by its unique identifier.

```APIDOC
## GET /api/v2/transactions/{id}

### Description
Retrieves a single transaction using its unique reference number.

### Method
GET

### Endpoint
/api/v2/transactions/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The transaction ID. Must be >= 1.

### Request Example
```
GET /api/v2/transactions/123
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the transaction.
- **created_at** (string) - The timestamp when the transaction was created.
- **settled_date** (string) - The date the transaction was settled.
- **amount_details** (object) - Details about the transaction amount.
- **transaction_details** (object) - Specific details about the transaction.
- **customer** (object) - Information about the customer.
- **status_details** (object) - Details about the transaction status.
- **billing_info** (object) - Billing address information.
- **shipping_info** (object) - Shipping address information.
- **custom_fields** (object) - Custom fields associated with the transaction.
- **card_details** (object) - Details about the card used for the transaction.

#### Response Example
```json
{
  "id": 1,
  "created_at": "2019-08-24T14:15:22Z",
  "settled_date": "2019-08-24",
  "amount_details": {
    "amount": 0.01,
    "tax": 0,
    "tax_percent": 0,
    "surcharge": 0,
    "shipping": 0,
    "tip": 0,
    "discount": 0,
    "subtotal": 0,
    "original_requested_amount": 0.01,
    "original_authorized_amount": 0.01
  },
  "transaction_details": {
    "description": "string",
    "clerk": "string",
    "terminal": "string",
    "client_ip": "string",
    "signature": "string",
    "invoice_number": "string",
    "po_number": "string",
    "order_number": "string",
    "batch_id": 1,
    "source": "string",
    "terminal_name": "string",
    "terminal_id": "string",
    "username": "string",
    "type": "charge",
    "reference_number": 1,
    "schedule_id": 0
  },
  "customer": {
    "identifier": "string",
    "email": "string",
    "fax": "string",
    "customer_id": 1
  },
  "status_details": {
    "error_code": "string",
    "error_message": "string",
    "status": "captured"
  },
  "billing_info": {
    "first_name": "string",
    "last_name": "string",
    "street": "string",
    "street2": "string",
    "state": "string",
    "city": "string",
    "zip": "string",
    "country": "string",
    "phone": "string"
  },
  "shipping_info": {
    "first_name": "string",
    "last_name": "string",
    "street": "string",
    "street2": "string",
    "state": "string",
    "city": "string",
    "zip": "string",
    "country": "string",
    "phone": "string"
  },
  "custom_fields": {
    "custom1": "string",
    "custom2": "string",
    "custom3": "string",
    "custom4": "string",
    "custom5": "string",
    "custom6": "string",
    "custom7": "string",
    "custom8": "string",
    "custom9": "string",
    "custom10": "string",
    "custom11": "string",
    "custom12": "string",
    "custom13": "string",
    "custom14": "string",
    "custom15": "string",
    "custom16": "string",
    "custom17": "string",
    "custom18": "string",
    "custom19": "string",
    "custom20": "string"
  },
  "card_details": {
    "name": "string",
    "last4": "stri",
    "expiry_month": 1,
    "expiry_year": 2020,
    "card_type": "Visa",
    "avs_street": "string",
    "avs_zip": "string",
    "auth_code": "string",
    "bin": "string",
    "bin_details": {
      "type": "C"
    },
    "avs_result": "string",
    "avs_result_code": "YYY",
    "cvv_result": "string",
    "cvv_result_code": "M",
    "cavv_result": "string",
    "cavv_result_code": "string"
  }
}
```
```

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

### Create Webhook

Source: https://docs.accept.blue/index

Creates a new webhook to receive notifications from Accept Blue. You can specify the URL, a description, and whether the webhook should be active.

```APIDOC
## POST /webhooks

### Description
Creates a new webhook to receive notifications from Accept Blue. You can specify the URL, a description, and whether the webhook should be active.

### Method
POST

### Endpoint
/webhooks

### Parameters
#### Request Body
- **webhook_url** (string) - Required - The URL where the webhook will send notifications.
- **description** (string) - Optional - A description for the webhook.
- **active** (boolean) - Optional - Whether the webhook is active. Defaults to true.

### Request Example
```json
{
  "webhook_url": "https://example.com/webhook",
  "description": "My test webhook",
  "active": true
}
```

### Response
#### Success Response (201)
- **id** (integer) - The unique identifier for the created webhook.
- **signature** (string) - The signature key used to verify webhook requests.
- **webhook_url** (string) - The URL of the created webhook.
- **description** (string) - The description of the webhook.
- **active** (boolean) - The active status of the webhook.

#### Response Example
```json
{
  "id": 123,
  "signature": "a1b2c3d4e5f6",
  "webhook_url": "https://example.com/webhook",
  "description": "My test webhook",
  "active": true
}
```
```

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

### GET /api/v2/invoices

Source: https://docs.accept.blue/index

Retrieves a list of invoices with various filtering and sorting options.

```APIDOC
## GET /api/v2/invoices

### Description
Retrieves a list of invoices with various filtering and sorting options.

### Method
GET

### Endpoint
https://api.accept.blue/api/v2/invoices

### Parameters
#### Query Parameters
- **order** (string) - Optional - Default: "asc" - Enum: "asc", "desc" - The sort order.
- **order_by** (string) - Optional - Default: "id" - Enum: "id", "number", "created", "customer", "due", "amount", "status" - The column to order by.
- **limit** (integer) - Optional - Default: 10 - The maximum number of results to return. Must be between 1 and 100.
- **offset** (integer) - Optional - Default: 0 - The 0-based offset to start from. Must be >= 0.
- **selected_fields** (Array of strings) - Optional - An array of fields to return. Defaults to all available fields. Multiple values can be sent, separated by commas.
- **product_id** (integer) - Optional - A product ID to filter by.
- **customer_ids** (Array of integers) - Optional - The customer ID(s) to filter by. Multiple values can be sent, separated by commas.
- **statuses** (Array of strings) - Optional - The invoice status(es) to filter by. Multiple values can be sent, separated by commas. Enum: "canceled", "paid", "partially paid", "sent", "viewed", "authorized", "saved".
- **amount** (number) - Optional - Filter invoices by amount.
- **number** (string) - Optional - Filter invoices by invoice number.
- **due_date** (string) - Optional - Filter invoices by due date. Format: <date>.
- **created_date** (string) - Optional - Filter invoices by created date. Format: <date>. (Note: this is not the invoice date).

### Response
#### Success Response (200)
Invoice list was retrieved successfully. The response structure will contain a list of invoice objects.

#### Error Responses
- **400** - The request was invalid or missing required fields.
- **401** - Credentials are missing or invalid.
- **403** - You do not have permission to access this feature.
```

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

### Create Webhook API Response Sample

Source: https://docs.accept.blue/index

This is a sample JSON response for a successfully created webhook. It includes the webhook's ID, signature, URL, description, and active status.

```json
{
  "id": 0,
  "signature": "string",
  "webhook_url": "string",
  "description": "string",
  "active": true
}
```

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

### Invoice Response Sample (JSON)

Source: https://docs.accept.blue/index

This is a sample JSON response representing a successfully created invoice. It includes details about the invoice, products, customer information, and payment details.

```json
[
  {
    "id": 0,
    "status": "canceled",
    "to_email": "string",
    "sub_total_amount": 0,
    "total_amount": 0,
    "due_amount": 0,
    "paid_amount": 0,
    "tax": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "products": [
      {
        "id": 0,
        "product_id": null,
        "name": "string",
        "description": "string",
        "price": 20000000,
        "quantity": 0,
        "tax": 20000000,
        "surcharge": 0,
        "subtotal": 0
      }
    ],
    "payment_link": "string",
    "customer_id": null,
    "number": null,
    "customer_company": "string",
    "customer_email": "string",
    "billing_info": {
      "first_name": "string",
      "last_name": "string",
      "street": "string",
      "street2": "string",
      "state": "string",
      "city": "string",
      "zip": "string",
      "country": "string",
      "phone": "string"
    },
    "shipping_info": {
      "first_name": "string",
      "last_name": "string",
      "street": "string",
      "street2": "string",
      "state": "string",
      "city": "string",
      "zip": "string",
      "country": "string",
      "phone": "string"
    },
    "date": "2019-08-24",
    "due_date": "2019-08-24",
    "note": "string",
    "discount": {
      "value": 0,
      "type": "percent"
    },
    "requirement": {
      "value": 100,
      "type": "percent"
    },
    "surcharge": {
      "card": {
        "value": 0,
        "type": "percent"
      },
      "ach": {
        "value": 0,
        "type": "percent"
      }
    },
    "terms": "string",
    "action": "charge"
  }
]
```

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

### GET /recurring-schedules/{id}

Source: https://docs.accept.blue/index

Retrieves a specific recurring schedule by its unique ID.

```APIDOC
## GET /recurring-schedules/{id}

### Description
Retrieves a single recurring schedule by its unique ID.

### Method
GET

### Endpoint
/api/v2/recurring-schedules/{id}

### Path Parameters
- **id** (integer) - Required - The unique identifier of the recurring schedule.

### Response
#### Success Response (200)
- **title** (string) - The title of the recurring schedule.
- **frequency** (string) - The frequency of the recurring schedule (e.g., "daily", "monthly").
- **amount** (number) - The amount to be billed.
- **next_run_date** (string) - The next date the schedule will run (YYYY-MM-DD).
- **num_left** (integer) - The number of remaining billing cycles.
- **payment_method_id** (integer) - The ID of the payment method used.
- **active** (boolean) - Indicates if the schedule is active.
- **receipt_email** (string) - The email address to send receipts to.
- **status** (string) - The current status of the schedule.
- **prev_run_date** (string) - The previous run date (YYYY-MM-DD).
- **transaction_count** (integer) - The total number of transactions made.
- **id** (integer) - The unique identifier for the recurring schedule.
- **customer_id** (integer) - The ID of the customer associated with the schedule.
- **created_at** (string) - The timestamp when the schedule was created (ISO 8601 format).

#### Response Example (200)
```json
{
  "title": "string",
  "frequency": "daily",
  "amount": 0.01,
  "next_run_date": "2019-08-24",
  "num_left": 0,
  "payment_method_id": 1,
  "active": true,
  "receipt_email": "string",
  "status": "active",
  "prev_run_date": "2019-08-24",
  "transaction_count": 0,
  "id": 1,
  "customer_id": 1,
  "created_at": "2019-08-24T14:15:22Z"
}
```

#### Error Responses
- **400** Bad Request: The request was invalid or missing required fields.
- **401** Unauthorized: Credentials are missing or invalid.
- **403** Forbidden: You do not have permission to access this feature.
- **404** Not Found: The recurring schedule was not found.
```

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

### GET /api/v2/transactions

Source: https://docs.accept.blue/index

Retrieves a list of transactions with various filtering and pagination options.

```APIDOC
## GET /api/v2/transactions

### Description
Retrieves a list of transactions based on specified query parameters. Supports filtering by date, status, payment type, and pagination.

### Method
GET

### Endpoint
https://api.accept.blue/api/v2/transactions

### Parameters
#### Query Parameters
- **order** (string) - Optional - The sort order. Enum: "asc", "desc". Default: "asc"
- **status** (Array of strings) - Optional - The transaction status(es) to filter by. Multiple values can be sent, separated by commas. Enum: "captured", "pending", "reserve", "originated", "returned", "cancelled", "queued", "declined", "error", "settled", "voided", "approved", "blocked", "expired"
- **payment_type** (Array of strings) - Optional - The transaction payment type(s) to filter by. Multiple values can be sent, separated by commas. Enum: "credit_card", "check"
- **settled_date** (string) - Optional - The settled date in UTC to filter for. This will exclude transactions processed more than 30 days before the specified settlement date.
- **date_field** (string) - Optional - The date event to filter by. Enum: "settled_at", "created_at". Default: "created_at"
- **date_from** (integer or string) - Optional - The earliest date to search. This will be rounded down to the beginning of the day in UTC.
- **date_to** (integer or string) - Optional - The latest date to search. This will be rounded up to the end of the day in UTC.
- **limit** (integer) - Optional - The maximum number of results to return. Range: 1 to 100. Default: 10
- **offset** (integer) - Optional - The 0-based offset to start from. Must be >= 0.
- **key** (string) - Optional - The transaction key to filter by.

### Request Example
```
GET /api/v2/transactions?status=captured&payment_type=credit_card&limit=20
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the transaction.
- **created_at** (string) - The timestamp when the transaction was created.
- **settled_date** (string) - The date the transaction was settled.
- **amount_details** (object) - Details about the transaction amount.
- **transaction_details** (object) - Specific details about the transaction.
- **customer** (object) - Information about the customer.
- **status_details** (object) - Details about the transaction status.
- **billing_info** (object) - Billing address information.
- **shipping_info** (object) - Shipping address information.
- **custom_fields** (object) - Custom fields associated with the transaction.
- **card_details** (object) - Details about the card used for the transaction.

#### Response Example
```json
[
  {
    "id": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "settled_date": "2019-08-24",
    "amount_details": {
      "amount": 0.01,
      "tax": 0,
      "tax_percent": 0,
      "surcharge": 0,
      "shipping": 0,
      "tip": 0,
      "discount": 0,
      "subtotal": 0,
      "original_requested_amount": 0.01,
      "original_authorized_amount": 0.01
    },
    "transaction_details": {
      "description": "string",
      "clerk": "string",
      "terminal": "string",
      "client_ip": "string",
      "signature": "string",
      "invoice_number": "string",
      "po_number": "string",
      "order_number": "string",
      "batch_id": 1,
      "source": "string",
      "terminal_name": "string",
      "terminal_id": "string",
      "username": "string",
      "type": "charge",
      "reference_number": 1,
      "schedule_id": 0
    },
    "customer": {
      "identifier": "string",
      "email": "string",
      "fax": "string",
      "customer_id": 1
    },
    "status_details": {
      "error_code": "string",
      "error_message": "string",
      "status": "captured"
    },
    "billing_info": {
      "first_name": "string",
      "last_name": "string",
      "street": "string",
      "street2": "string",
      "state": "string",
      "city": "string",
      "zip": "string",
      "country": "string",
      "phone": "string"
    },
    "shipping_info": {
      "first_name": "string",
      "last_name": "string",
      "street": "string",
      "street2": "string",
      "state": "string",
      "city": "string",
      "zip": "string",
      "country": "string",
      "phone": "string"
    },
    "custom_fields": {
      "custom1": "string",
      "custom2": "string",
      "custom3": "string",
      "custom4": "string",
      "custom5": "string",
      "custom6": "string",
      "custom7": "string",
      "custom8": "string",
      "custom9": "string",
      "custom10": "string",
      "custom11": "string",
      "custom12": "string",
      "custom13": "string",
      "custom14": "string",
      "custom15": "string",
      "custom16": "string",
      "custom17": "string",
      "custom18": "string",
      "custom19": "string",
      "custom20": "string"
    },
    "card_details": {
      "name": "string",
      "last4": "stri",
      "expiry_month": 1,
      "expiry_year": 2020,
      "card_type": "Visa",
      "avs_street": "string",
      "avs_zip": "string",
      "auth_code": "string",
      "bin": "string",
      "bin_details": {
        "type": "C"
      },
      "avs_result": "string",
      "avs_result_code": "YYY",
      "cvv_result": "string",
      "cvv_result_code": "M",
      "cavv_result": "string",
      "cavv_result_code": "string"
    }
  }
]
```

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

### Get Payment Method Response Sample

Source: https://docs.accept.blue/index

This is a sample JSON response for retrieving a payment method. It includes details such as customer ID, creation timestamp, billing information, card type, and masked card number.

```json
{
  "id": 1,
  "customer_id": 1,
  "created_at": "2019-08-24T14:15:22Z",
  "avs_address": "string",
  "avs_zip": "string",
  "name": "string",
  "expiry_month": 1,
  "expiry_year": 2020,
  "payment_method_type": "card",
  "card_type": "Visa",
  "bin": "string",
  "bin_details": {
    "type": "C"
  },
  "last4": "stri"
}
```