Genie Business Connect

https://geniebusiness.stoplight.io/docs/genie-business-connect/
Admin
Genie Business Connect provides a comprehensive set of APIs for businesses to manage transactions,...
Tokens:71,975
Snippets:205
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Status Embed Installation

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/035c753f6dbbe-create-transaction-v2

Information on how to correctly install the status embed to display incidents or maintenance updates from your status page.

```APIDOC
## Status Embed Installation

### Description
This section describes how to install the status embed. When installed correctly, it will display any incidents or maintenance notices posted on your status page.

### Usage
Instructions for installing the status embed are not detailed in the provided text. It is implied that this is a client-side integration. For detailed implementation steps, please refer to the official documentation or integration guides.

### Example
```html
<!-- Example of how the embed might be included -->
<div id="status-embed"></div>
```
```

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

### Webhook Request Example Body

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/7i6ju3jphgg8d-webhooks

An example of the JSON payload received when a transaction state changes and a webhook is triggered.

```APIDOC
## Webhooks Example Body

This is an example of the data structure received by your webhook endpoint when a transaction's state is updated.

```json
{
  "created": "2023-06-09T08:46:45.899Z",
  "updated": "2023-06-09T08:46:45.899Z",
  "updatedKeys": [],
  "deleted": false,
  "eventType": "NOTIFY_TRANSACTION_CHANGE",
  "companyId": "64646727335b730008db10f8",
  "localId": null,
  "customerReference": null,
  "transactionId": "6482d462ce6c690008e85e42",
  "state": "CONFIRMED",
  "signature": "wzczRUp5i/0DqS5LzGVQUw==",
  "amount": 1400,
  "amountFractional": 14,
  "amountFormatted": "LKR 14.00",
  "currency": "LKR",
  "securityWord": "EXHILARATING TOAD",
  "provider": "card_payments",
  "qrCode": {
    "url": "https://qr.uat..co.th/64646727335b730008db10f8/transactions/6482d462ce6c690008e85e42_rspmjp1686295669.png"
  },
  "orderInfo": null,
  "notifyUrl": null,
  "response": null,
  "originalSignature": "wzczRUp5i/0DqS5LzGVQUw==",
  "externalSource": "Genie Business Gateway",
  "id": "6482e6f5bcf6fa0008683c2f"
}
```
```

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

### PaymentProvider Schema Example JSON

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/93681b4fdf732-payment-provider

Example JSON object representing a PaymentProvider with properties for ecommerce and mobile payment support, merchant and customer descriptions, unique value identifier, and shop badge URL for logo display.

```json
{
  "ecommerce": true,
  "mobile": true,
  "description": "Accept Apple and Google Pay",
  "customerDescription": "Pay with your mobile wallet",
  "value": "card",
  "shopBadge": "https://res.cloudinary.com/genie-business/image/upload/5fcc844930ccd835938957.png"
}
```

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

### Get Customer Detail API Response Example

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/b3974f51c7214-get-a-customer-detail

This is an example JSON response for the 'Get A Customer Detail' API endpoint. It includes various fields such as customer ID, creation and update timestamps, personal information, billing details, and company-specific identifiers. The response structure is consistent for successful requests.

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "email": "user@example.com",
  "billingEmail": "user@example.com",
  "billingAddress1": "string",
  "billingAddress2": "string",
  "billingCity": "string",
  "billingPostCode": "string",
  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  "billingCountry": "string",
  "customerGroupId": "2dd84b21-d83b-43ae-b968-ef03d5123a21",
  "currency": "str",
  "invoicePrefix": "string",
  "taxId": "string",
  "taxInformation": "string",
  "externalSource": "string",
  "__v": "string",
  "idempotencyKey": "string",
  "_id": "string"
}
```

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

### Webhook Example Body (JSON)

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/7i6ju3jphgg8d-webhooks

This is an example JSON payload that Genie Business Connect sends to a webhook URL when a transaction's state changes. It includes details such as timestamps, transaction ID, new state, amount, currency, and signature for verification.

```json
{
  "created": "2023-06-09T08:46:45.899Z",
  "updated": "2023-06-09T08:46:45.899Z",
  "updatedKeys": [],
  "deleted": false,
  "eventType": "NOTIFY_TRANSACTION_CHANGE",
  "companyId": "64646727335b730008db10f8",
  "localId": null,
  "customerReference": null,
  "transactionId": "6482d462ce6c690008e85e42",
  "state": "CONFIRMED",
  "signature": "wzczRUp5i/0DqS5LzGVQUw==",
  "amount": 1400,
  "amountFractional": 14,
  "amountFormatted": "LKR 14.00",
  "currency": "LKR",
  "securityWord": "EXHILARATING TOAD",
  "provider": "card_payments",
  "qrCode": {
    "url": "https://qr.uat..co.th/64646727335b730008db10f8/transactions/6482d462ce6c690008e85e42_rspmjp1686295669.png"
  },
  "orderInfo": null,
  "notifyUrl": null,
  "response": null,
  "originalSignature": "wzczRUp5i/0DqS5LzGVQUw==",
  "externalSource": "Genie Business Gateway",
  "id": "6482e6f5bcf6fa0008683c2f"
}
```

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

### Webhook Example Payload

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/7i6ju3jphgg8d-webhooks

Sample webhook payload sent by Genie Business Connect containing transaction details, state information, and security signatures for verification.

```APIDOC
## Webhook Event Payload

