### Perform GET Request with HttpClient

Source: https://developer.briqpay.com/docs/3.0.0/api/get-token

Example of executing a GET request to the token endpoint using C# HttpClient with Basic Authentication.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://playground-api.briqpay.com/v3/token/:tokenId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Module State Change Data Examples

Source: https://developer.briqpay.com/docs/3.0.0/sdk/sdk/update_events

Examples of data received for module state changes, indicating a locked payment module or a completed payment.

```json
{ "payment": "locked_by_merchant" }
```

```json
{ "payment": "completed" }
```

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

### Example Session Status Webhook Payload

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/quick_guides/signup_steps/completed_session

An example of the JSON payload received when a session is completed.

```APIDOC
## Webhook Payload Example

### Description
This is an example of the `session_status` webhook payload received when a signup session is completed.

### Response Example
```json
{
  "event": "session_status",
  "status": "completed",
  "sessionId": "61c16f84-b42e-4e1c-a114-a117a6e1e27d"
}
```
```

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

### Example Session Object

Source: https://developer.briqpay.com/docs/3.0.0/api/read-session

A comprehensive JSON representation of a Briqpay session, including product details, customer information, and webhook configurations.

```json
{
  "createdAt": "2023-04-12T13:16:08.647Z",
  "sessionId": "c5674f4f-7e84-405c-a44b-c83736bb7209",
  "status": "started",
  "product": {
    "type": "payment",
    "intent": "payment_one_time",
    "variantId": "a8a7acb2-4c65-4a91-a8e5-d8125bf64fd4"
  },
  "customerType": "business",
  "country": "SE",
  "locale": "sv-se",
  "urls": {
    "terms": "https://example.com/terms",
    "redirect": "https://example.com/redirect"
  },
  "references": {
    "reference1": "000",
    "orderId": "12345",
    "customerId": "54321"
  },
  "hooks": [
    {
      "eventType": "session_status",
      "statuses": [
        "completed"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "order_status",
      "statuses": [
        "order_pending",
        "order_rejected",
        "order_cancelled",
        "order_approved_not_captured"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "capture_status",
      "statuses": [
        "pending",
        "approved",
        "rejected"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "refund_status",
      "statuses": [
        "pending",
        "approved",
        "rejected"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    }
  ],
  "htmlSnippet": "<div><iframe/></div>",
  "clientToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "moduleStatus": {
    "company_lookup": {
      "uiStatus": "locked_by_merchant"
    },
    "billing": {
      "uiStatus": "locked_by_merchant"
    },
    "shipping": {
      "uiStatus": "locked_by_merchant"
    },
    "payment": {
      "uiStatus": "locked_by_merchant",
      "orderStatus": "order_pending",
      "refundStatus": "not_refunded"
    }
```

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

### Order Status Event Example

Source: https://developer.briqpay.com/docs/3.0.0/api/order-status

This JSON object represents an example of an order status event received from the BriqPay API. It includes details about the event type, status, session, and transaction information.

```json
{
  "event": "order_status",
  "status": "order_pending",
  "sessionId": "61c16f84-b42e-4e1c-a114-a117a6e1e27d",
  "transaction": {
    "createdAt": "2023-04-12T13:16:08.647Z",
    "expiresAt": "2023-04-12T13:16:08.647Z",
    "transactionId": "string",
    "reservationId": "string",
    "secondaryReservationId": "string",
    "pspId": "string",
    "pspDisplayName": "string",
    "pspIntegrationName": "string",
    "email": "string",
    "phoneNumber": "string",
    "reference": "string",
    "amountIncVat": 3000,
    "amountExVat": 2400,
    "currency": "SEK",
    "status": "pending",
    "captureStatus": "not_captured",
    "refundStatus": "not_refunded",
    "sessionId": "string",
    "cart": [
      {
        "productType": "physical",
        "name": "Test product",
        "reference": "testproduct1",
        "quantity": 2,
        "quantityUnit": "pc",
        "taxRate": 2500,
        "unitPrice": 1200,
        "unitPriceIncVat": 1500,
        "discountPercentage": 0,
        "unitDiscountAmountIncVat": 0,
        "totalAmount": 3000,
        "totalVatAmount": 600,
        "imageUrl": "https://example.com/logo.png"
      },
      {
        "productType": "sales_tax",
        "name": "Sales tax",
        "reference": "sales_tax",
        "totalTaxAmount": 1200
      },
      {
        "productType": "gift_card",
        "name": "Gift card",
        "reference": "gift_card",
        "giftCardAmount": 1200
      }
    ],
    "pspOrderManagementIds": {
      "cancel": {
        "apiTransactionId": "string"
      },
      "capture": {
        "apiTransactionId": "string"
      },
      "refund": {
        "apiTransactionId": "string"
      }
    }
  }
}
```

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

