> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# paystack-commerce

> Paystack Commerce - products, pages, orders, storefronts, and terminals

**Server path:** `/paystack-commerce` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                  | Description                                |
| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`paystack_commerce_order_create`](#paystack_commerce_order_create)                                                   | Create Order                               |
| [`paystack_commerce_order_fetch`](#paystack_commerce_order_fetch)                                                     | Fetch Order                                |
| [`paystack_commerce_order_list`](#paystack_commerce_order_list)                                                       | List Orders                                |
| [`paystack_commerce_order_product`](#paystack_commerce_order_product)                                                 | Fetch Product Orders                       |
| [`paystack_commerce_order_validate`](#paystack_commerce_order_validate)                                               | Validate Order                             |
| [`paystack_commerce_page_add_products`](#paystack_commerce_page_add_products)                                         | Add Products                               |
| [`paystack_commerce_page_check_slug_availability`](#paystack_commerce_page_check_slug_availability)                   | Check Slug Availability                    |
| [`paystack_commerce_page_create`](#paystack_commerce_page_create)                                                     | Create Page                                |
| [`paystack_commerce_page_fetch`](#paystack_commerce_page_fetch)                                                       | Fetch Page                                 |
| [`paystack_commerce_page_list`](#paystack_commerce_page_list)                                                         | List Pages                                 |
| [`paystack_commerce_page_update`](#paystack_commerce_page_update)                                                     | Update Page                                |
| [`paystack_commerce_product_create`](#paystack_commerce_product_create)                                               | Create Product                             |
| [`paystack_commerce_product_delete`](#paystack_commerce_product_delete)                                               | Delete Product                             |
| [`paystack_commerce_product_fetch`](#paystack_commerce_product_fetch)                                                 | Fetch Product                              |
| [`paystack_commerce_product_list`](#paystack_commerce_product_list)                                                   | List Products                              |
| [`paystack_commerce_product_update`](#paystack_commerce_product_update)                                               | Update product                             |
| [`paystack_commerce_storefront_add_products`](#paystack_commerce_storefront_add_products)                             | Add Products to Storefront                 |
| [`paystack_commerce_storefront_create`](#paystack_commerce_storefront_create)                                         | Create Storefront                          |
| [`paystack_commerce_storefront_delete`](#paystack_commerce_storefront_delete)                                         | Delete Storefront                          |
| [`paystack_commerce_storefront_duplicate`](#paystack_commerce_storefront_duplicate)                                   | Duplicate Storefront                       |
| [`paystack_commerce_storefront_fetch`](#paystack_commerce_storefront_fetch)                                           | Fetch Storefront                           |
| [`paystack_commerce_storefront_fetch_orders`](#paystack_commerce_storefront_fetch_orders)                             | Fetch Storefront Orders                    |
| [`paystack_commerce_storefront_list`](#paystack_commerce_storefront_list)                                             | List Storefronts                           |
| [`paystack_commerce_storefront_list_products`](#paystack_commerce_storefront_list_products)                           | List Storefront Products                   |
| [`paystack_commerce_storefront_publish`](#paystack_commerce_storefront_publish)                                       | Publish Storefront                         |
| [`paystack_commerce_storefront_update`](#paystack_commerce_storefront_update)                                         | Update Storefront                          |
| [`paystack_commerce_storefront_verify_slug`](#paystack_commerce_storefront_verify_slug)                               | Verify Storefront Slug                     |
| [`paystack_commerce_terminal_commission`](#paystack_commerce_terminal_commission)                                     | Commission Terminal                        |
| [`paystack_commerce_terminal_decommission`](#paystack_commerce_terminal_decommission)                                 | Decommission Terminal                      |
| [`paystack_commerce_terminal_fetch`](#paystack_commerce_terminal_fetch)                                               | Fetch Terminal                             |
| [`paystack_commerce_terminal_fetch_event_status`](#paystack_commerce_terminal_fetch_event_status)                     | Fetch Event Status                         |
| [`paystack_commerce_terminal_fetch_terminal_status`](#paystack_commerce_terminal_fetch_terminal_status)               | Fetch Terminal Status                      |
| [`paystack_commerce_terminal_list`](#paystack_commerce_terminal_list)                                                 | List Terminals                             |
| [`paystack_commerce_terminal_send_event`](#paystack_commerce_terminal_send_event)                                     | Send Event                                 |
| [`paystack_commerce_terminal_update`](#paystack_commerce_terminal_update)                                             | Update Terminal                            |
| [`paystack_commerce_virtual_terminal_add_split_code`](#paystack_commerce_virtual_terminal_add_split_code)             | Add Split Code to Virtual Terminal         |
| [`paystack_commerce_virtual_terminal_create`](#paystack_commerce_virtual_terminal_create)                             | Create Virtual Terminal                    |
| [`paystack_commerce_virtual_terminal_deactivate`](#paystack_commerce_virtual_terminal_deactivate)                     | Deactivate Virtual Terminal                |
| [`paystack_commerce_virtual_terminal_delete_split_code`](#paystack_commerce_virtual_terminal_delete_split_code)       | Remove Split Code from Virtual Terminal    |
| [`paystack_commerce_virtual_terminal_destination_assign`](#paystack_commerce_virtual_terminal_destination_assign)     | Assign Destination to Virtual Terminal     |
| [`paystack_commerce_virtual_terminal_destination_unassign`](#paystack_commerce_virtual_terminal_destination_unassign) | Unassign Destination from Virtual Terminal |
| [`paystack_commerce_virtual_terminal_fetch`](#paystack_commerce_virtual_terminal_fetch)                               | Fetch Virtual Terminal                     |
| [`paystack_commerce_virtual_terminal_list`](#paystack_commerce_virtual_terminal_list)                                 | List Virtual Terminals                     |
| [`paystack_commerce_virtual_terminal_update`](#paystack_commerce_virtual_terminal_update)                             | Update Virtual Terminal                    |

***

## paystack\_commerce\_order\_create

Create Order

**Parameters:**

| Parameter    | Type      | Required | Default | Description                                                     |
| ------------ | --------- | -------- | ------- | --------------------------------------------------------------- |
| `currency`   | string    | Yes      | —       | Currency in which amount is set                                 |
| `email`      | string    | Yes      | —       | The email of the customer placing the order                     |
| `first_name` | string    | Yes      | —       | The customer's first name                                       |
| `is_gift`    | boolean   | No       | —       | A flag to indicate if the order is for someone else             |
| `items`      | object\[] | Yes      | —       | The items value                                                 |
| `last_name`  | string    | Yes      | —       | The customer's last name                                        |
| `pay_for_me` | boolean   | No       | —       | A flag to indicate if the someone else should pay for the order |
| `phone`      | string    | Yes      | —       | The customer's mobile number                                    |
| `shipping`   | object    | Yes      | —       | The shipping details of the order                               |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "currency": {
        "type": "string",
        "description": "Currency in which amount is set",
        "enum": [
          "GHS",
          "KES",
          "NGN",
          "USD",
          "ZAR"
        ]
      },
      "email": {
        "type": "string",
        "description": "The email of the customer placing the order"
      },
      "first_name": {
        "type": "string",
        "description": "The customer's first name"
      },
      "is_gift": {
        "type": "boolean",
        "description": "A flag to indicate if the order is for someone else"
      },
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "item": {
              "type": "integer",
              "description": "The product ID of the item"
            },
            "type": {
              "type": "string",
              "description": "The type of the item. `product` is currently the acceptable value"
            },
            "quantity": {
              "type": "integer",
              "description": "The number of items to get"
            },
            "amount": {
              "type": "integer",
              "description": "The cost of the item"
            }
          },
          "required": [
            "item",
            "type",
            "quantity",
            "amount"
          ]
        },
        "description": "The items value"
      },
      "last_name": {
        "type": "string",
        "description": "The customer's last name"
      },
      "pay_for_me": {
        "type": "boolean",
        "description": "A flag to indicate if the someone else should pay for the order"
      },
      "phone": {
        "type": "string",
        "description": "The customer's mobile number"
      },
      "shipping": {
        "type": "object",
        "description": "The shipping details of the order",
        "properties": {
          "street_line": {
            "type": "string",
            "description": "The address of for the delivery"
          },
          "city": {
            "type": "string",
            "description": "The city of the delivery address"
          },
          "state": {
            "type": "string",
            "description": "The state of the delivery address"
          },
          "country": {
            "type": "string",
            "description": "The country of the delivery address"
          },
          "shipping_fee": {
            "type": "integer",
            "description": "The cost of delivery"
          },
          "delivery_note": {
            "type": "string",
            "description": "Extra details to be aware of for the delivery"
          }
        },
        "required": [
          "street_line",
          "city",
          "state",
          "country",
          "shipping_fee"
        ]
      }
    },
    "required": [
      "PCID",
      "currency",
      "email",
      "first_name",
      "items",
      "last_name",
      "phone",
      "shipping"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_order\_fetch

Fetch Order

**Parameters:**

| Parameter | Type    | Required | Default | Description                        |
| --------- | ------- | -------- | ------- | ---------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the order |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the order"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_order\_list

List Orders

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `perPage` | integer | No       | —       | Number of records to fetch per page |
| `page`    | integer | No       | —       | The section to retrieve             |
| `from`    | string  | No       | —       | The start date                      |
| `to`      | string  | No       | —       | The end date                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "perPage": {
        "type": "integer",
        "description": "Number of records to fetch per page"
      },
      "page": {
        "type": "integer",
        "description": "The section to retrieve"
      },
      "from": {
        "type": "string",
        "description": "The start date"
      },
      "to": {
        "type": "string",
        "description": "The end date"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_order\_product

Fetch Product Orders

**Parameters:**

| Parameter | Type    | Required | Default | Description                          |
| --------- | ------- | -------- | ------- | ------------------------------------ |
| `id`      | integer | Yes      | —       | The unique identifier of the product |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the product"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_order\_validate

Validate Order

**Parameters:**

| Parameter | Type   | Required | Default | Description                                   |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `code`    | string | Yes      | —       | The unique code of a previously created order |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "The unique code of a previously created order"
      }
    },
    "required": [
      "PCID",
      "code"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_add\_products

Add Products

**Parameters:**

| Parameter  | Type       | Required | Default | Description                                 |
| ---------- | ---------- | -------- | ------- | ------------------------------------------- |
| `id`       | string     | Yes      | —       | The id value                                |
| `products` | integer\[] | Yes      | —       | A list of IDs of products to add to a page. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The id value"
      },
      "products": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "A list of IDs of products to add to a page."
      }
    },
    "required": [
      "PCID",
      "id",
      "products"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_check\_slug\_availability

Check Slug Availability

**Parameters:**

| Parameter | Type   | Required | Default | Description              |
| --------- | ------ | -------- | ------- | ------------------------ |
| `slug`    | string | Yes      | —       | The custom slug to check |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "slug": {
        "type": "string",
        "description": "The custom slug to check"
      }
    },
    "required": [
      "PCID",
      "slug"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_create

Create Page

**Parameters:**

| Parameter            | Type      | Required | Default | Description                                                                                                           |
| -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| `amount`             | integer   | No       | —       | Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR               |
| `collect_phone`      | boolean   | No       | —       | Specify whether to collect phone numbers on the payment page                                                          |
| `currency`           | string    | No       | —       | The transaction currency. Defaults to your integration currency.                                                      |
| `custom_fields`      | object\[] | No       | —       | If you would like to accept custom fields, specify them here.                                                         |
| `description`        | string    | No       | —       | The description of the page                                                                                           |
| `fixed_amount`       | boolean   | No       | —       | Specifies whether to collect a fixed amount on the payment page. If true, `amount` must be passed.                    |
| `metadata`           | object    | No       | —       | JSON object of custom data                                                                                            |
| `name`               | string    | Yes      | —       | Name of page                                                                                                          |
| `notification_email` | string    | No       | —       | An email address that will receive transaction notifications for this payment page                                    |
| `plan`               | string    | No       | —       | The ID of the plan to subscribe customers on this payment page to when `type` is set to `subscription`.               |
| `redirect_url`       | string    | No       | —       | If you would like Paystack to redirect to a URL upon successful payment, specify the URL here.                        |
| `slug`               | string    | No       | —       | URL slug you would like to be associated with this page. Page will be accessible at `https://paystack.com/pay/[slug]` |
| `split_code`         | string    | No       | —       | The split code of the transaction split. e.g. `SPL_98WF13Eb3w`                                                        |
| `success_message`    | string    | No       | —       | A success message to display to the customer after a successful transaction                                           |
| `type`               | string    | No       | —       | The type of payment page to create. Defaults to `payment` if no type is specified.                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "amount": {
        "type": "integer",
        "description": "Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR"
      },
      "collect_phone": {
        "type": "boolean",
        "description": "Specify whether to collect phone numbers on the payment page"
      },
      "currency": {
        "type": "string",
        "description": "The transaction currency. Defaults to your integration currency.",
        "enum": [
          "NGN",
          "GHS",
          "ZAR",
          "KES",
          "USD"
        ]
      },
      "custom_fields": {
        "type": "array",
        "items": {
          "type": "object"
        },
        "description": "If you would like to accept custom fields, specify them here."
      },
      "description": {
        "type": "string",
        "description": "The description of the page"
      },
      "fixed_amount": {
        "type": "boolean",
        "description": "Specifies whether to collect a fixed amount on the payment page. If true, `amount` must be passed."
      },
      "metadata": {
        "type": "object",
        "description": "JSON object of custom data"
      },
      "name": {
        "type": "string",
        "description": "Name of page"
      },
      "notification_email": {
        "type": "string",
        "description": "An email address that will receive transaction notifications for this payment page"
      },
      "plan": {
        "type": "string",
        "description": "The ID of the plan to subscribe customers on this payment page to when `type` is set to `subscription`."
      },
      "redirect_url": {
        "type": "string",
        "description": "If you would like Paystack to redirect to a URL upon successful payment, specify the URL here."
      },
      "slug": {
        "type": "string",
        "description": "URL slug you would like to be associated with this page. Page will be accessible at `https://paystack.com/pay/[slug]`"
      },
      "split_code": {
        "type": "string",
        "description": "The split code of the transaction split. e.g. `SPL_98WF13Eb3w`"
      },
      "success_message": {
        "type": "string",
        "description": "A success message to display to the customer after a successful transaction"
      },
      "type": {
        "type": "string",
        "description": "The type of payment page to create. Defaults to `payment` if no type is specified.",
        "enum": [
          "payment",
          "subscription",
          "product",
          "plan"
        ]
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_fetch

Fetch Page

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of a payment page |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of a payment page"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_list

List Pages

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `perPage` | integer | No       | —       | Number of records to fetch per page |
| `page`    | integer | No       | —       | The section to retrieve             |
| `from`    | string  | No       | —       | The start date                      |
| `to`      | string  | No       | —       | The end date                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "perPage": {
        "type": "integer",
        "description": "Number of records to fetch per page"
      },
      "page": {
        "type": "integer",
        "description": "The section to retrieve"
      },
      "from": {
        "type": "string",
        "description": "The start date"
      },
      "to": {
        "type": "string",
        "description": "The end date"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_page\_update

Update Page

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                     |
| ------------- | ------- | -------- | ------- | ----------------------------------------------- |
| `id`          | integer | Yes      | —       | The unique identifier of a payment page         |
| `active`      | boolean | No       | —       | Set to false to deactivate page url             |
| `amount`      | integer | No       | —       | Amount should be in the subunit of the currency |
| `description` | string  | No       | —       | The description of the page                     |
| `name`        | string  | No       | —       | Name of page                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of a payment page"
      },
      "active": {
        "type": "boolean",
        "description": "Set to false to deactivate page url"
      },
      "amount": {
        "type": "integer",
        "description": "Amount should be in the subunit of the currency"
      },
      "description": {
        "type": "string",
        "description": "The description of the page"
      },
      "name": {
        "type": "string",
        "description": "Name of page"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_product\_create

Create Product

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                            |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `currency`    | string  | Yes      | —       | Currency in which price is set. Allowed values are: NGN, GHS, ZAR or USD                               |
| `description` | string  | Yes      | —       | The description of the product                                                                         |
| `metadata`    | object  | No       | —       | JSON object of custom data                                                                             |
| `name`        | string  | Yes      | —       | Name of product                                                                                        |
| `price`       | integer | Yes      | —       | Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR |
| `quantity`    | integer | No       | —       | Number of products in stock. Use if limited is true                                                    |
| `split_code`  | string  | No       | —       | The split code if sharing the transaction with partners                                                |
| `unlimited`   | boolean | No       | —       | Set to true if the product has unlimited stock. Leave as false if the product has limited stock        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "currency": {
        "type": "string",
        "description": "Currency in which price is set. Allowed values are: NGN, GHS, ZAR or USD"
      },
      "description": {
        "type": "string",
        "description": "The description of the product"
      },
      "metadata": {
        "type": "object",
        "description": "JSON object of custom data"
      },
      "name": {
        "type": "string",
        "description": "Name of product"
      },
      "price": {
        "type": "integer",
        "description": "Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR"
      },
      "quantity": {
        "type": "integer",
        "description": "Number of products in stock. Use if limited is true"
      },
      "split_code": {
        "type": "string",
        "description": "The split code if sharing the transaction with partners"
      },
      "unlimited": {
        "type": "boolean",
        "description": "Set to true if the product has unlimited stock. Leave as false if the product has limited stock"
      }
    },
    "required": [
      "PCID",
      "currency",
      "description",
      "name",
      "price"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_product\_delete

Delete Product

**Parameters:**

| Parameter | Type    | Required | Default | Description                          |
| --------- | ------- | -------- | ------- | ------------------------------------ |
| `id`      | integer | Yes      | —       | The unique identifier of the product |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the product"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_product\_fetch

Fetch Product

**Parameters:**

| Parameter | Type    | Required | Default | Description                          |
| --------- | ------- | -------- | ------- | ------------------------------------ |
| `id`      | integer | Yes      | —       | The unique identifier of the product |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the product"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_product\_list

List Products

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |
| --------- | ------- | -------- | ------- | ----------------------------------- |
| `perPage` | integer | No       | —       | Number of records to fetch per page |
| `page`    | integer | No       | —       | The section to retrieve             |
| `active`  | boolean | No       | —       | The state of the product            |
| `from`    | string  | No       | —       | The start date                      |
| `to`      | string  | No       | —       | The end date                        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "perPage": {
        "type": "integer",
        "description": "Number of records to fetch per page"
      },
      "page": {
        "type": "integer",
        "description": "The section to retrieve"
      },
      "active": {
        "type": "boolean",
        "description": "The state of the product"
      },
      "from": {
        "type": "string",
        "description": "The start date"
      },
      "to": {
        "type": "string",
        "description": "The end date"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_product\_update

Update product

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                            |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `id`          | integer | Yes      | —       | The unique identifier of the product                                                                   |
| `currency`    | string  | No       | —       | Currency in which price is set. Allowed values are: NGN, GHS, ZAR or USD                               |
| `description` | string  | No       | —       | The description of the product                                                                         |
| `metadata`    | object  | No       | —       | JSON object of custom data                                                                             |
| `name`        | string  | No       | —       | Name of product                                                                                        |
| `price`       | integer | No       | —       | Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR |
| `quantity`    | integer | No       | —       | Number of products in stock. Use if limited is true                                                    |
| `split_code`  | string  | No       | —       | The split code if sharing the transaction with partners                                                |
| `unlimited`   | boolean | No       | —       | Set to true if the product has unlimited stock. Leave as false if the product has limited stock        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the product"
      },
      "currency": {
        "type": "string",
        "description": "Currency in which price is set. Allowed values are: NGN, GHS, ZAR or USD"
      },
      "description": {
        "type": "string",
        "description": "The description of the product"
      },
      "metadata": {
        "type": "object",
        "description": "JSON object of custom data"
      },
      "name": {
        "type": "string",
        "description": "Name of product"
      },
      "price": {
        "type": "integer",
        "description": "Price should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR"
      },
      "quantity": {
        "type": "integer",
        "description": "Number of products in stock. Use if limited is true"
      },
      "split_code": {
        "type": "string",
        "description": "The split code if sharing the transaction with partners"
      },
      "unlimited": {
        "type": "boolean",
        "description": "Set to true if the product has unlimited stock. Leave as false if the product has limited stock"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_add\_products

Add Products to Storefront

**Parameters:**

| Parameter  | Type       | Required | Default | Description                             |
| ---------- | ---------- | -------- | ------- | --------------------------------------- |
| `id`       | integer    | Yes      | —       | The unique identifier of the Storefront |
| `products` | integer\[] | Yes      | —       | An array of product IDs                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      },
      "products": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "An array of product IDs"
      }
    },
    "required": [
      "PCID",
      "id",
      "products"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_create

Create Storefront

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                                                                          |
| ------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `currency`    | string | Yes      | —       | Currency for prices of products in your storefront.                                                                                                                  |
| `description` | string | No       | —       | The description of the storefront                                                                                                                                    |
| `name`        | string | Yes      | —       | Name of the storefront                                                                                                                                               |
| `slug`        | string | Yes      | —       | A unique identifier to access your store. Once the storefront is created, it can be accessed from [https://paystack.shop/your-slug](https://paystack.shop/your-slug) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "currency": {
        "type": "string",
        "description": "Currency for prices of products in your storefront.",
        "enum": [
          "GHS",
          "KES",
          "NGN",
          "USD",
          "ZAR"
        ]
      },
      "description": {
        "type": "string",
        "description": "The description of the storefront"
      },
      "name": {
        "type": "string",
        "description": "Name of the storefront"
      },
      "slug": {
        "type": "string",
        "description": "A unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug"
      }
    },
    "required": [
      "PCID",
      "currency",
      "name",
      "slug"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_delete

Delete Storefront

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_duplicate

Duplicate Storefront

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_fetch

Fetch Storefront

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_fetch\_orders

Fetch Storefront Orders

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_list

List Storefronts

**Parameters:**

| Parameter | Type    | Required | Default | Description                            |
| --------- | ------- | -------- | ------- | -------------------------------------- |
| `perPage` | integer | No       | —       | Number of records to fetch per request |
| `page`    | integer | No       | —       | The offset to retrieve data from       |
| `status`  | string  | No       | —       | The status value                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "perPage": {
        "type": "integer",
        "description": "Number of records to fetch per request"
      },
      "page": {
        "type": "integer",
        "description": "The offset to retrieve data from"
      },
      "status": {
        "type": "string",
        "description": "The status value",
        "enum": [
          "active",
          "inactive"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_list\_products

List Storefront Products

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_publish

Publish Storefront

**Parameters:**

| Parameter | Type    | Required | Default | Description                             |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id`      | integer | Yes      | —       | The unique identifier of the Storefront |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_update

Update Storefront

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                                                                                          |
| ------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`          | integer | Yes      | —       | The unique identifier of the Storefront                                                                                                                              |
| `description` | string  | No       | —       | The description of the storefront                                                                                                                                    |
| `name`        | string  | No       | —       | Name of the storefront                                                                                                                                               |
| `slug`        | string  | No       | —       | A unique identifier to access your store. Once the storefront is created, it can be accessed from [https://paystack.shop/your-slug](https://paystack.shop/your-slug) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The unique identifier of the Storefront"
      },
      "description": {
        "type": "string",
        "description": "The description of the storefront"
      },
      "name": {
        "type": "string",
        "description": "Name of the storefront"
      },
      "slug": {
        "type": "string",
        "description": "A unique identifier to access your store. Once the storefront is created, it can be accessed from https://paystack.shop/your-slug"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_storefront\_verify\_slug

Verify Storefront Slug

**Parameters:**

| Parameter | Type   | Required | Default | Description              |
| --------- | ------ | -------- | ------- | ------------------------ |
| `slug`    | string | Yes      | —       | The custom slug to check |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "slug": {
        "type": "string",
        "description": "The custom slug to check"
      }
    },
    "required": [
      "PCID",
      "slug"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_commission

Commission Terminal

**Parameters:**

| Parameter       | Type   | Required | Default | Description          |
| --------------- | ------ | -------- | ------- | -------------------- |
| `serial_number` | string | Yes      | —       | Device Serial Number |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serial_number": {
        "type": "string",
        "description": "Device Serial Number"
      }
    },
    "required": [
      "PCID",
      "serial_number"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_decommission

Decommission Terminal

**Parameters:**

| Parameter       | Type   | Required | Default | Description          |
| --------------- | ------ | -------- | ------- | -------------------- |
| `serial_number` | string | Yes      | —       | Device Serial Number |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "serial_number": {
        "type": "string",
        "description": "Device Serial Number"
      }
    },
    "required": [
      "PCID",
      "serial_number"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_fetch

Fetch Terminal

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                         |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `terminal_id` | string | Yes      | —       | The ID of the Terminal the event should be sent to. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "terminal_id": {
        "type": "string",
        "description": "The ID of the Terminal the event should be sent to."
      }
    },
    "required": [
      "PCID",
      "terminal_id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_fetch\_event\_status

Fetch Event Status

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                         |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `terminal_id` | string | Yes      | —       | The ID of the Terminal the event should be sent to. |
| `event_id`    | string | Yes      | —       | The ID of the event that was sent to the Terminal   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "terminal_id": {
        "type": "string",
        "description": "The ID of the Terminal the event should be sent to."
      },
      "event_id": {
        "type": "string",
        "description": "The ID of the event that was sent to the Terminal"
      }
    },
    "required": [
      "PCID",
      "terminal_id",
      "event_id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_fetch\_terminal\_status

Fetch Terminal Status

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                         |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `terminal_id` | string | Yes      | —       | The ID of the Terminal the event should be sent to. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "terminal_id": {
        "type": "string",
        "description": "The ID of the Terminal the event should be sent to."
      }
    },
    "required": [
      "PCID",
      "terminal_id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_list

List Terminals

**Parameters:**

| Parameter  | Type    | Required | Default | Description                                                                                                                           |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `next`     | string  | No       | —       | A cursor that indicates your place in the list. It can be used to fetch the next page of the list                                     |
| `previous` | string  | No       | —       | A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request |
| `per_page` | integer | No       | —       | Specify how many records you want to retrieve per page                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "next": {
        "type": "string",
        "description": "A cursor that indicates your place in the list. It can be used to fetch the next page of the list"
      },
      "previous": {
        "type": "string",
        "description": "A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request"
      },
      "per_page": {
        "type": "integer",
        "description": "Specify how many records you want to retrieve per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_send\_event

Send Event

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                                                                                     |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`      | string | Yes      | —       | The ID of the Terminal the event should be sent to.                                                                                                                             |
| `action`  | string | No       | —       | The action the Terminal needs to perform. For the invoice type, the action can either be process or view.  For the transaction type, the action can either be process or print. |
| `data`    | object | No       | —       | The parameters needed to perform the specified action                                                                                                                           |
| `type`    | string | No       | —       | The type of event to push                                                                                                                                                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The ID of the Terminal the event should be sent to."
      },
      "action": {
        "type": "string",
        "description": "The action the Terminal needs to perform. For the invoice type, the action can either be process or view.  For the transaction type, the action can either be process or print.",
        "enum": [
          "process",
          "view",
          "print"
        ]
      },
      "data": {
        "type": "object",
        "description": "The parameters needed to perform the specified action",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The invoice or transaction  ID you want to push to the Terminal"
          },
          "reference": {
            "type": "string",
            "description": "The offline_reference from the Payment Request response"
          }
        }
      },
      "type": {
        "type": "string",
        "description": "The type of event to push",
        "enum": [
          "invoice",
          "transaction"
        ]
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_terminal\_update

Update Terminal

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                         |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `terminal_id` | string | Yes      | —       | The ID of the Terminal the event should be sent to. |
| `address`     | string | No       | —       | The new address for the Terminal                    |
| `name`        | string | No       | —       | The new name for the Terminal                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "terminal_id": {
        "type": "string",
        "description": "The ID of the Terminal the event should be sent to."
      },
      "address": {
        "type": "string",
        "description": "The new address for the Terminal"
      },
      "name": {
        "type": "string",
        "description": "The new name for the Terminal"
      }
    },
    "required": [
      "PCID",
      "terminal_id"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_add\_split\_code

Add Split Code to Virtual Terminal

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                      |
| ------------ | ------ | -------- | ------- | ------------------------------------------------ |
| `code`       | string | Yes      | —       | Code of the Virtual Terminal                     |
| `split_code` | string | Yes      | —       | The split code to assign to the virtual terminal |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      },
      "split_code": {
        "type": "string",
        "description": "The split code to assign to the virtual terminal"
      }
    },
    "required": [
      "PCID",
      "code",
      "split_code"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_create

Create Virtual Terminal

**Parameters:**

| Parameter      | Type      | Required | Default | Description                                                                                |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `destinations` | object\[] | Yes      | —       | Array of objects containing recipients for payment notifications for the Virtual Terminal. |
| `metadata`     | object    | No       | —       | Additional custom data as key-value pairs                                                  |
| `name`         | string    | Yes      | —       | The name of the virtual terminal                                                           |
| `split_code`   | string    | No       | —       | Split code to associate with the virtual terminal                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "destinations": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "target": {
              "type": "string",
              "description": "The WhatsApp number to receive payment notifications"
            },
            "name": {
              "type": "string",
              "description": "The name of the associated WhatsApp number"
            }
          }
        },
        "description": "Array of objects containing recipients for payment notifications for the Virtual Terminal."
      },
      "metadata": {
        "type": "object",
        "description": "Additional custom data as key-value pairs"
      },
      "name": {
        "type": "string",
        "description": "The name of the virtual terminal"
      },
      "split_code": {
        "type": "string",
        "description": "Split code to associate with the virtual terminal"
      }
    },
    "required": [
      "PCID",
      "destinations",
      "name"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_deactivate

Deactivate Virtual Terminal

**Parameters:**

| Parameter | Type   | Required | Default | Description                  |
| --------- | ------ | -------- | ------- | ---------------------------- |
| `code`    | string | Yes      | —       | Code of the Virtual Terminal |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      }
    },
    "required": [
      "PCID",
      "code"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_delete\_split\_code

Remove Split Code from Virtual Terminal

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                      |
| ------------ | ------ | -------- | ------- | ------------------------------------------------ |
| `code`       | string | Yes      | —       | Code of the Virtual Terminal                     |
| `split_code` | string | Yes      | —       | The split code to assign to the virtual terminal |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      },
      "split_code": {
        "type": "string",
        "description": "The split code to assign to the virtual terminal"
      }
    },
    "required": [
      "PCID",
      "code",
      "split_code"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_destination\_assign

Assign Destination to Virtual Terminal

**Parameters:**

| Parameter      | Type      | Required | Default | Description                                                                                |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `code`         | string    | Yes      | —       | Code of the Virtual Terminal                                                               |
| `destinations` | object\[] | Yes      | —       | Array of objects containing recipients for payment notifications for the Virtual Terminal. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      },
      "destinations": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "target": {
              "type": "string",
              "description": "The WhatsApp number to receive payment notifications"
            },
            "name": {
              "type": "string",
              "description": "The name of the associated WhatsApp number"
            }
          }
        },
        "description": "Array of objects containing recipients for payment notifications for the Virtual Terminal."
      }
    },
    "required": [
      "PCID",
      "code",
      "destinations"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_destination\_unassign

Unassign Destination from Virtual Terminal

**Parameters:**

| Parameter | Type      | Required | Default | Description                              |
| --------- | --------- | -------- | ------- | ---------------------------------------- |
| `code`    | string    | Yes      | —       | Code of the Virtual Terminal             |
| `targets` | string\[] | Yes      | —       | Array of destination targets to unassign |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      },
      "targets": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of destination targets to unassign"
      }
    },
    "required": [
      "PCID",
      "code",
      "targets"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_fetch

Fetch Virtual Terminal

**Parameters:**

| Parameter | Type   | Required | Default | Description                  |
| --------- | ------ | -------- | ------- | ---------------------------- |
| `code`    | string | Yes      | —       | Code of the Virtual Terminal |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      }
    },
    "required": [
      "PCID",
      "code"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_list

List Virtual Terminals

**Parameters:**

| Parameter | Type    | Required | Default | Description                                |
| --------- | ------- | -------- | ------- | ------------------------------------------ |
| `perPage` | integer | No       | —       | The number of records to fetch per request |
| `page`    | integer | No       | —       | The offset to retrieve data from           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "perPage": {
        "type": "integer",
        "description": "The number of records to fetch per request"
      },
      "page": {
        "type": "integer",
        "description": "The offset to retrieve data from"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## paystack\_commerce\_virtual\_terminal\_update

Update Virtual Terminal

**Parameters:**

| Parameter | Type   | Required | Default | Description                  |
| --------- | ------ | -------- | ------- | ---------------------------- |
| `code`    | string | Yes      | —       | Code of the Virtual Terminal |
| `name`    | string | Yes      | —       | Name of the virtual terminal |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "code": {
        "type": "string",
        "description": "Code of the Virtual Terminal"
      },
      "name": {
        "type": "string",
        "description": "Name of the virtual terminal"
      }
    },
    "required": [
      "PCID",
      "code",
      "name"
    ]
  }
  ```
</Expandable>