### Description
This is an example of the webhook payload sent to your configured endpoint when a transaction state changes.

### Response Body Fields
- **created** (string) - ISO 8601 timestamp of webhook creation
- **updated** (string) - ISO 8601 timestamp of last update
- **updatedKeys** (array) - Fields that were updated
- **deleted** (boolean) - Whether the transaction was deleted
- **eventType** (string) - Type of event (NOTIFY_TRANSACTION_CHANGE)
- **companyId** (string) - Merchant company identifier
- **transactionId** (string) - Unique transaction identifier
- **state** (string) - Current transaction state (e.g., CONFIRMED)
- **signature** (string) - Security signature for verification
- **amount** (integer) - Transaction amount in minor units
- **amountFormatted** (string) - Human-readable formatted amount
- **currency** (string) - ISO 4217 currency code
- **securityWord** (string) - Additional security verification
- **provider** (string) - Payment provider used
- **qrCode** (object) - QR code details with URL
- **externalSource** (string) - Source of the transaction
- **id** (string) - Webhook event identifier

### Example Payload
```json
{
  "created": "2023-06-09T08:46:45.899Z",
  "updated": "2023-06-09T08:46:45.899Z",
  "updatedKeys": [],
  "deleted": false,
  "eventType": "NOTIFY_TRANSACTION_CHANGE",
  "companyId": "64646727335b730008db10f8",
  "localId": null,
  "customerReference": null,
  "transactionId": "6482d462ce6c690008e85e42",
  "state": "CONFIRMED",
  "signature": "wzczRUp5i/0DqS5LzGVQUw==",
  "amount": 1400,
  "amountFractional": 14,
  "amountFormatted": "LKR 14.00",
  "currency": "LKR",
  "securityWord": "EXHILARATING TOAD",
  "provider": "card_payments",
  "qrCode": {
    "url": "https://qr.uat..co.th/64646727335b730008db10f8/transactions/6482d462ce6c690008e85e42_rspmjp1686295669.png"
  },
  "orderInfo": null,
  "notifyUrl": null,
  "response": null,
  "originalSignature": "wzczRUp5i/0DqS5LzGVQUw==",
  "externalSource": "Genie Business Gateway",
  "id": "6482e6f5bcf6fa0008683c2f"
}
```
```

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

### Send SMS Transaction Notification Response Example (JSON)

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/113dde8af4973-share-payment-link-via-sms

This is an example response from the send SMS API. It includes various details about the transaction, such as creation and update timestamps, amounts, currency, provider information, and the transaction state. It also contains historical data and error information if applicable.

```json
{
  "created": "string",
  "updated": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "amount": 0,
  "merchantId": "string",
  "customerId": "string",
  "localCustomerId": "string",
  "currency": "string",
  "payCurrency": "string",
  "provider": "string",
  "providerHistory": [
    {}
  ],
  "state": "INITIATED",
  "accountingState": null,
  "qr": {},
  "securityWord": "string",
  "canRefundIfConfirmed": true,
  "canIncrementalPartialRefundIfConfirmed": true,
  "canPartialRefundIfConfirmed": true,
  "externalImport": true,
  "externalId": "string",
  "localId": "string",
  "localData": "string",
  "externalSource": "string",
  "paymentToken": "string",
  "history": [
    {
      "state": "string",
      "updatedDate": "string",
      "trigger": "string"
    }
  ],
  "appVersion": "string",
  "apiVersion": "string",
  "deviceId": "string",
  "originalDeviceId": "string",
  "paymentAttemptFailureUrl": null,
  "costStructure": null,
  "providerDisplayName": null,
  "remittanceId": null,
  "orderInfo": null,
  "originatorApp": "string",
  "refundId": null,
  "refundReason": null,
  "paymentErrorHistory": [
    {}
  ],
  "subTotal": null,
  "taxesTotal": null,
  "serviceChargeTotal": null,
  "paymentLinks": [
    {}
  ],
  "initiator": null,
  "url": "string",
  "initiatorDetails": null,
  "expires": "string",
  "customerReference": "string",
  "hasError": true,
  "allowRetry": true,
  "threeDSecure": null,
  "paddedCardNumber": null,
  "providerBrandName": null,
  "isPreAuthorization": true,
  "isPaymentLink": true,
  "isShop": null,
  "isTapToPay": null,
  "preauthorizedAmount": null
}
```

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

### GET /customers

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/f1922a213c752-create-new-customer

Retrieves a list of all customers in the system. This endpoint supports pagination and filtering to help you manage large customer databases efficiently.

```APIDOC
## GET /customers