### Manually load and initialize the Briqpay SDK

Source: https://developer.briqpay.com/docs/3.0.0/sdk/sdk/initializing_sdk

Injects the Briqpay SDK script into the document head if not already present and executes setup logic upon loading.

```html
<script async>  
  function setupBriqpayExample() {  
    // Wait for Briqpay to have finished setting up two-way communication with the iframes  
    window._briqpay.v3.onReady(function () {  
      // Example, unlock a module immediately if all user data fulfills your criteria  
      const hasFullUserDataAndShipping = true // Replace with your function call to validate user data  
      if (hasFullUserDataAndShipping) {  
        window._briqpay.v3.unlockModule('payment')  
      }  
    })  
  }  
  
  // Get the script tag element handler, ensure it matches with the id attribute in the first script tag  
  const existingElement = document.getElementById('briqpay-sdk')  
  
  // If SDK is not found, inject it  
  if (!existingElement) {  
    const element = document.createElement('script')  
    element.setAttribute('src', 'https://api.briqpay.com/briq.min.js')  
    element.setAttribute('id', 'briqpay-sdk')  
    element.async = true  
    document.head.appendChild(element)  
    element.onload = setupBriqpayExample  
  } else {  
    setupBriqpayExample()  
  }  
</script>  
```

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

### Capture order payload example

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/quick_guides/payment_steps/capturing_orders

Example JSON payload for a capture request, including order totals and cart item details.

```json
{
  "data": {  
    "order": {  
      "amountIncVat": 3000,  
      "amountExVat": 2400,  
      "currency": "SEK",  
      "cart": [  
        {  
          "productType": "physical",  
          "reference": "testproduct1",  
          "name": "Test product",  
          "quantity": 2,  
          "quantityUnit": "pc",  
          "unitPrice": 1200,  
          "taxRate": 2500,  
          "discountPercentage": 0,  
          "unitDiscountAmountIncVat": 0  
        }  
      ]  
    }  
  }  
}
```

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

### Make Decision Request (C#)

Source: https://developer.briqpay.com/docs/3.0.0/api/make-decision

Example implementation of the decision endpoint using HttpClient in C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://playground-api.briqpay.com/v3/session/:sessionId/decision");
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");
var content = new StringContent("{\n  \"decision\": \"allow\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Example Session Object

Source: https://developer.briqpay.com/docs/3.0.0/api/update-metadata

A comprehensive JSON representation of a Briqpay session, including product details, customer information, webhook hooks, and module statuses.

```json
{
  "createdAt": "2023-04-12T13:16:08.647Z",
  "sessionId": "c5674f4f-7e84-405c-a44b-c83736bb7209",
  "status": "started",
  "product": {
    "type": "payment",
    "intent": "payment_one_time",
    "variantId": "a8a7acb2-4c65-4a91-a8e5-d8125bf64fd4"
  },
  "customerType": "business",
  "country": "SE",
  "locale": "sv-se",
  "urls": {
    "terms": "https://example.com/terms",
    "redirect": "https://example.com/redirect"
  },
  "references": {
    "reference1": "000",
    "orderId": "12345",
    "customerId": "54321"
  },
  "hooks": [
    {
      "eventType": "session_status",
      "statuses": [
        "completed"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "order_status",
      "statuses": [
        "order_pending",
        "order_rejected",
        "order_cancelled",
        "order_approved_not_captured"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "capture_status",
      "statuses": [
        "pending",
        "approved",
        "rejected"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    },
    {
      "eventType": "refund_status",
      "statuses": [
        "pending",
        "approved",
        "rejected"
      ],
      "method": "POST",
      "url": "https://example.com/notifications"
    }
  ],
  "htmlSnippet": "<div><iframe/></div>",
  "clientToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "moduleStatus": {
    "company_lookup": {
      "uiStatus": "locked_by_merchant"
    },
    "billing": {
      "uiStatus": "locked_by_merchant"
    },
    "shipping": {
      "uiStatus": "locked_by_merchant"
    },
    "payment": {
      "uiStatus": "locked_by_merchant",
      "orderStatus": "order_pending",
      "refundStatus": "not_refunded"
    }
  }
}
```

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

### Example Cart with Sales Tax

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/additional_guides/orderLines

Demonstrates a cart containing a physical product without tax and a separate sales_tax line item.

```json
"cart": [  
  {  
    "productType": "physical",  
    "reference": "shirt123",  
    "name": "T-shirt",  
    "quantity": 1,  
    "unitPrice": 2000,  
    "taxRate": 0,  
    "discountPercentage": 0,  
    "unitDiscountAmountIncVat": 0  
  },  
  {  
    "productType": "sales_tax",  
    "name": "Sales tax",  
    "reference": "sales_tax",  
    "totalTaxAmount": 160  
  }  
]  
```

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

### Basic Authentication HTTP Request in C#

Source: https://developer.briqpay.com/docs/3.0.0/api/deactivate-token

Example of making a DELETE request to the BriqPay API using HttpClient in C#. Ensure correct authorization headers are set.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://playground-api.briqpay.com/v3/token/:tokenId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Retrieve Session Data with HttpClient

Source: https://developer.briqpay.com/docs/3.0.0/api/read-session

C# implementation using HttpClient to perform a GET request with Basic Authentication headers.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://playground-api.briqpay.com/v3/session/:sessionId");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Release Remaining Order Amount with C#

Source: https://developer.briqpay.com/docs/3.0.0/api/release-remaining-order-amount

Example using HttpClient to perform a POST request to release the remaining order amount.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://playground-api.briqpay.com/v3/session/:sessionId/order/release-remaining");
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Update Order Cart in C#

Source: https://developer.briqpay.com/docs/3.0.0/api/update-cart

Example of updating an order cart using HttpClient in C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://playground-api.briqpay.com/v3/session/:sessionId/order/update/cart");
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");
var content = new StringContent("{\n  \"data\": {\n    \"order\": {\n      \"amountIncVat\": 3000,\n      \"amountExVat\": 2400,\n      \"currency\": \"SEK\",\n      \"cart\": [\n        {\n          \"productType\": \"physical\",\n          \"name\": \"Test product\",\n          \"reference\": \"testproduct1\",\n          \"quantity\": 2,\n          \"quantityUnit\": \"pc\",\n          \"taxRate\": 2500,\n          \"unitPrice\": 1200,\n          \"unitPriceIncVat\": 1500,\n          \"discountPercentage\": 0,\n          \"unitDiscountAmountIncVat\": 0,\n          \"totalAmount\": 3000,\n          \"totalVatAmount\": 600,\n          \"imageUrl\": \"https://example.com/logo.png\"\n        },\n        {\n          \"productType\": \"sales_tax\",\n          \"name\": \"Sales tax\",\n          \"reference\": \"sales_tax\",\n          \"totalTaxAmount\": 1200\n        },\n        {\n          \"productType\": \"gift_card\",\n          \"name\": \"Gift card\",\n          \"reference\": \"gift_card\",\n          \"giftCardAmount\": 1200\n        }\n      ]\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Briqpay API Response Schema and Example

Source: https://developer.briqpay.com/docs/3.0.0/api/get-token

This section details the structure of successful responses from the Briqpay API, including all possible fields and their types, along with a sample JSON payload.

```APIDOC
## GET /websites/developer_briqpay

### Description
This endpoint returns detailed information about a Briqpay session, including payment details, customer information, and associated orders.

### Method
GET

### Endpoint
/websites/developer_briqpay

### Parameters
#### Query Parameters
- **tokenId** (string) - Required - The unique token identifying the session.

### Response
#### Success Response (200)
- **tokenId** (string) - The unique identifier for the token.
- **initialSessionId** (string) - The ID of the initial session.
- **state** (string) - The current state of the session. Possible values: [`active`, `inactive`].
- **country** (string) - The country code in ISO 3166-1 alpha-2 format.
- **locale** (string) - The locale in "sv-se" / "en-gb" format.
- **product** (object) - Information about the Briqpay product.
  - **type** (string) - The type of Briqpay product. Possible values: [`payment`, `signup`].
  - **id** (string) - Deprecated. Use `variantId` instead.
  - **variantId** (string) - The ID of the product variant configuration.
- **customerType** (string) - The type of customer. Possible values: [`business`, `consumer`].
- **expiryDate** (string) - The expiration date of the session.
- **createdAt** (string) - The timestamp when the session was created.
- **paymentMethod** (object) - Details about the selected payment method.
  - **pspId** (string) - The payment service provider ID.
  - **name** (string) - The name of the payment method.
  - **category** (string) - The category of the payment method.
  - **pspDisplayName** (string) - The display name of the payment service provider.
- **chargeSessions** (array) - A list of charge sessions associated with this session.
  - **sessionId** (string) - The ID of the charge session.
  - **completedAt** (string) - The timestamp when the charge session was completed.
  - **order** (object) - Details of the order associated with the charge session.
    - **amountIncVat** (integer) - The total amount including VAT.
    - **amountExVat** (integer) - The total amount excluding VAT.
    - **currency** (string) - The currency of the order.
- **data** (object) - Contains company, consumer, billing, and shipping information.
  - **company** (object) - Company details (for B2B).
    - **cin** (string) - Company identification number.
    - **name** (string) - The name of the company.
  - **consumer** (object) - Consumer details (for B2C).
    - **dateOfBirth** (string) - The date of birth in YYYY-MM-DD format.
    - **name** (string) - The name of the consumer.
  - **billing** (object) - Billing address information.
    - **companyName** (string) - Company name (B2B only).
    - **cin** (string) - Company identification number.
    - **streetAddress** (string) - The street address.
    - **streetAddress2** (string) - Additional street address information.
    - **zip** (string) - The postal code.
    - **city** (string) - The city.
    - **region** (string) - The state or region.
    - **firstName** (string) - The first name.
    - **lastName** (string) - The last name.
    - **email** (string) - The email address.
    - **phoneNumber** (string) - The phone number.
    - **country** (string) - The country code in ISO 3166-1 alpha-2 format.
  - **shipping** (object) - Shipping address information.
    - **companyName** (string) - Company name (B2B only).
    - **cin** (string) - Company identification number.
    - **streetAddress** (string) - The street address.
    - **streetAddress2** (string) - Additional street address information.
    - **zip** (string) - The postal code.
    - **city** (string) - The city.
    - **region** (string) - The state or region.
    - **firstName** (string) - The first name.
    - **lastName** (string) - The last name.
    - **email** (string) - The email address.
    - **phoneNumber** (string) - The phone number.
    - **country** (string) - The country code in ISO 3166-1 alpha-2 format.

#### Response Example
```json
{
  "tokenId": "string",
  "initialSessionId": "string",
  "state": "active",
  "country": "SE",
  "locale": "sv-se",
  "product": {
    "type": "payment",
    "variantId": "a8a7acb2-4c65-4a91-a8e5-d8125bf64fd4"
  },
  "customerType": "business",
  "expiryDate": "string",
  "createdAt": "string",
  "paymentMethod": {
    "pspId": "string",
    "name": "string",
    "category": "string",
    "pspDisplayName": "string"
  },
  "chargeSessions": [
    {
      "sessionId": "string",
      "completedAt": "string",
      "order": {
        "amountIncVat": 0,
        "amountExVat": 0,
        "currency": "string"
      }
    }
  ],
  "data": {
    "company": {
      "cin": "0123456789",
      "name": "Example Company"
    },
    "consumer": {
      "dateOfBirth": "1970-01-01",
      "name": "John Smith"
    },
    "billing": {
      "companyName": "string",
      "cin": "0123456789",
      "streetAddress": "string",
      "streetAddress2": "string",
      "zip": "string",
      "city": "string",
      "region": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "country": "SE"
    },
    "shipping": {
      "companyName": "string",
      "cin": "0123456789",
      "streetAddress": "string",
      "streetAddress2": "string",
      "zip": "string",
      "city": "string",
      "region": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "country": "SE"
    }
  }
}
```
```

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

### Invalid Data Error Response Example

Source: https://developer.briqpay.com/docs/3.0.0/api/generate-a-secret

This is an example of an error response when the provided data is invalid.

```json
{
  "error": {
    "code": "INVALID_DATA",
    "message": "string"
  }
}
```

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

### API Secret Response Example

Source: https://developer.briqpay.com/docs/3.0.0/api/generate-a-secret

This is an example of a successful response when generating an API secret. It includes the generated secret and its expiration time.

```json
{
  "secret": "string",
  "expiresAt": "2023-04-12T13:16:08.647Z"
}
```

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

### Create Signup Session Request Body

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/quick_guides/signup_steps/create_signup_session

Provide product type, customer type, country, locale, redirect URL, and webhook configurations for the signup session.

```json
{
  "product": {
    "type": "signup",
    "intent": "signup"
  },
  "customerType": "business",
  "country": "SE",
  "locale": "sv-se",
  "urls": {
    "redirect": "https://example.com/redirect"
  },
  "hooks": [
    {
      "eventType": "session_status",
      "statuses": ["completed"],
      "method": "POST",
      "url": "https://example.com/notifications"
    }
  ]
}
```

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

### Create Payment Session with HttpClient

Source: https://developer.briqpay.com/docs/3.0.0/api/create-session

Initializes a POST request to the Briqpay session endpoint using C# HttpClient with Basic authentication headers.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://playground-api.briqpay.com/v3/session");  
request.Headers.Add("Accept", "application/json");  
request.Headers.Add("Authorization", "Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+");  
var content = new StringContent("{\n  \"product\": {\n    \"type\": \"payment\",\n    \"intent\": \"payment_one_time\",\n    \"variantId\": \"a8a7acb2-4c65-4a91-a8e5-d8125bf64fd4\"\n  },\n  \"customerType\": \"business\",\n  \"country\": \"SE\",\n  \"locale\": \"sv-se\",\n  \"urls\": {\n    \"terms\": \"https://example.com/terms\",\n    \"redirect\": \"https://example.com/redirect\"\n  },\n  \"references\": {\n    \"reference1\": \"000\",\n    \"orderId\": \"12345\",\n    \"customerId\": \"54321\"\n  },\n  \"hooks\": [\n    {\n      \"eventType\": \"session_status\",\n      \"statuses\": [\n        \"completed\"\n      ],\n      \"method\": \"POST\",\n      \"url\": \"https://example.com/notifications\"\n    },\n    {\n      \"eventType\": \"order_status\",\n      \"statuses\": [\n        \"order_pending\",\n        \"order_rejected\",\n        \"order_cancelled\",\n        \"order_approved_not_captured\"\n      ],\n      \"method\": \"POST\",\n      \"url\": \"https://example.com/notifications\"\n    },\n    {\n      \"eventType\": \"capture_status\",\n      \"statuses\": [\n        \"pending\",\n        \"approved\",\n        \"rejected\"\n      ],\n      \"method\": \"POST\",\n      \"url\": \"https://example.com/notifications\"\n    },\n    {\n      \"eventType\": \"refund_status\",\n      \"statuses\": [\n        \"pending\",\n        \"approved\",\n        \"rejected\"\n      ],\n      \"method\": \"POST\",\n      \"url\": \"https://example.com/notifications\"\n    }\n  ],\n  \"config\": {\n    \"disableInsightsTracking\": false,\n    \"disableSessionCompleteRedirect\": false,\n    \"realTimeProcessing\": false\n  },\n  \"data\": {\n    \"order\": {\n      \"currency\": \"SEK\",\n      \"amountIncVat\": 3000,\n      \"amountExVat\": 2400,\n      \"cart\": [\n        {\n          \"productType\": \"physical\",\n          \"name\": \"Test product\",\n          \"reference\": \"testproduct1\",\n          \"quantity\": 2,\n          \"quantityUnit\": \"pc\",\n          \"taxRate\": 2500,\n          \"unitPrice\": 1200,\n          \"unitPriceIncVat\": 1500,\n          \"discountPercentage\": 0,\n          \"unitDiscountAmountIncVat\": 0,\n          \"totalAmount\": 3000,\n          \"totalVatAmount\": 600,\n          \"imageUrl\": \"https://example.com/logo.png\"\n        },\n        {\n          \"productType\": \"sales_tax\",\n          \"name\": \"Sales tax\",\n          \"reference\": \"sales_tax\",\n          \"totalTaxAmount\": 1200\n        },\n        {\n          \"productType\": \"gift_card\",\n          \"name\": \"Gift card\",\n          \"reference\": \"gift_card\",\n          \"giftCardAmount\": 1200\n        }\n      ]\n    },\n    \"company\": {\n      \"cin\": \"0123456789\",\n      \"name\": \"string\"\n    },\n    \"consumer\": {\n      \"identificationNumber\": \"197001011234\",\n      \"dateOfBirth\": \"1970-01-01\",\n      \"name\": \"John Smith\"\n    },\n    \"billing\": {\n      \"streetAddress\": \"string\",\n      \"streetAddress2\": \"string\",\n      \"zip\": \"string\",\n      \"city\": \"string\",\n      \"region\": \"string\",\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"email\": \"string\",\n      \"phoneNumber\": \"string\",\n      \"country\": \"SE\"\n    },\n    \"shipping\": {\n      \"streetAddress\": \"string\",\n      \"streetAddress2\": \"string\",\n      \"zip\": \"string\",\n      \"city\": \"string\",\n      \"region\": \"string\",\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"email\": \"string\",\n      \"phoneNumber\": \"string\",\n      \"country\": \"SE\"\n    },\n    \"tokenization\": {\n      \"tokenId\": \"string\"\n    },\n    \"billingAddresses\": [\n      {\n        \"companyName\": \"Test company\",\n        \"streetAddress\": \"Test street 1\",\n        \"streetAddress2\": \"Test street 2\",\n        \"zip\": \"12312\",\n        \"city\": \"Test city\",\n        \"region\": \"\",\n        \"firstName\": \"Tester\",\n        \"lastName\": \"Testsson\",\n        \"email\": \"test@test.com\",\n        \"phoneNumber\": \"0123456789\",\n        \"country\": \"SE\"\n      }\n    ],\n    \"shippingAddresses\": [\n      {\n        \"companyName\": \"Test company\",\n        \"streetAddress\": \"Test street 1\",\n        \"streetAddress2\": \"Test street 2\",\n        \"zip\": \"12312\",\n        \"city\": \"Test city\
```

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

### Session Status Webhook Payload Example

Source: https://developer.briqpay.com/docs/3.0.0/api/session-status

This is an example of the JSON payload received when a session's status changes to 'completed'. Ensure your server returns a 2xx status code to acknowledge receipt.

```json
{
  "event": "session_status",
  "status": "completed",
  "sessionId": "61c16f84-b42e-4e1c-a114-a117a6e1e27d"
}
```

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

### POST /v3/session - Create Signup Session

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/quick_guides/signup_steps/create_signup_session

Initiates a signup session by making a POST request to the Briqpay API. This endpoint requires specific details about the customer and desired session configuration.

```APIDOC
## POST /v3/session

### Description
Creates a new signup session. This is typically performed by your backend.

### Method
POST

### Endpoint
`https://playground-api.briqpay.com/v3/session`

### Headers / Authentication
The format of the Authentication header is `Basic <base64(username:secret)>`.

```json
{
  "Content-Type": "application/json",
  "Accept": "application/json",
  "Authorization": "Basic <base64(username:secret)>"
}
```

### Request Body

```json
{
  "product": {
    "type": "signup",
    "intent": "signup"
  },
  "customerType": "business",
  "country": "SE",
  "locale": "sv-se",
  "urls": {
    "redirect": "https://example.com/redirect"
  },
  "hooks": [
    {
      "eventType": "session_status",
      "statuses": ["completed"],
      "method": "POST",
      "url": "https://example.com/notifications"
    }
  ]
}
```

### Request Example
```json
{
  "product": {
    "type": "signup",
    "intent": "signup"
  },
  "customerType": "business",
  "country": "SE",
  "locale": "sv-se",
  "urls": {
    "redirect": "https://example.com/redirect"
  },
  "hooks": [
    {
      "eventType": "session_status",
      "statuses": ["completed"],
      "method": "POST",
      "url": "https://example.com/notifications"
    }
  ]
}
```

### Response
#### Success Response (200)
- **sessionId** (string) - The unique identifier for the created session.
- **sessionUrl** (string) - The URL to redirect the user to complete the signup process.

#### Response Example
```json
{
  "sessionId": "sess_abc123xyz789",
  "sessionUrl": "https://signup.briqpay.com/sess_abc123xyz789"
}
```
```

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

### GET /v3/session/:sessionId

Source: https://developer.briqpay.com/docs/3.0.0/api/read-session

Retrieves details for a specific session by its ID.

```APIDOC
## GET /v3/session/:sessionId

### Description
Retrieves the details of a specific session using the provided session ID.

### Method
GET

### Endpoint
https://playground-api.briqpay.com/v3/session/:sessionId

### Parameters
#### Path Parameters
- **sessionId** (string) - Required - The unique identifier of the session.

#### Query Parameters
- **fields** (string) - Optional - Specifies which fields to return in the response.

### Request Example
```
GET /v3/session/12345?fields=status HTTP/1.1
Host: playground-api.briqpay.com
Accept: application/json
Authorization: Basic <credentials>
```

### Response
#### Success Response (200)
- **session** (object) - The session object containing requested details.
```

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

### Upsell Module Configuration

Source: https://developer.briqpay.com/docs/3.0.0/api/create-session

Configure custom inputs and display settings for the Upsell module.

```APIDOC
## Upsell Module Configuration

### Description
Configure which inputs will be collected in the Upsell module, along with display settings.

### Method
Not applicable (Configuration object)

### Endpoint
Not applicable (Configuration object)

### Parameters
#### Request Body
- **customInputs** (object[]) - Optional - Inputs that will be collected in the Upsell module.
  - **type** (string) - Required - Possible values: [`string`, `boolean`, `object`]
    - Example: `string`
  - **key** (string) - Required - The input key, must be unique between all inputs.
    - Example: `customReference`
  - **label** (string) - Required - The label to be presented in relation to the input.
    - Example: `reference`
  - **minLength** (number) - Optional - Minimum length for string inputs.
    - Example: `4`
  - **maxLength** (number) - Optional - Maximum length for string inputs.
    - Example: `16`
  - **required** (boolean) - Optional - Whether the input is required. Default: `false`
    - Example: `true`
  - **span** (number) - Optional - Control if the input field should span over 1 or 2 columns. Possible values: [`1`, `2`]
    - Example: `1`
  - **enum** (string[]) - Optional - Configure available values when using a "enumRadio" or "enumDropdown" component.
    - Example: `[]`
  - **component** (string) - Optional - The UI component to use for the input. Possible values: [`textField`, `textArea`, `checkbox`, `enumRadio`, `enumDropdown`]
    - Example: `textField`
- **hideModule** (boolean) - Optional - Whether to hide the entire Upsell module.
- **header** (string) - Optional - Module header text. Possible values: `<= 64 characters`
- **subheader** (string) - Optional - Module sub-header text. Possible values: `<= 512 characters`
- **footer** (string) - Optional - Module footer text. Possible values: `<= 512 characters`
```

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

### Get token

Source: https://developer.briqpay.com/docs/3.0.0/api/tokenized-payment-methods

Retrieves details of a specific tokenized payment method.

```APIDOC
## GET /tokens/{token_id}

### Description
Get a tokenized payment method.

### Method
GET

### Endpoint
/tokens/{token_id}
```

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

### Decision Request Body Example

Source: https://developer.briqpay.com/docs/3.0.0/api/make-decision

JSON body structure for an allow decision.

```json
{
  "decision": "allow"
}
```

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

### GET /v3/token/:tokenId

Source: https://developer.briqpay.com/docs/3.0.0/api/get-token

Retrieves a specific token by its ID. Requires Basic Authentication.

```APIDOC
## GET /v3/token/:tokenId

### Description
Retrieves a specific token by its ID. This endpoint requires Basic Authentication.

### Method
GET

### Endpoint
https://playground-api.briqpay.com/v3/token/:tokenId

### Parameters
#### Path Parameters
- **tokenId** (string) - Required - The ID of the token to retrieve.

#### Header Parameters
- **Accept** (string) - Optional - Specifies the desired response format, defaults to `application/json`.
- **Authorization** (string) - Required - Contains the Basic Authentication credentials.

### Request Example
```http
GET /v3/token/your_token_id HTTP/1.1
Host: playground-api.briqpay.com
Authorization: Basic <base64_encoded_username:password>
Accept: application/json
```

### Response
#### Success Response (200)
- **token_data** (object) - Contains the details of the requested token.
  - **id** (string) - The unique identifier of the token.
  - **createdAt** (string) - The timestamp when the token was created.
  - **expiresAt** (string) - The timestamp when the token will expire.

#### Response Example
```json
{
  "token_data": {
    "id": "tok_abc123xyz",
    "createdAt": "2023-10-27T10:00:00Z",
    "expiresAt": "2023-11-27T10:00:00Z"
  }
}
```

#### Error Response (401, 400, 500)
- **error** (object) - Contains error details.
  - **code** (string) - An error code (e.g., `INVALID_CREDENTIALS`, `INVALID_DATA`, `UNKNOWN`).
  - **message** (string) - A human-readable error message.

#### Error Response Example
```json
{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "Authentication failed. Please check your credentials."
  }
}
```
```

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

### Execute API Request in C#

Source: https://developer.briqpay.com/docs/3.0.0/api/create-session

Demonstrates how to send a JSON payload to the Briqpay API using an asynchronous HTTP client request.

```csharp
",
        "region": "",
        "firstName": "Tester",
        "lastName": "Testsson",
        "email": "test@test.com",
        "phoneNumber": "0123456789",
        "country": "SE"
      }
    ]
  },
  "modules": {
    "loadModules": [
      "payment"
    ],
    "config": {
      "company_lookup": {
        "companyPrefillLock": "none"
      },
      "billing": {
        "lockFields": {
          "city": "soft_lock"
        }
      },
      "shipping": {
        "lockFields": {
          "city": "soft_lock"
        }
      },
      "payment": {
        "decision": {
          "enabled": false
        },
        "pspRulesOverride": {
          "psp": [
            {
              "pspId": "ee5bf226-856c-4ecb-8091-3393b88f8ac6",
              "handles": {
                "enabled": false,
                "locked": false,
                "strongAuth": false
              },
              "config": {
                "lockedMessage": "string",
                "strongAuthMessage": "string"
              },
              "otherHandles": "run_rules"
            }
          ],
          "otherPsps": "disable"
        }
      },
      "signup": {
        "decision": {
          "enabled": false
        }
      },
      "order_note": {
        "customInputs": [
          {
            "type": "string",
            "key": "customReference",
            "label": "reference",
            "minLength": 4,
            "maxLength": 16,
            "required": true,
            "span": 1,
            "enum": [],
            "component": "textField"
          }
        ],
        "hideModule": true
      },
      "terms": {
        "checkboxes": [
          {
            "key": "newsletter",
            "label": "Yes",
            "required": true,
            "default": true
          }
        ]
      },
      "upsell": {
        "customInputs": [
          {
            "key": "montering",
            "type": "boolean",
            "label": "Ja tack, jag vill beställa montering - 249 SEK",
            "span": 2,
            "component": "checkbox"
          }
        ],
        "hideModule": true,
        "header": "string",
        "subheader": "string",
        "footer": "string"
      }
    }
  }
}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### GET /v3/token/:tokenId