### Description
Retrieve a list of all customers in the Genie Business Connect system with support for pagination and filtering.

### Method
GET

### Endpoint
/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **limit** (integer) - Optional - Number of records per page (default: 20)
- **filter** (string) - Optional - Filter customers by specific criteria

### Response
#### Success Response (200)
- **customers** (array) - List of customer objects
- **total** (integer) - Total number of customers
- **page** (integer) - Current page number
- **limit** (integer) - Records per page

### Response Example
{
  "customers": [
    {
      "id": "cust_123",
      "name": "John Doe",
      "email": "john@example.com",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 20
}
```

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

### GET /customers/{id}

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/f1922a213c752-create-new-customer

Retrieve detailed information about a specific customer by their unique identifier. Returns comprehensive customer data including contact information and account details.

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

### Description
Retrieve detailed information for a specific customer using their unique identifier.

### Method
GET

### Endpoint
/customers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique customer identifier

### Response
#### Success Response (200)
- **id** (string) - Unique customer identifier
- **name** (string) - Customer's full name
- **email** (string) - Customer's email address
- **phone** (string) - Customer's phone number
- **address** (object) - Customer's address details
- **created_at** (string) - Account creation timestamp
- **updated_at** (string) - Last update timestamp

### Response Example
{
  "id": "cust_456",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "phone": "+1234567890",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001"
  },
  "created_at": "2024-01-15T11:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z"
}
```

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

### Create Transaction Response Example

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/035c753f6dbbe-create-transaction-v2

This JSON object represents a successful response after creating a transaction. It includes details such as creation timestamps, amounts, currency, transaction state, and customer information. This structure helps in understanding the data returned by the API upon successful transaction initiation.

```json
{
  "created": "2024-02-08T16:58:08.859Z",
  "updated": "2024-02-08T16:58:08.876Z",
  "createdAt": "2024-02-08T16:58:08.859Z",
  "updatedAt": "2024-02-08T16:58:08.876Z",
  "amount": 400,
  "merchantId": "62e35a2e777562000976c6d6",
  "customerId": "65c508202d13110008fd3b20",
  "localCustomerId": null,
  "currency": "LKR",
  "payCurrency": "LKR",
  "provider": null,
  "providerHistory": [],
  "state": "INITIATED",
  "accountingState": null,
  "qr": {},
  "securityWord": "",
  "canRefundIfConfirmed": true,
  "canIncrementalPartialRefundIfConfirmed": true,
  "canPartialRefundIfConfirmed": true,
  "externalImport": false,
  "externalId": "",
  "localId": "Test dialog txn local id",
  "localData": null,
  "externalSource": "Dialog genie business",
  "paymentToken": null,
  "history": [
    {
      "state": "INITIATED",
      "updatedDate": "2024-02-08T16:58:08.859Z",
      "trigger": "SYSTEM"
    }
  ],
  "appVersion": "1.0.0",
  "apiVersion": "2.0.0",
  "deviceId": "825a766f-c651-40a0-85a9-1c070208e034",
  "originalDeviceId": "825a766f-c651-40a0-85a9-1c070208e034",
  "paymentAttemptFailureUrl": null,
  "costStructure": null,
  "providerDisplayName": null,
  "remittanceId": null,
  "orderInfo": null,
  "originatorApp": "825a766f-c651-40a0-85a9-1c070208e034",
  "refundId": null,
  "refundReason": null,
  "paymentErrorHistory": [],
  "vendorQrCode": null,
  "resellerMetadata": {}
}
```

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

### Webhook Configuration Methods Comparison

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/7i6ju3jphgg8d-webhooks

Comparison of three webhook configuration methods available in Genie Business Connect: Global Webhooks, Single Transaction Webhooks, and Webhook Apps.

```APIDOC
## Webhook Configuration Methods

### Available Methods

#### 1. Global Webhook
- **Configuration:** Set in Merchant Dashboard under Connect > Webhooks
- **Scope:** All transactions, all times
- **Updates:** Receives updates about every transaction
- **Use Case:** Centralized transaction monitoring

#### 2. Single Transaction Webhook
- **Configuration:** Specified when creating a transaction via API
- **Scope:** Specific transaction only
- **Updates:** Receives updates for that individual transaction
- **Use Case:** Transaction-specific event handling
- **Implementation:** Include `webhook` parameter in transaction creation request

#### 3. Webhook Apps
- **Configuration:** Created programmatically via API
- **Scope:** Customizable per app
- **Updates:** Receives updates for both existing and new transactions
- **Use Case:** Integrations (Zapier, IFTTT), event segmentation
- **Advantages:** Programmatic management, flexible routing

### Important Note
If multiple webhook configurations are active simultaneously (global webhook + transaction-specific webhook + webhook apps), **events will be posted to all active webhooks configured**.
```

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

### List Stored Tokens Response Structure

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/achlmtuvst1hp-card-on-file-payments

Example JSON response from the Get Customer Token List API containing an array of stored customer tokens with full token details, card information, and metadata. Each token object includes expiry dates, brand information, and identifiers for subsequent charging operations.

```json
{
    "items": [
        {
            "defaultToken": true,
            "deleted": false,
            "_id": "652e642589dc860008b38500",
            "token": "b9c6522baa0f6f15dcf8d48d064357c6:e38c3a217ee7cc6fb190ff13431d44215709c7ef1bb45146807747e557097e5c32c2e8147bffce31d4f64f68226d3e93",
            "tokenAgreementId": null,
            "tokenAgreementType": "UNSCHEDULED",
            "tokenType": "CARD",
            "provider": "card_payments",
            "brand": "Master",
            "paddedCardNumber": "5444******5118",
            "tokenExpiryMonth": "12",
            "tokenExpiryYear": "2025",
            "companyId": "64646727335b730008db10f8",
            "customerId": "651e62e9d5d5c900086366cf",
            "tokenProvider": "card_payments",
            "createdAt": "2023-10-17T10:38:29.097Z",
            "updatedAt": "2023-10-17T10:38:29.097Z",
            "__v": 0,
            "id": "652e642589dc860008b38500"
        }
    ],
    "count": 1
}
```

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

### Products API

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/f1922a213c752-create-new-customer

Manage product catalog and inventory for your Genie Business Connect store. Create, retrieve, update, and delete products with support for categories, pricing, and product attributes.

```APIDOC
## Products API

### Description
The Products API enables you to manage your product catalog including creation, updates, categorization, and inventory management.

### Core Operations
- **GET /products** - List all products
- **POST /products** - Create new product
- **GET /products/{id}** - Retrieve product details
- **PATCH /products/{id}** - Update product information
- **DELETE /products/{id}** - Remove product

### Product Attributes
- **id** (string) - Unique product identifier
- **name** (string) - Product name
- **description** (string) - Detailed product description
- **price** (decimal) - Product price
- **category_id** (string) - Associated category
- **sku** (string) - Stock keeping unit
- **inventory** (integer) - Available quantity

### Related Resources
- **Categories** - Organize products into categories
- **Custom Fees** - Apply additional fees to products
- **Order Fields** - Define custom order fields
```

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

### GET /customers/tokens/{tokenId}

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/b73137c5ba16f-get-list-of-tokens-for-customer

Retrieves details for a single stored payment token. Use this endpoint to get comprehensive information about a specific tokenized payment method.

```APIDOC
## GET /customers/tokens/{tokenId}

### Description
Retrieve detailed information about a single stored payment token for a customer.

### Method
GET

### Endpoint
/customers/{customerId}/tokens/{tokenId}

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The unique identifier of the customer
- **tokenId** (string) - Required - The unique identifier of the token

### Response
#### Success Response (200)
- **tokenId** (string) - Unique identifier for the token
- **customerId** (string) - Associated customer ID
- **cardType** (string) - Type of card (e.g., VISA, MASTERCARD, AMEX)
- **cardholderName** (string) - Name on the card
- **lastFourDigits** (string) - Last four digits of the card
- **expiryMonth** (integer) - Expiration month
- **expiryYear** (integer) - Expiration year
- **billingAddress** (object) - Billing address associated with token
- **createdAt** (string) - ISO 8601 timestamp when token was created
- **updatedAt** (string) - ISO 8601 timestamp of last update

#### Response Example
{
  "tokenId": "tok_1234567890",
  "customerId": "cust_0987654321",
  "cardType": "VISA",
  "cardholderName": "John Doe",
  "lastFourDigits": "4242",
  "expiryMonth": 12,
  "expiryYear": 2025,
  "billingAddress": {
    "street": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zipCode": "94105"
  },
  "createdAt": "2023-01-15T10:30:00Z",
  "updatedAt": "2023-01-15T10:30:00Z"
}
```

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

### Create Transaction with Amount and Currency

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/035c753f6dbbe-create-transaction-v2

This snippet demonstrates how to create a transaction by providing the amount and currency. It's a fundamental step for initiating any payment process through the Genie Business Connect API. No specific dependencies are mentioned beyond the API itself.

```json
{
  "amount": 500,
  "currency": "LKR"
}
```

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

### Get List of Customers - cURL Request

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/4ed9f9493aa74-get-list-of-customers

Retrieve a paginated list of customers from the Genie Business platform using HTTP GET request. Supports filtering by email, name, date range, and pagination. Requires API Key authentication via Authorization header.

```shell
curl --request GET \
  --url https://api.geniebiz.lk/public-customers/ \
  --header 'Accept: application/json' \
  --header 'Authorization: 123'
```

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

### Genie Business Connect API - Base URLs

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/8ptev5e1nneul-connect-api

Information on the different base URLs for accessing the Genie Business Connect API in production and development/testing environments.

```APIDOC
## API Base URLs

### Description
These are the base URLs for accessing the Genie Business Connect API.

### Production
`https://api.geniebiz.lk`

### Development Testing
`https://api.uat.geniebiz.lk`

### Mock Server
`https://stoplight.io/mocks/geniebusiness/genie-business-connect/68676462`
```

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

### Get List Of Customers

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/4ed9f9493aa74-get-list-of-customers

Retrieves a list of customers from the Genie Business platform. This endpoint supports filtering by email, name, creation date range, and pagination. It returns both the customer list and the total count.

```APIDOC
## GET /public-customers/

### Description
Retrieves a list of customers from the Genie Business platform. This endpoint supports filtering by email, name, creation date range, and pagination. It returns both the customer list and the total count.

### Method
GET

### Endpoint
https://api.geniebiz.lk/public-customers/

### Parameters
#### Query Parameters
- **email** (string) - Optional - Filter by Email address
- **from** (string) - Optional - Filter By Start Date of creation
- **limit** (string) - Optional - How many in one fetch
- **name** (string) - Optional - Filter by name
- **page** (string) - Optional - Page Number
- **to** (string) - Optional - Filter By End Date of creation

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **items** (array[object]) - List of customer objects.
  - **id** (string<uuid>) - Required - Unique Identifier in our system (>= 24 characters, <= 24 characters)
  - **deleted** (boolean) - Required - Boolean indicating if the customer is deleted
  - **createdAt** (string<date-time>) - Required - Creation date and time (>= 1 characters, <= 24 characters)
  - **updatedAt** (string<date-time>) - Required - Last updated date and time (<= 24 characters)
  - **name** (string) - Required - Full name of customer (>= 0 characters, <= 189 characters)
  - **email** (string<email>) - Required - Email ID of customer (>= 1 characters, <= 200 characters)
  - **billingEmail** (string<email>) - Required - Billing email address (>= 1 characters, <= 200 characters)
  - **billingAddress1** (string) - Billing address 1 (>= 1 characters, <= 189 characters)
  - **billingAddress2** (string) - Billing address 2 (>= 1 characters, <= 189 characters)
  - **billingCity** (string) - Billing City (>= 1 characters, <= 189 characters)
  - **billingPostCode** (string) - Billing Post code (>= 1 characters, <= 189 characters)
  - **companyId** (string<uuid>) - Company ID to which this customer is linked (>= 1 characters, <= 24 characters)
  - **billingCountry** (string) - Billing country (>= 1 characters, <= 189 characters)
  - **customerGroupId** (string<uuid>) - Customer group ID, can be used to group customers in merchant dashboard (>= 1 characters, <= 24 characters)
  - **currency** (string) - Currency, will be similar to merchant Currency (>= 1 characters, <= 3 characters)
  - **invoicePrefix** (string) - Invoice identifier prefix, for invoicing module. (>= 1 characters, <= 20 characters)
  - **taxId** (string) - Tax ID (>= 1 characters, <= 20 characters)
  - **taxInformation** (string) - What type of tax is applicable (>= 1 characters, <= 20 characters)
  - **externalSource** (string) - If added through an external source (>= 1 characters, <= 20 characters)
  - **__v** (string) - Internal logic field
  - **idempotencyKey** (string) - Internal logic field
  - **_id** (string) - Internal logic field
- **count** (string) - Total number of customers matching the query

#### Response Example
```json
{
  "items": [
    {
      "id": "60f8b0a3b5f0b3001c8b4567",
      "deleted": false,
      "createdAt": "2023-10-27T10:00:00.000Z",
      "updatedAt": "2023-10-27T10:00:00.000Z",
      "name": "John Doe",
      "email": "john.doe@example.com",
      "billingEmail": "john.doe.billing@example.com",
      "billingAddress1": "123 Main St",
      "billingCity": "Anytown",
      "billingPostCode": "12345",
      "companyId": "60f8b0a3b5f0b3001c8b4568",
      "billingCountry": "USA",
      "currency": "USD",
      "invoicePrefix": "INV-",
      "taxId": "123456789",
      "taxInformation": "VAT",
      "externalSource": "web",
      "__v": "1",
      "idempotencyKey": "abc-123",
      "_id": "cust_xyz789"
    }
  ],
  "count": "1"
}
```
```

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

### Webhook Configurations

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/branches/main/7i6ju3jphgg8d-webhooks

Genie Business offers three primary ways to configure webhooks: Global Webhook, Single Transaction Webhook, and Webhook Apps.

```APIDOC
## Webhook Configurations

There are three methods to set up webhooks with Genie Business:

### 1. Global Webhook
*   **Description:** A single URL configured in the Merchant Dashboard under `Connect` > `Webhooks`. It sends updates for all transactions.
*   **Example URL:** `https://myecommercesite.com/incoming-webhook`
*   **Behavior:** Receives events for all transaction state changes.

### 2. Single Transaction Webhook
*   **Description:** Specified for a single transaction when creating it via the API.
*   **Usage:** Include the `webhook` parameter in your transaction creation request.

### 3. Webhook Apps
*   **Description:** Useful for integrations (e.g., Zapier, IFTTT) and segmenting webhook events. Can be created programmatically using the API.
*   **Reference:** For API specification on creating Webhook Apps, see: https://geniebusiness.stoplight.io/docs/genie-business-connect/c14245b3ba24c-create-webhook

**Note:** If multiple configurations are active (global, transaction-specific, or Webhook Apps), events will be sent to all active webhooks.
```

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

### Get Transaction

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/p7so5c1tfsq0j-create-transaction-refund-request

Retrieves the details of a specific transaction using its ID.

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

### Description
Retrieves the details of a specific transaction.

### Method
GET

### Endpoint
/transactions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the transaction.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the transaction.
- **isTapToPay** (boolean) - Indicates if Tap to Pay was used.
- **preauthorizedAmount** (number) - The preauthorized amount.
- **preauthorizedExpiryDate** (string) - The expiry date for preauthorization.
- **refundExpiryDate** (string) - The expiry date for refunds.
- **fxOrder** (object) - Foreign exchange order details.
- **vendorUrl** (string) - URL of the vendor.
- **vendorAppUrl** (string) - URL of the vendor application.
- **payAmount** (number) - The amount to be paid.
- **rating** (number) - Rating of the transaction.
- **signMethod** (string) - The signature method used.
- **dcc** (object) - Dynamic Currency Conversion details.
- **implicitDcc** (object) - Implicit DCC details.
- **capturedAmount** (number) - The captured amount.
- **urlHash** (string) - Hash of the transaction URL.
- **shortUrl** (string) - Shortened URL for the transaction.
- **orderState** (string) - The current state of the order.
- **orderStateSlug** (string) - A slug representation of the order state.
- **amountBeforeDiscount** (number) - The amount before any discounts.
- **amountDiscounted** (number) - The amount discounted.
- **isTest** (boolean) - Indicates if this is a test transaction.
- **cardExpMonth** (string) - The expiration month of the card.
- **cardExpYear** (string) - The expiration year of the card.
- **cardFunding** (string) - The funding type of the card.
- **cardCountry** (string) - The country associated with the card.
- **refundTransactions** (array) - List of refund transactions.
- **refundTransactionIds** (array) - List of refund transaction IDs.
- **parentTransactionId** (string) - The ID of a parent transaction.
- **paymentLinkSecurity** (object) - Security settings for the payment link.
- **balanceMigrated** (boolean) - Indicates if the balance has been migrated.
- **refundMigrated** (boolean) - Indicates if the refund has been migrated.
- **oldRefundFlowTransaction** (boolean) - Indicates if the old refund flow is used.
- **refundFlagMigration** (boolean) - Indicates if refund flag migration is enabled.
- **invoiceInfo** (object) - Invoice details.
- **availableBalanceMigrated** (boolean) - Indicates if available balance has been migrated.
- **terminalId** (string) - The ID of the terminal.
- **locationMetadata** (object) - Metadata for the transaction location.
- **payerId** (string) - The ID of the payer.
- **payerMetaId** (string) - The metadata ID of the payer.
- **tenantTermsId** (string) - The ID of the tenant's terms.
- **merchantTermsId** (string) - The ID of the merchant's terms.
- **payerIpAddress** (string) - The IP address of the payer.
- **billingInfoProvidedViaAPI** (boolean) - Indicates if billing information was provided via the API.
- **onHold** (boolean) - Indicates if the transaction is on hold.
- **cryptoDetail** (object) - Details for cryptocurrency transactions.
- **tokenizationDetails** (object) - Details for tokenizing the payment.
  - **tokenize** (boolean) - Whether to tokenize the payment.
  - **recurringFrequency** (string) - The frequency for recurring payments.
  - **paymentType** (string) - The type of payment.
- **canVoid** (boolean) - Whether the transaction can be voided.
- **loopCount** (integer) - The number of loops for the transaction.
- **shiftId** (string) - The ID of the shift.
- **avsr** (object) - Address Verification Service Response details.
- **eciIndicator** (string) - The ECI indicator for the transaction.
- **sendCustomerEmailReceipt** (boolean) - Whether to send an email receipt to the customer.
- **selfTopup** (boolean) - Whether this is a self-topup transaction.
- **customProviders** (array) - List of custom providers.
- **mcpOptIn** (boolean) - Merchant Category Code opt-in status.
- **remittanceDate** (string) - The date for remittance.
- **campaignData** (object) - Campaign-specific data.
- **locale** (string) - The locale for the transaction.
- **walletType** (string) - The type of wallet used.
- **paymentPortalExperience** (object) - Configuration for the payment portal experience.
  - **externalWebsiteTermsAccepted** (boolean) - Whether external website terms were accepted.
  - **externalWebsiteTermsUrl** (string) - URL for external website terms.
  - **skipCustomerForm** (boolean) - Whether to skip the customer form.
  - **skipProviderSelection** (boolean) - Whether to skip provider selection.
  - **hideTermsAndConditions** (boolean) - Whether to hide terms and conditions.
- **retrievalReferenceNumber** (string) - The retrieval reference number.
- **isDispute** (boolean) - Indicates if this is a dispute.
- **arn** (string) - The ARN (Acquirer Reference Number).
- **addCardToVault** (boolean) - Whether to add the card to the vault.
- **amountAsDecimal** (string) - The transaction amount as a decimal string.
- **amountFormatted** (string) - The transaction amount as a formatted string.
- **payAmountFormatted** (string) - The pay amount as a formatted string.

#### Response Example
```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isTapToPay": false,
  "preauthorizedAmount": null,
  "preauthorizedExpiryDate": null,
  "refundExpiryDate": null,
  "fxOrder": null,
  "vendorUrl": null,
  "vendorAppUrl": null,
  "payAmount": 100.50,
  "rating": null,
  "signMethod": "string",
  "dcc": null,
  "implicitDcc": null,
  "capturedAmount": null,
  "urlHash": "string",
  "shortUrl": "string",
  "orderState": "COMPLETED",
  "orderStateSlug": "completed",
  "amountBeforeDiscount": null,
  "amountDiscounted": null,
  "isTest": true,
  "cardExpMonth": "string",
  "cardExpYear": "string",
  "cardFunding": "string",
  "cardCountry": "string",
  "refundTransactions": [
    {}
  ],
  "refundTransactionIds": [
    {}
  ],
  "parentTransactionId": null,
  "paymentLinkSecurity": null,
  "balanceMigrated": null,
  "refundMigrated": null,
  "oldRefundFlowTransaction": null,
  "refundFlagMigration": null,
  "invoiceInfo": null,
  "availableBalanceMigrated": null,
  "terminalId": null,
  "locationMetadata": null,
  "payerId": null,
  "payerMetaId": null,
  "tenantTermsId": null,
  "merchantTermsId": null,
  "payerIpAddress": null,
  "billingInfoProvidedViaAPI": true,
  "onHold": true,
  "cryptoDetail": {},
  "tokenizationDetails": {
    "tokenize": true,
    "recurringFrequency": "string",
    "paymentType": "string"
  },
  "canVoid": true,
  "loopCount": 0,
  "shiftId": null,
  "avsr": null,
  "eciIndicator": "string",
  "sendCustomerEmailReceipt": true,
  "selfTopup": true,
  "customProviders": [
    {}
  ],
  "mcpOptIn": true,
  "remittanceDate": "string",
  "campaignData": {},
  "locale": "string",
  "walletType": "string",
  "paymentPortalExperience": {
    "externalWebsiteTermsAccepted": true,
    "externalWebsiteTermsUrl": "string",
    "skipCustomerForm": true,
    "skipProviderSelection": true,
    "hideTermsAndConditions": true
  },
  "retrievalReferenceNumber": "string",
  "isDispute": true,
  "arn": "string",
  "addCardToVault": true,
  "amountAsDecimal": "100.50",
  "amountFormatted": "$100.50",
  "payAmountFormatted": "$100.50"
}
```
```

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

### Create Webhook

Source: https://geniebusiness.stoplight.io/docs/genie-business-connect/c14245b3ba24c-create-webhook

Allows for the creation of new webhooks to receive real-time updates for various events within the Genie Business Connect system.

```APIDOC
## POST /webhooks

### Description
Creates a new webhook subscription to receive event notifications.

### Method
POST

### Endpoint
/webhooks

### Parameters
#### Query Parameters
None

#### Request Body
- **url** (string) - Required - The URL where the webhook events will be sent.
- **event_types** (array of strings) - Required - A list of event types to subscribe to (e.g., `["transaction.created", "transaction.updated"]`).

### Request Example
```json
{
  "url": "https://your-callback-url.com/webhook-handler",
  "event_types": ["transaction.created", "transaction.updated"]
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier for the created webhook.
- **url** (string) - The URL of the webhook.
- **event_types** (array of strings) - The subscribed event types.
- **created_at** (string) - The timestamp when the webhook was created.

#### Response Example
```json
{
  "id": "wh_abc123xyz789",
  "url": "https://your-callback-url.com/webhook-handler",
  "event_types": ["transaction.created", "transaction.updated"],
  "created_at": "2023-10-27T10:00:00Z"
}
```
```
Tokens:
Raw