Source: https://developer.briqpay.com/docs/3.0.0/api/get-token

Retrieves a tokenized payment method using the provided tokenId.

```APIDOC
## GET https://playground-api.briqpay.com/v3/token/:tokenId

### Description
Get a tokenized payment method.

### Method
GET

### Endpoint
https://playground-api.briqpay.com/v3/token/:tokenId

### Parameters
#### Path Parameters
- **tokenId** (string) - Required - The tokenId retrieved from data.tokenization.tokenId on a completed session with intent: "payment_tokenize" or "payment_tokenize_and_charge". Example: c5674f4f-7e84-405c-a44b-c83736bb7209

#### Header Parameters
- **Accept** (string) - Optional - Possible values: [application/json]
- **Authorization** (string) - Required - Format: "Basic <base64(username:secret)>"
```

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

### Example error response

Source: https://developer.briqpay.com/docs/3.0.0/guides/guides/quick_guides/payment_steps/release_remaining

The JSON structure returned when an operation is not supported for the current order status.

```json
{
  "error": {
    "code": "OPERATION_NOT_SUPPORTED",
    "message": "Cannot release remaining as order is not in captured_partial status"
  }
}
```

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

### Create Briqpay Session

Source: https://developer.briqpay.com/docs/3.0.0/api/create-session

Defines the structure for initializing a new Briqpay session, including product type, customer details, and webhook configurations.

```APIDOC
## POST /sessions

### Description
Initializes a new Briqpay session for payment or signup flows.

### Method
POST

### Request Body
- **product** (object) - Required - Configuration for the Briqpay product.
  - **type** (string) - Required - Type of product: `payment`, `signup`.
  - **intent** (string) - Required - Session intent: `payment_one_time`, `payment_tokenize`, `payment_tokenize_and_charge`, `payment_charge_token`, `signup`.
  - **variantId** (string) - Optional - Alternate variant configuration ID.
- **customerType** (string) - Required - `business` or `consumer`.
- **country** (string) - Required - ISO 3166-1 alpha-2 country code.
- **locale** (string) - Required - Locale format (e.g., `sv-se`).
- **urls** (object) - Required - Redirect and terms URLs.
  - **terms** (string) - Required (if product.type is 'payment') - URL to terms & conditions.
  - **redirect** (string) - Required - URL to redirect after session completion.
- **references** (object) - Optional - Custom reference fields.
- **hooks** (array) - Optional - Webhook subscriptions for events like `session_status`, `order_status`, `capture_status`, `refund_status`.
- **config** (object) - Optional - Session configuration (e.g., `disableInsightsTracking`, `realTimeProcessing`).
- **data** (object) - Optional - Billing details and cart items.
  - **order** (object) - Required - Order details including `currency`, `amountIncVat`, `amountExVat`, and `cart` items.
```